VR-Forces 4.0.4 Class Documentation
Public Member Functions
DtTargetAcquireCriteria Class Reference

DtTargetAcquireCriteria--Criteria for acquiring a target. More...

Inheritance diagram for DtTargetAcquireCriteria:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtTargetAcquireCriteria (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 constructor
 DtTargetAcquireCriteria (const DtTargetAcquireCriteria &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
DtTargetAcquireCriteriaoperator= (const DtTargetAcquireCriteria &orig)
 assignment
virtual ~DtTargetAcquireCriteria ()
 destructor
virtual void setEntityType (const DtEntityType &entityType)
 Accessor/mutator for myEntityType.
virtual const DtRwEntityTypeentityType () const
 Accessor/mutator for myEntityType.
virtual bool checkSpeed () const
 Accessor/mutator for myCheckSpeed.
virtual void setCheckSpeed (bool checkSpeed)
 Accessor/mutator for myCheckSpeed.
virtual bool checkAngleToTarget () const
 Accessor/mutator for myCheckAngleToTarget.
virtual void setCheckAngleToTarget (bool checkAngle)
 Accessor/mutator for myCheckAngleToTarget.
virtual bool checkElevation () const
 Accessor/mutator for myCheckElevation.
virtual void setCheckElevation (bool checkElev)
 Accessor/mutator for myCheckElevation.
virtual double timeToAcquire () const
 Accessor/mutator for myTimeToAcquireTarget.
virtual void setTimeToAcquire (double time)
 Accessor/mutator for myTimeToAcquireTarget.
virtual double maxTargetSpeedToAcquire () const
 Accessor/mutator for myMaxTargetSpeedToAcquire.
virtual void setMaxTargetSpeedToAcquire (double speed)
 Accessor/mutator for myMaxTargetSpeedToAcquire.
virtual double maxElevAngleToAcquire () const
 Accessor/mutator for myMaxElevAngleToAcuire.
virtual void setMaxElevAngleToAcquire (double angle)
 Accessor/mutator for myMaxElevAngleToAcuire.
virtual double maxElevToAcquire () const
 Accessor/mutator for myMaxElevationToAcquire.
virtual void setMaxElevToAcquire (double elev)
 Accessor/mutator for myMaxElevationToAcquire.

Protected Attributes

parameters

These parameters are available for setting in the OPD files.

DtRwEntityType myEntityType
 Parameter Name: entity-type
Parameter Description: DIS/RPR enumerated entity type associated with priority value.
DtRwReal myTimeToAcquireTarget
 Parameter Name: time-to-acquire
Parameter Description: Specifies the time needed to acquire the target.
DtRwBoolean myCheckSpeed
 Parameter Name: check-maximum-speed-to-acquire
Parameter Description: Specifies whether this entity's ability to acquire the target is constrained by the target's speed.
DtRwReal myMaxTargetSpeedToAcquire
 Parameter Name: max-speed-of-target
Parameter Description: Maximum speed the target can be moving at and still be acquired
Parameter Default Value: 10.0
Parameter Units: Meters/second.
DtRwBoolean myCheckAngleToTarget
 Parameter Name: check-elevation-angle-to-acquire
Parameter Description: Specifies whether this entity is restrained by the angle between it and it's target in the Z-plane, i.e trying to acquire air targets or if the entity is on the top of a building and trying to acquire targets directly below it.
DtRwReal myMaxElevAngleToAcuire
 Parameter Name: max-elevation-angle-to-acquire
Parameter Description: Maximum angle between where the entity is and where the target is in the Z-plane.
DtRwBoolean myCheckElevation
 Parameter Name: check-elevation-to-acquire
Parameter Description: Specifies whether this entity is restrained by elevation in it's abilities to acquire the target.
DtRwReal myMaxElevationToAcquire
 Parameter Name: max-elevation-to-acquire
Parameter Description: The maxium elevation of the target relative to the entity in which the entity can still acquire the target and have a reasonable chance of hitting it.

Detailed Description

DtTargetAcquireCriteria--Criteria for acquiring a target.

Defines a criteria for acquiring targets for a single weapon system. This class stores all the information about the criteria needed for a target to be acquired by the weapon system.


Constructor & Destructor Documentation

constructor

copy constructor

destructor


Member Function Documentation

DtTargetAcquireCriteria& DtTargetAcquireCriteria::operator= ( const DtTargetAcquireCriteria orig)

assignment

virtual void DtTargetAcquireCriteria::setEntityType ( const DtEntityType &  entityType) [virtual]

Accessor/mutator for myEntityType.

virtual const DtRwEntityType& DtTargetAcquireCriteria::entityType ( ) const [virtual]

Accessor/mutator for myEntityType.

virtual bool DtTargetAcquireCriteria::checkSpeed ( ) const [virtual]

Accessor/mutator for myCheckSpeed.

virtual void DtTargetAcquireCriteria::setCheckSpeed ( bool  checkSpeed) [virtual]

Accessor/mutator for myCheckSpeed.

Accessor/mutator for myCheckAngleToTarget.

virtual void DtTargetAcquireCriteria::setCheckAngleToTarget ( bool  checkAngle) [virtual]

Accessor/mutator for myCheckAngleToTarget.

virtual bool DtTargetAcquireCriteria::checkElevation ( ) const [virtual]

Accessor/mutator for myCheckElevation.

virtual void DtTargetAcquireCriteria::setCheckElevation ( bool  checkElev) [virtual]

Accessor/mutator for myCheckElevation.

virtual double DtTargetAcquireCriteria::timeToAcquire ( ) const [virtual]

Accessor/mutator for myTimeToAcquireTarget.

virtual void DtTargetAcquireCriteria::setTimeToAcquire ( double  time) [virtual]

Accessor/mutator for myTimeToAcquireTarget.

virtual double DtTargetAcquireCriteria::maxTargetSpeedToAcquire ( ) const [virtual]

Accessor/mutator for myMaxTargetSpeedToAcquire.

virtual void DtTargetAcquireCriteria::setMaxTargetSpeedToAcquire ( double  speed) [virtual]

Accessor/mutator for myMaxTargetSpeedToAcquire.

virtual double DtTargetAcquireCriteria::maxElevAngleToAcquire ( ) const [virtual]

Accessor/mutator for myMaxElevAngleToAcuire.

virtual void DtTargetAcquireCriteria::setMaxElevAngleToAcquire ( double  angle) [virtual]

Accessor/mutator for myMaxElevAngleToAcuire.

virtual double DtTargetAcquireCriteria::maxElevToAcquire ( ) const [virtual]

Accessor/mutator for myMaxElevationToAcquire.

virtual void DtTargetAcquireCriteria::setMaxElevToAcquire ( double  elev) [virtual]

Accessor/mutator for myMaxElevationToAcquire.


Member Data Documentation

Parameter Name: entity-type
Parameter Description: DIS/RPR enumerated entity type associated with priority value.


Parameter Default Value:

Parameter Name: time-to-acquire
Parameter Description: Specifies the time needed to acquire the target.

Some weapons like launchers need some time to acquire the target before they can fire.
Parameter Default Value: 0.0
Parameter Units: Seconds

Parameter Name: check-maximum-speed-to-acquire
Parameter Description: Specifies whether this entity's ability to acquire the target is constrained by the target's speed.

Acquiring a target that is moving at its top speed is much more difficult that if the target is stationary. Set to false if there is no need to check.
Parameter Default Value: True

Parameter Name: max-speed-of-target
Parameter Description: Maximum speed the target can be moving at and still be acquired
Parameter Default Value: 10.0
Parameter Units: Meters/second.

Parameter Name: check-elevation-angle-to-acquire
Parameter Description: Specifies whether this entity is restrained by the angle between it and it's target in the Z-plane, i.e trying to acquire air targets or if the entity is on the top of a building and trying to acquire targets directly below it.

Set to false if there is no need to check.
Parameter Default Value: False

Parameter Name: max-elevation-angle-to-acquire
Parameter Description: Maximum angle between where the entity is and where the target is in the Z-plane.

For example a DI with some kind of launcher would not be able to shoot anything that is directly above his head.
Parameter Default Value: 1.5 --Directly overhead
Parameter Units: Radians

Parameter Name: check-elevation-to-acquire
Parameter Description: Specifies whether this entity is restrained by elevation in it's abilities to acquire the target.

Set to false if there is no need to check.
Parameter Default Value: False

Parameter Name: max-elevation-to-acquire
Parameter Description: The maxium elevation of the target relative to the entity in which the entity can still acquire the target and have a reasonable chance of hitting it.


Parameter Default Value: set to maxium range of weapon we are acquiring for.
Parameter Units: meters


The documentation for this class was generated from the following file:

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)