DtFormationControllerDescriptor Class Reference

DtFormationControllerDescriptor; descriptor for the DtDisaggregatedFormationController component. More...

Inheritance diagram for DtFormationControllerDescriptor:

List of all members.

Public Member Functions
	DtFormationControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtFormationControllerDescriptor (const DtFormationControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtFormationControllerDescriptor &	operator= (const DtFormationControllerDescriptor &orig)
	assignment
virtual	~DtFormationControllerDescriptor ()
	destructor
virtual bool	init ()
	Calls createFormationTable() to create new DtFormationTable member and sets it in myFormationTable member.
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual void	setAutoPromoteInFormation (bool value)
virtual bool	autoPromoteInFormation () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtFormationControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwBoolean	myAutoPromoteInFormation
	Parameter Name: auto-promote-in-formation Parameter Description: If true, formations will be as compact as possible, so when an entity is destroyed or independently tasked, other entities will move up in formation to fill the gaps left.

---

Detailed Description

DtFormationControllerDescriptor; descriptor for the DtDisaggregatedFormationController component.

Instances of DtFormationControllerDescriptor stores settings for the DtDisaggregatedFormationController component.

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtFormationControllerDescriptor::~DtFormationControllerDescriptor

(

)

[virtual]

destructor

DtFormationControllerDescriptor::DtFormationControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtFormationControllerDescriptor& DtFormationControllerDescriptor::operator=

(

const DtFormationControllerDescriptor &

orig

)

assignment

virtual bool DtFormationControllerDescriptor::init

(

)

[virtual]

Calls createFormationTable() to create new DtFormationTable member and sets it in myFormationTable member.

Reimplemented from DtComponentDescriptor.

virtual DtString DtFormationControllerDescriptor::type

(

)

const [virtual]

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns:

DtFormationControllerDescriptorType

Reimplemented from DtComponentDescriptor.

virtual void DtFormationControllerDescriptor::setAutoPromoteInFormation

(

bool

value

)

[virtual]

virtual bool DtFormationControllerDescriptor::autoPromoteInFormation

(

)

const [virtual]

virtual DtComponentDescriptor* DtFormationControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtFormationControllerDescriptor::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 DtFormationControllerDescriptor::myAutoPromoteInFormation [protected]

Parameter Name: auto-promote-in-formation
Parameter Description: If true, formations will be as compact as possible, so when an entity is destroyed or independently tasked, other entities will move up in formation to fill the gaps left.

If false, the gaps will be left and all entities will stay in their original formation position. The latter is the VRF 3.11 and earlier behavior. Parameter Default Value: false

---

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

• include/vrfobjparam/formCtlDesc.h