DtAggregateMoveIntoFormationDescriptor Class Reference

Class DtAggregateMoveIntoFormationDescriptor holds all of the readable/writeable parameters used to configure a DtAggregateMoveIntoFormationController model component. More...

Inheritance diagram for DtAggregateMoveIntoFormationDescriptor:

List of all members.

Public Member Functions
	DtAggregateMoveIntoFormationDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtAggregateMoveIntoFormationDescriptor (const DtAggregateMoveIntoFormationDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtAggregateMoveIntoFormationDescriptor &	operator= (const DtAggregateMoveIntoFormationDescriptor &orig)
	assignment
virtual	~DtAggregateMoveIntoFormationDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of descriptor.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual bool	stopMovingUponArrival () const
	Accessor/mutator for myStopMovingUponArrival.
virtual void	setStopMovingUponArrival (bool yesNo)
	Accessor/mutator for myStopMovingUponArrival.
virtual bool	turnToHeadingUponArrival () const
	Accessor/mutator for myTurnToHeadingUponArrival.
virtual void	setTurnToHeadingUponArrival (bool yesNo)
	Accessor/mutator for myTurnToHeadingUponArrival.
virtual bool	groundClamp () const
	Accessor/mutator for myGroundClamp.
virtual void	setGroundClamp (bool yesNo)
	Accessor/mutator for myGroundClamp.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtAggregateMoveIntoFormationDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwBoolean	myStopMovingUponArrival
	Parameter Name: stop-moving-upon-arrival Parameter Description: Stop moving upon arrival at location.
DtRwBoolean	myTurnToHeadingUponArrival
	Parameter Name: turn-to-heading-upon-arrival Parameter Description: Turn to heading upon arrival at location.
DtRwBoolean	myGroundClamp
	Parameter Name: ground-clamp Parameter Description: Ground-clamp locations.

---

Detailed Description

Class DtAggregateMoveIntoFormationDescriptor holds all of the readable/writeable parameters used to configure a DtAggregateMoveIntoFormationController model component.

End User Description: The DtAggregateMoveIntoFormationDescriptor should only be configured as a part of aggregate entity types (entities configured with a vrf-aggregate-state-repository).

---

Constructor & Destructor Documentation

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

constructor

DtAggregateMoveIntoFormationDescriptor::DtAggregateMoveIntoFormationDescriptor	(	const DtAggregateMoveIntoFormationDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtAggregateMoveIntoFormationDescriptor::~DtAggregateMoveIntoFormationDescriptor

(

)

[virtual]

destructor

DtAggregateMoveIntoFormationDescriptor::DtAggregateMoveIntoFormationDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtAggregateMoveIntoFormationDescriptor& DtAggregateMoveIntoFormationDescriptor::operator=

(

const DtAggregateMoveIntoFormationDescriptor &

orig

)

assignment

virtual DtString DtAggregateMoveIntoFormationDescriptor::type

(

)

const [virtual]

Returns the type of descriptor.

Used to create the descriptor when read in from an mtl file. Descriptor types are defined in compDescTypes.h

Returns:

DtAggregateMoveIntoFormationControllerDescriptorType

Reimplemented from DtComponentDescriptor.

virtual bool DtAggregateMoveIntoFormationDescriptor::stopMovingUponArrival

(

)

const [virtual]

Accessor/mutator for myStopMovingUponArrival.

virtual void DtAggregateMoveIntoFormationDescriptor::setStopMovingUponArrival

(

bool

yesNo

)

[virtual]

Accessor/mutator for myStopMovingUponArrival.

virtual bool DtAggregateMoveIntoFormationDescriptor::turnToHeadingUponArrival

(

)

const [virtual]

Accessor/mutator for myTurnToHeadingUponArrival.

virtual void DtAggregateMoveIntoFormationDescriptor::setTurnToHeadingUponArrival

(

bool

yesNo

)

[virtual]

Accessor/mutator for myTurnToHeadingUponArrival.

virtual bool DtAggregateMoveIntoFormationDescriptor::groundClamp

(

)

const [virtual]

Accessor/mutator for myGroundClamp.

virtual void DtAggregateMoveIntoFormationDescriptor::setGroundClamp

(

bool

yesNo

)

[virtual]

Accessor/mutator for myGroundClamp.

virtual DtComponentDescriptor* DtAggregateMoveIntoFormationDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtAggregateMoveIntoFormationDescriptor::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 DtComponentDescriptor.

---

Member Data Documentation

DtRwBoolean DtAggregateMoveIntoFormationDescriptor::myStopMovingUponArrival [protected]

Parameter Name: stop-moving-upon-arrival
Parameter Description: Stop moving upon arrival at location.

Set this to true if you want your individual subordinates to stop moving (appropriate for ground vehicles and dismounted infantry). Set this to false if this is not needed (or practical, in the case of fixed-wing entities).
Parameter Default Value: False

DtRwBoolean DtAggregateMoveIntoFormationDescriptor::myTurnToHeadingUponArrival [protected]

Parameter Name: turn-to-heading-upon-arrival
Parameter Description: Turn to heading upon arrival at location.

Set this to true if you want your subordinates to turn to the given heading upon arrival at the location (appropriate for ground vehicles and DI). Set to false if this is not needed (or practial, as in the case of fixed-wing entities).
Parameter Default Value: False

DtRwBoolean DtAggregateMoveIntoFormationDescriptor::myGroundClamp [protected]

Parameter Name: ground-clamp
Parameter Description: Ground-clamp locations.

Ground-vehicles and human aggregates should set this value to true. Fixed-wing and rotary-wing entities should set this value to false.
Parameter Default Value: True

---

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

• include/vrfobjparam/aggregateMoveIntoFormDesc.h