Inheritance diagram for DtVrfAggregateStateRepository:

Public Member Functions
	DtVrfAggregateStateRepository (DtVrfObject vrfObject, const DtObjectType &objectType, DtVrfObjectParameters parameters, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVrfAggregateStateRepository (const DtVrfAggregateStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfAggregateStateRepository &	operator= (const DtVrfAggregateStateRepository &orig)
virtual	~DtVrfAggregateStateRepository ()
virtual DtSimObjectStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	Clone.
virtual bool	init ()
	must be called before any other member functions are called (including assignment operator)
virtual DtString	type () const
	Returns the string type of the repository, as defined in vrfSRTypes.h.
virtual DtFormationState *	formationState () const
virtual void	setFormation (DtAggregateFormation formation)
virtual DtAggregateFormation	formation () const
virtual bool	formationNameSpecified () const
virtual double	formationHalfLength ()
	Returns the half-length of the current formation.
virtual const int	vrfMovingObjectStateRepositorySubType () const
	Returns DtVrfMovingObjectStateRepositorySubTypeAggregate.
virtual const int	aggregateStateRepositorySubType () const
	Returns DtVrfAggregateStateRepositorySubTypeBase.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Overridden to to handle pre-version 3.8 order of battle files.
virtual bool	aggregatedExtent (DtExtent &extent)
virtual bool	computeExtentFromParameters (const DtString &formationName, DtExtent &extent)
virtual void	setParameterEntry (DtVrfObjectParameters *parameterEntry)
	If a clone has been created, this call will return the cloned entry as a const pointer, else returns the original pointer.

virtual void	setFormationName (const DtString &name)
	The name of the current formation.
virtual DtString	formationName () const
	The name of the current formation.

virtual void	setAggregateState (enum DtAggregateState state)
	DIS/RPR FOM Aggregate mode (DtOtherAggregateState, DtAggregated, DtDisaggregated).
virtual enum DtAggregateState	aggregateState () const
	DIS/RPR FOM Aggregate mode (DtOtherAggregateState, DtAggregated, DtDisaggregated).
Static Public Member Functions
static DtVrfObjectStateRepository *	creator (const DtString &name, DtVrfObject vrfObject, const DtObjectType &objectType, DtVrfObjectParameters parameters, DtReaderWriterRegistry *parentRegistry)
	Returns newly created instance of this class.
static DtVrfAggregateStateRepository *	isVrfAggregateStateRepository (DtSimObjectStateRepository *repository)
	Returns a the pointer the repository, if the repository passed in is of type DtVrfAggregateStateRepository, NULL if not.
static const DtVrfAggregateStateRepository *	isVrfAggregateStateRepository (const DtSimObjectStateRepository *repository)
Protected Member Functions
	DtVrfAggregateStateRepository ()
	default constructor cannot be used
virtual void	createFormationState ()
virtual bool	computeExtent (const DtAggregateObjectParameters &parameterEntry, const DtString &formationName, DtExtent &extent)
virtual std::list< DtVector >	generateFormationPositions (const DtVrfObjectParameters &parameterEntry, DtFormation &formation)
virtual bool	getFormation (const DtString &formationName, const DtAggregateObjectParameters &parameterEntry, DtFormation &formation)
virtual void	preGetSelf ()
	Overridden to handle pre-3.12 order-of-battle file format.
virtual void	postGetSelf ()
	Hook function called immediately following getSelf().
Protected Attributes
DtRwFormationType	myFormation
DtRwString	myFormationName
DtFormationState *	myFormationState
DtRwAggregateState	myAggregateState
DtExtent	myCachedExtent
bool	myCachedExtentIsValid

Constructor & Destructor Documentation

DtVrfAggregateStateRepository::DtVrfAggregateStateRepository ( ) [protected]

default constructor cannot be used

DtVrfAggregateStateRepository::DtVrfAggregateStateRepository	(	DtVrfObject *	vrfObject,
		const DtObjectType &	objectType,
		DtVrfObjectParameters *	parameters,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

DtVrfAggregateStateRepository::DtVrfAggregateStateRepository	(	const DtVrfAggregateStateRepository &	orig,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

virtual DtVrfAggregateStateRepository::~DtVrfAggregateStateRepository ( ) [virtual]

Member Function Documentation

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

virtual DtSimObjectStateRepository* DtVrfAggregateStateRepository::clone	(	const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)		const `[virtual]`

Clone.

Reimplemented from DtVrfMovingObjectStateRepository.

virtual bool DtVrfAggregateStateRepository::init ( ) [virtual]

must be called before any other member functions are called (including assignment operator)

Reimplemented from DtVrfObjectStateRepository.

virtual DtString DtVrfAggregateStateRepository::type ( ) const [virtual]

Returns the string type of the repository, as defined in vrfSRTypes.h.

Reimplemented from DtVrfMovingObjectStateRepository.

virtual DtFormationState* DtVrfAggregateStateRepository::formationState ( ) const [virtual]

virtual void DtVrfAggregateStateRepository::setFormation ( DtAggregateFormation formation ) [virtual]

virtual DtAggregateFormation DtVrfAggregateStateRepository::formation ( ) const [virtual]

virtual void DtVrfAggregateStateRepository::setFormationName ( const DtString & name ) [virtual]

The name of the current formation.

Setting the formation name also sets myFormation. If the string formation name matches one of the defined formation enumerations (i.e. "Vee", "Line", etc), then myFormation is set to the corresponding enumeration. Otherwise, it is set to DtOtherAggregateFormation.

virtual DtString DtVrfAggregateStateRepository::formationName ( ) const [virtual]

The name of the current formation.

Setting the formation name also sets myFormation. If the string formation name matches one of the defined formation enumerations (i.e. "Vee", "Line", etc), then myFormation is set to the corresponding enumeration. Otherwise, it is set to DtOtherAggregateFormation.

virtual void DtVrfAggregateStateRepository::setAggregateState ( enum DtAggregateState state ) [virtual]

DIS/RPR FOM Aggregate mode (DtOtherAggregateState, DtAggregated, DtDisaggregated).

Remote non-VR-Forces aggregates may have a mode of DtOtherAggregateState. VR-Forces aggregates may be in either a DtAggregated or DtDisaggregated state (and this may change mode over the course of the simulation).

virtual enum DtAggregateState DtVrfAggregateStateRepository::aggregateState ( ) const [virtual]

DIS/RPR FOM Aggregate mode (DtOtherAggregateState, DtAggregated, DtDisaggregated).

Remote non-VR-Forces aggregates may have a mode of DtOtherAggregateState. VR-Forces aggregates may be in either a DtAggregated or DtDisaggregated state (and this may change mode over the course of the simulation).

virtual bool DtVrfAggregateStateRepository::formationNameSpecified ( ) const [virtual]

Returns:: The valueSpecified flag for myFormationName.

virtual double DtVrfAggregateStateRepository::formationHalfLength ( ) [virtual]

Returns the half-length of the current formation.

virtual const int DtVrfAggregateStateRepository::vrfMovingObjectStateRepositorySubType ( ) const [virtual]

Returns DtVrfMovingObjectStateRepositorySubTypeAggregate.

Reimplemented from DtVrfMovingObjectStateRepository.

virtual const int DtVrfAggregateStateRepository::aggregateStateRepositorySubType ( ) const [virtual]

Returns DtVrfAggregateStateRepositorySubTypeBase.

virtual void DtVrfAggregateStateRepository::getSelf	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		`[virtual]`

Overridden to to handle pre-version 3.8 order of battle files.

Reimplemented from DtVrfObjectStateRepository.

static DtVrfObjectStateRepository* DtVrfAggregateStateRepository::creator	(	const DtString &	name,
		DtVrfObject *	vrfObject,
		const DtObjectType &	objectType,
		DtVrfObjectParameters *	parameters,
		DtReaderWriterRegistry *	parentRegistry
	)		`[static]`

Returns newly created instance of this class.

Reimplemented from DtVrfMovingObjectStateRepository.

static DtVrfAggregateStateRepository* DtVrfAggregateStateRepository::isVrfAggregateStateRepository ( DtSimObjectStateRepository * repository ) [static]

Returns a the pointer the repository, if the repository passed in is of type DtVrfAggregateStateRepository, NULL if not.

static const DtVrfAggregateStateRepository* DtVrfAggregateStateRepository::isVrfAggregateStateRepository ( const DtSimObjectStateRepository * repository ) [static]

virtual bool DtVrfAggregateStateRepository::aggregatedExtent ( DtExtent & extent ) [virtual]

virtual bool DtVrfAggregateStateRepository::computeExtentFromParameters	(	const DtString &	formationName,
		DtExtent &	extent
	)		`[virtual]`

virtual void DtVrfAggregateStateRepository::setParameterEntry ( DtVrfObjectParameters * parameterEntry ) [virtual]

If a clone has been created, this call will return the cloned entry as a const pointer, else returns the original pointer.

Reimplemented from DtVrfObjectStateRepository.

virtual void DtVrfAggregateStateRepository::createFormationState ( ) [protected, virtual]

virtual bool DtVrfAggregateStateRepository::computeExtent	(	const DtAggregateObjectParameters &	parameterEntry,
		const DtString &	formationName,
		DtExtent &	extent
	)		`[protected, virtual]`

virtual std::list<DtVector> DtVrfAggregateStateRepository::generateFormationPositions	(	const DtVrfObjectParameters &	parameterEntry,
		DtFormation &	formation
	)		`[protected, virtual]`

virtual bool DtVrfAggregateStateRepository::getFormation	(	const DtString &	formationName,
		const DtAggregateObjectParameters &	parameterEntry,
		DtFormation &	formation
	)		`[protected, virtual]`