DtAggregateObjectParameters Class Reference

Contains the set of readable/writeable parameters associated with a pseudo-aggregate entities. More...

Inheritance diagram for DtAggregateObjectParameters:

List of all members.

Public Member Functions
	DtAggregateObjectParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	Constructor with parameters to set up read/writability correctly.
	DtAggregateObjectParameters (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
const DtAggregateObjectParameters &	operator= (const DtAggregateObjectParameters &orig)
virtual	~DtAggregateObjectParameters ()
	destructor
virtual bool	init ()
	Invoked when created so that deriving classes may do virtual allocation as necessary.
virtual DtVrfObjectParameters *	clone (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtVrfObjectParameters *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) 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 DtAggregateObjectParameters *benefactor)
virtual DtFormation *	getFormation (const DtString &formationName, DtString *retFormationName=NULL) const
	Lookup and return a DtFormation from the formation table for this aggregate.
virtual DtFormation *	getDefaultFormation () const
	Find the default formation in the formation table and return that.
virtual DtFormationTable *	formationTable ()
	Accessor/mutator for myFormationTable.
virtual const DtFormationTable *	formationTable () const
Static Public Member Functions
static DtVrfObjectParameters *	creator ()
Protected Member Functions
	DtAggregateObjectParameters (const DtAggregateObjectParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtAggregateObjectParameters (const DtAggregateObjectParameters &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual DtFormationTable *	createFormationTable (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
	Factory method for DtFormationTable.
Protected Attributes
Parameters
These parameters are available for setting in the OPD files. Parameter Name: formation-list Parameter Description: Table of formation entries indicating positions and offsets each member should maintain in. Parameter Default Value:
DtFormationTable *	myFormationTable

---

Detailed Description

Contains the set of readable/writeable parameters associated with a pseudo-aggregate entities.

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

---

Constructor & Destructor Documentation

DtAggregateObjectParameters::DtAggregateObjectParameters	(	const DtString &	name = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Constructor with parameters to set up read/writability correctly.

DtAggregateObjectParameters::DtAggregateObjectParameters	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

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

copy constructor

DtAggregateObjectParameters::DtAggregateObjectParameters	(	const DtAggregateObjectParameters &	orig,
		const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		[protected]

virtual DtAggregateObjectParameters::~DtAggregateObjectParameters

(

)

[virtual]

destructor

---

Member Function Documentation

const DtAggregateObjectParameters& DtAggregateObjectParameters::operator=

(

const DtAggregateObjectParameters &

orig

)

virtual bool DtAggregateObjectParameters::init

(

)

[virtual]

Invoked when created so that deriving classes may do virtual allocation as necessary.

The base class version creates the local and remote composed object types. Calls createSubordinateObjectsList() and createAttachedObjectsList() to create the mySubordinateObjects and myAttachedObjects data members, respectively.

Reimplemented from DtVrfObjectParameters.

virtual DtVrfObjectParameters* DtAggregateObjectParameters::clone	(	const DtString &	name = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		const [virtual]

Reimplemented from DtMovingObjectParameters.

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

Reimplemented from DtMovingObjectParameters.

virtual bool DtAggregateObjectParameters::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 DtString DtAggregateObjectParameters::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 DtAggregateObjectParameters::inheritValuesFromThisType

(

const DtAggregateObjectParameters *

benefactor

)

[virtual]

virtual DtFormation* DtAggregateObjectParameters::getFormation	(	const DtString &	formationName,
		DtString *	retFormationName = NULL
	)		const [virtual]

Lookup and return a DtFormation from the formation table for this aggregate.

Pass in return pointer to store the name of the formation actually returned in case the supplied formation name does not exist

virtual DtFormation* DtAggregateObjectParameters::getDefaultFormation

(

)

const [virtual]

Find the default formation in the formation table and return that.

virtual DtFormationTable* DtAggregateObjectParameters::formationTable

(

)

[virtual]

Accessor/mutator for myFormationTable.

virtual const DtFormationTable* DtAggregateObjectParameters::formationTable

(

)

const [virtual]

virtual DtFormationTable* DtAggregateObjectParameters::createFormationTable	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		const [protected, virtual]

Factory method for DtFormationTable.

Returns:

Newly allocated instance of DtFormationTable

static DtVrfObjectParameters* DtAggregateObjectParameters::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

DtFormationTable* DtAggregateObjectParameters::myFormationTable [protected]

---

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

• include/vrfobjparam/aggregateObjectParameters.h