DtMissileParameters Class Reference

Contains the set of readable/writeable parameters assoicated with an missile type of entity. More...

Inheritance diagram for DtMissileParameters:

List of all members.

Public Member Functions
	DtMissileParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor with parameters to set up read/writability correctly
const DtMissileParameters &	operator= (const DtMissileParameters &orig)
virtual	~DtMissileParameters ()
	destructor
virtual DtVrfObjectParameters *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
virtual DtVrfObjectParameters *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry) const
virtual bool	inheritValues (const DtVrfObjectParameters *benefactor)
	Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy. (
virtual DtString	type () const
	Should return the type of entity this is a parameter block for.
virtual void	inheritValuesFromThisType (const DtMissileParameters *benefactor)
virtual DtReal	range () const
	Accessor/mutator for myRange.
virtual void	setRange (const DtReal range)
	Accessor/mutator for myRange.
virtual DtReal	maxManeuverGs () const
	Accessor/mutator for myMaxManeuverGs.
virtual void	setMaxManeuverGs (const DtReal maxAcceleration)
	Accessor/mutator for myMaxManeuverGs.
virtual DtReal	radiusCEP () const
	Accessor/mutator for myRadiusCEP.
virtual void	setRadiusCEP (const DtReal radiusCEP)
	Accessor/mutator for myRadiusCEP.
virtual void	setFireAndForget (bool isFireAndForget)
	Accessor/mutator for myIsFireAndForget.
virtual bool	fireAndForget () const
	Accessor/mutator for myIsFireAndForget.
virtual DtReal	transitionAngle () const
	Accessor/mutator for myTransitionAngle.
virtual void	setTransitionAngle (DtReal angle)
	Accessor/mutator for myTransitionAngle.
virtual DtReal	proportionalNavigationGain () const
	Accessor/mutator for myProportionalNavigationGain.
virtual void	setProportionalNavigationGain (DtReal gain)
	Accessor/mutator for myProportionalNavigationGain.
virtual const DtString &	rangeName () const
	Accessor/mutator for myRangeName.
virtual void	setRangeName (const DtString &rangeName)
	Accessor/mutator for myRangeName.
Static Public Member Functions
static DtVrfObjectParameters *	creator ()
Protected Member Functions
	DtMissileParameters (const DtMissileParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
Protected Attributes
Parameters
These parameters are available for setting in the OPD files.
DtRwReal	myRange
	Parameter Name: range Parameter Description: The distance the missile can travel.
DtRwReal	myMaxManeuverGs
	Parameter Name: max-maneuver-gs Parameter Description: The maximum amount of lateral maneuvering that a missile can undertake, specified in Gs.
DtRwBoolean	myIsFireAndForget
	Parameter Name: fire-and-forget Parameter Description: Determines how many missiles an entity can launch simultaneously.
DtRwReal	myRadiusCEP
	Parameter Name: cep-radius Parameter Description: Circular Error Probable radius (CEP).
DtRwReal	myTransitionAngle
	Parameter Name: transition-angle Parameter Description: One half the angle at which to switch to proportional navigation Parameter Default Value: 0.1745 (10 degrees) Parameter Units: radians.
DtRwReal	myProportionalNavigationGain
	Parameter Name: proportional-navigation-gain Parameter Description: Gain constant used by the proportional navigation algorithm.
DtRwString	myRangeName
	Name given to any range item associated with this descriptor.

---

Detailed Description

Contains the set of readable/writeable parameters assoicated with an missile type of entity.

Developer Description: Used to hold parameters for the DtMissileStateRepository class.

---

Constructor & Destructor Documentation

DtMissileParameters::DtMissileParameters	(	const DtString &	name = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor with parameters to set up read/writability correctly

DtMissileParameters::DtMissileParameters	(	const DtMissileParameters &	orig,
		const DtString &	name = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)		[protected]

copy constructor

virtual DtMissileParameters::~DtMissileParameters

(

)

[virtual]

destructor

---

Member Function Documentation

const DtMissileParameters& DtMissileParameters::operator=

(

const DtMissileParameters &

orig

)

virtual DtVrfObjectParameters* DtMissileParameters::clone	(	const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)		const [virtual]

Reimplemented from DtMovingObjectParameters.

virtual DtVrfObjectParameters* DtMissileParameters::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry
	)		const [virtual]

Reimplemented from DtMovingObjectParameters.

virtual bool DtMissileParameters::inheritValues

(

const DtVrfObjectParameters *

benefactor

)

[virtual]

Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy. (

For example, US ground vehicle (1 1 225 0 0 0 0) and US Large wheeled utility vehicle (1 1 225 7 0 0 0) might both have DtGroundVehicleParameters parameter blocks. If some or even all parameters are left unspecified for (1 1 225 7 0 0 0), it can inherit them from (1 1 225 0 0 0 0), its DIS/RPR ancestor.
The direct ancestor of a parameter block might use a parameter type that is different (and most likely a class the parameter block is derived from). Every parameter block type also knows how to inherit from the type it is derived from. ( const DtVrfObjectParameters* benefactor)

Reimplemented from DtMovingObjectParameters.

virtual DtReal DtMissileParameters::range

(

)

const [virtual]

Accessor/mutator for myRange.

virtual void DtMissileParameters::setRange

(

const DtReal

range

)

[virtual]

Accessor/mutator for myRange.

virtual DtReal DtMissileParameters::maxManeuverGs

(

)

const [virtual]

Accessor/mutator for myMaxManeuverGs.

virtual void DtMissileParameters::setMaxManeuverGs

(

const DtReal

maxAcceleration

)

[virtual]

Accessor/mutator for myMaxManeuverGs.

virtual DtReal DtMissileParameters::radiusCEP

(

)

const [virtual]

Accessor/mutator for myRadiusCEP.

virtual void DtMissileParameters::setRadiusCEP

(

const DtReal

radiusCEP

)

[virtual]

Accessor/mutator for myRadiusCEP.

virtual void DtMissileParameters::setFireAndForget

(

bool

isFireAndForget

)

[virtual]

Accessor/mutator for myIsFireAndForget.

virtual bool DtMissileParameters::fireAndForget

(

)

const [virtual]

Accessor/mutator for myIsFireAndForget.

virtual DtReal DtMissileParameters::transitionAngle

(

)

const [virtual]

Accessor/mutator for myTransitionAngle.

virtual void DtMissileParameters::setTransitionAngle

(

DtReal

angle

)

[virtual]

Accessor/mutator for myTransitionAngle.

virtual DtReal DtMissileParameters::proportionalNavigationGain

(

)

const [virtual]

Accessor/mutator for myProportionalNavigationGain.

virtual void DtMissileParameters::setProportionalNavigationGain

(

DtReal

gain

)

[virtual]

Accessor/mutator for myProportionalNavigationGain.

virtual const DtString& DtMissileParameters::rangeName

(

)

const [virtual]

Accessor/mutator for myRangeName.

virtual void DtMissileParameters::setRangeName

(

const DtString &

rangeName

)

[virtual]

Accessor/mutator for myRangeName.

virtual DtString DtMissileParameters::type

(

)

const [virtual]

Should return the type of entity this is a parameter block for.

Use the strings in vrfParamTypes.h.

Reimplemented from DtMovingObjectParameters.

virtual void DtMissileParameters::inheritValuesFromThisType

(

const DtMissileParameters *

benefactor

)

[virtual]

static DtVrfObjectParameters* DtMissileParameters::creator

(

)

[static]

Returns:

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtMovingObjectParameters.

---

Member Data Documentation

DtRwReal DtMissileParameters::myRange [protected]

Parameter Name: range
Parameter Description: The distance the missile can travel.

Parameter Default Value: 5000.
Parameter Units: meters

DtRwReal DtMissileParameters::myMaxManeuverGs [protected]

Parameter Name: max-maneuver-gs Parameter Description: The maximum amount of lateral maneuvering that a missile can undertake, specified in Gs.

The higher the number, the tighter the turn that a missile can make. A rocket has a max-maneuver-gs of 0 (it cannot maneuver). Parameter Default Value: 20.

DtRwBoolean DtMissileParameters::myIsFireAndForget [protected]

Parameter Name: fire-and-forget Parameter Description: Determines how many missiles an entity can launch simultaneously.

If True, an entity can launch any number of missiles in succession. If False, an entity can only launch one missile at a time, because it must guide the missile to its target. When fire-and-forget is false, a missile is considered a loss once it passes its target (as opposed to waiting for it to fly off somewhere and get destroyed). Parameter Default Value: False

DtRwReal DtMissileParameters::myRadiusCEP [protected]

Parameter Name: cep-radius Parameter Description: Circular Error Probable radius (CEP).

This is the radius of a circle within which 50 % of the missiles fired will impact. For example, if a cep-radius of 100 meters is specified, then 50 % of missiles fired at a given target should impact within 100 meters of that target and the remaining 50 % of the missile will impact at a distance greater that 100 meters from the target. This assumes that the a missile fired was potentially capable of hitting the desired target (that is, it was in range). Parameter Default Value: 0. Parameter Units: meters

DtRwReal DtMissileParameters::myTransitionAngle [protected]

Parameter Name: transition-angle
Parameter Description: One half the angle at which to switch to proportional navigation
Parameter Default Value: 0.1745 (10 degrees)
Parameter Units: radians.

DtRwReal DtMissileParameters::myProportionalNavigationGain [protected]

Parameter Name: proportional-navigation-gain
Parameter Description: Gain constant used by the proportional navigation algorithm.

Typically in the range 3-5.
Parameter Default Value: 4.

DtRwString DtMissileParameters::myRangeName [protected]

Name given to any range item associated with this descriptor.

Parameter Default Value:

---

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

• include/vrfobjparam/missilePar.h