This DtAggregateSimObjectFacadeInterface class will provide API functionality for aggregate level calls. Use the isUsable method to determine if this class is usable for the given object. This will provide current frame access only. Every routine called will check the isUsable method before usage, and, if it is not usable, will throw the DtUnimplementedMethod exception.

This class is not thread safe. It should only be used in the context of a single thread/object

Inheritance diagram for DtAggregateSimObjectFacadeInterface:

[legend]

Public Member Functions
	DtAggregateSimObjectFacadeInterface ()

virtual	~DtAggregateSimObjectFacadeInterface ()

bool	isUsable () const

enum DtAggregateState	aggregateState () const

DtString	formationName () const

DtAggregateFormation	formation () const

int	numberSubordinateVehicles () const

bool	canHaveSubordinates () const

bool	isSubordinate (const DtUUID &) const

double	totalMass () const

bool	aggregatedExtent (DtExtent &extent) const

double	formationHalfLength () const

double	formationSize () const

DtString	activity () const


const std::vector < DtSimObjectReference > &	subordinates () const

int	indexOfSubordinate (const DtUUID &) const

Public Member Functions inherited from DtAppearanceSimObjectFacadeInterface
	DtAppearanceSimObjectFacadeInterface ()

virtual	~DtAppearanceSimObjectFacadeInterface ()

bool	isUsable () const

int	damageState () const

bool	isDestroyed () const

bool	firePowerKilled () const

bool	mobilityKilled () const

bool	isConcealed () const

DtReal	healthPct () const

const DtAppearance &	appearance () const

int	capabilities () const

Public Member Functions inherited from DtRangeItemSimObjectFacadeInterface
	DtRangeItemSimObjectFacadeInterface ()

virtual	~DtRangeItemSimObjectFacadeInterface ()

bool	isUsable () const

const DtRangeItems &	rangeItems () const

Public Member Functions inherited from DtMovementSimObjectFacadeInterface
	DtMovementSimObjectFacadeInterface ()

virtual	~DtMovementSimObjectFacadeInterface ()

DtDeadReckonTypes	deadReckoningAlgorithm () const

const DtThresholder &	thresholder () const

bool	isSpatiallyFrozen () const

bool	isFrozen () const

DtStationName	parentStationName () const

const DtVector &	worldVelocity () const

const DtVector &	localVelocity () const

const DtVector	bodyVelocity () const

const DtVector &	relativeVelocity () const

const DtVector &	parentVelocity () const

const DtVector &	rotationalVelocity () const

const DtVector &	worldAcceleration () const

const DtVector &	localAcceleration () const

const DtVector &	relativeAcceleration () const

double	localSpeed () const

double	speed () const

double	forwardSpeed () const

Protected Member Functions
virtual void	setupDecorator () override

virtual DtSimObjectReference	simObject () const =0

Protected Member Functions inherited from DtAppearanceSimObjectFacadeInterface
const makVrf::DtSimulatedObjectStateComponent *	simObjectStateComponent () const

Protected Member Functions inherited from DtMovementSimObjectFacadeInterface
void	setupDecorator ()

const makVrf::DtEntityLocationStateComponent *	entityLocationStateComponent () const

Protected Attributes
DtAggregateSimObjectDecorator *	myAggregateSimObjectDecorator

Protected Attributes inherited from DtAppearanceSimObjectFacadeInterface
DtAppearance	myAppearance

const makVrf::DtSimulatedObjectStateComponent *	mySimulatedObjectStateComponent

tbb::spin_rw_mutex	mySimObjectStateComponentMutex

Protected Attributes inherited from DtMovementSimObjectFacadeInterface
const makVrf::DtEntityLocationStateComponent *	myEntityLocationStateComponent

tbb::spin_rw_mutex	myEntityLocationStateComponentMutex

Constructor & Destructor Documentation

DtAggregateSimObjectFacadeInterface::DtAggregateSimObjectFacadeInterface ( )

virtual DtAggregateSimObjectFacadeInterface::~DtAggregateSimObjectFacadeInterface ( )

virtual

Member Function Documentation

bool DtAggregateSimObjectFacadeInterface::isUsable ( ) const

virtual

Make this call after construction to see if the supplied sim object can use this class.

Reimplemented from DtMovementSimObjectFacadeInterface.

Reimplemented in DtLocalObjectFacade< DtAggregateSimObjectFacadeInterface, DtAggregateLocalObjectFacadeInterface >.

enum DtAggregateState DtAggregateSimObjectFacadeInterface::aggregateState ( ) const

DtString DtAggregateSimObjectFacadeInterface::formationName ( ) const

DtAggregateFormation DtAggregateSimObjectFacadeInterface::formation ( ) const

const std::vector<DtSimObjectReference>& DtAggregateSimObjectFacadeInterface::subordinates ( ) const

Returns the subordinates of this object.

int DtAggregateSimObjectFacadeInterface::indexOfSubordinate ( const DtUUID & ) const

Returns the subordinates of this object.

int DtAggregateSimObjectFacadeInterface::numberSubordinateVehicles ( ) const

Number of non unit subordinates that are part of this aggregate (non destroyed)

bool DtAggregateSimObjectFacadeInterface::canHaveSubordinates ( ) const

bool DtAggregateSimObjectFacadeInterface::isSubordinate ( const DtUUID & ) const

double DtAggregateSimObjectFacadeInterface::totalMass ( ) const

Returns the total mass including loadouts and fuel.

bool DtAggregateSimObjectFacadeInterface::aggregatedExtent ( DtExtent & extent ) const

double DtAggregateSimObjectFacadeInterface::formationHalfLength ( ) const

The formation (half) size in the forward-back direction.

double DtAggregateSimObjectFacadeInterface::formationSize ( ) const

The size of the formation along its largest dimension.

DtString DtAggregateSimObjectFacadeInterface::activity ( ) const

virtual void DtAggregateSimObjectFacadeInterface::setupDecorator ( )

overrideprotectedvirtual

Reimplemented from DtAppearanceSimObjectFacadeInterface.

Reimplemented in DtSimObjectFacade< DtAggregateSimObjectFacadeInterface >, and DtLocalObjectFacade< DtAggregateSimObjectFacadeInterface, DtAggregateLocalObjectFacadeInterface >.

virtual DtSimObjectReference DtAggregateSimObjectFacadeInterface::simObject ( ) const

protectedpure virtual

Implemented by subclasses to return the sim object this class represents.

Implements DtAppearanceSimObjectFacadeInterface.

Implemented in DtSimObjectFacade< DtAggregateSimObjectFacadeInterface >.

Member Data Documentation

DtAggregateSimObjectDecorator* DtAggregateSimObjectFacadeInterface::myAggregateSimObjectDecorator

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjcore/aggregateSimObjectFacade.h

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation