class DtEntEmbarkationStateChangedSearch:

Instances of DtEntEmbarkationStateChangedSearch are used to search the echelon entity structure for ANY entities that have been embarked/disembarked. If any are detected the search is terminated. Call the searchBelow() function to do the actual search. Test the result by calling result().

Inheritance diagram for DtEntEmbarkationStateChangedSearch:

[legend]

Public Member Functions
	DtEntEmbarkationStateChangedSearch ()

virtual	~DtEntEmbarkationStateChangedSearch ()

void	setEmbarkedOn (const DtUUID &)

const DtUUID &	embarkedOn () const

Public Member Functions inherited from DtSimSubordinateSearch
	DtSimSubordinateSearch ()

virtual	~DtSimSubordinateSearch ()=0

bool	search (const DtUUID &search, DtLocalObject owner, const DtSimulationServices )

virtual const DtString &	modifier () const

virtual void	setModifier (const DtString &modifier)

virtual bool	searchBelow (DtSimObjectReference entity, bool excludeDestroyed)

virtual bool	searchBelow (DtLocalObject *entity, DtSimObjectReference targetOfCheck, bool excludeDestroyed)

virtual bool	searchBelow (int iForce, bool excludeDestroyed)

virtual bool	result ()

virtual bool	isTopLevelEntity (const DtString &entity) const

virtual bool	isValidEntity (DtSimObjectReference entity)

virtual int	forceType (const DtString &entity) const

virtual const DtUUID &	simulationObject () const

Protected Member Functions
virtual bool	initializeSearch (const DtSimulationServices *vrfObjectManager)

virtual bool	inspectEntity (DtSimObjectReference entity)

virtual bool	searchSubordinates (DtSimObjectReference pAggEntity, bool excludeDestroyed)

virtual bool	inspectAggregateEntity (DtSimObjectReference entity, bool excludeDestroyed)

Protected Member Functions inherited from DtSimSubordinateSearch
virtual bool	initializeSearch (DtSimObjectReference entity)

virtual bool	isForSelfOnly () const

virtual bool	inspectEntity (DtLocalObject *entity, DtSimObjectReference targetOfCheck)

virtual bool	inspectTopLevelEntity (DtSimObjectReference entity, bool excludeDestroyed)

virtual bool	searchSubtree (DtSimObjectReference entity, bool excludeDestroyed)

virtual bool	searchSubtree (DtLocalObject *entity, DtSimObjectReference targetOfCheck, bool excludeDestroyed)

Protected Attributes
DtUUID	myEmbarkedOn

Protected Attributes inherited from DtSimSubordinateSearch
DtString	myModifier

bool	myAnyFlag

bool	myResult

DtUUID	mySimulationObject

const DtSimulationServices *	mySimulationServices

Private Member Functions
	DtEntEmbarkationStateChangedSearch (const DtEntEmbarkationStateChangedSearch &orig)

DtEntEmbarkationStateChangedSearch &	operator= (const DtEntEmbarkationStateChangedSearch &orig)

Constructor & Destructor Documentation

DtEntEmbarkationStateChangedSearch::DtEntEmbarkationStateChangedSearch ( )

default constructor

virtual DtEntEmbarkationStateChangedSearch::~DtEntEmbarkationStateChangedSearch ( )

virtual

destructor

DtEntEmbarkationStateChangedSearch::DtEntEmbarkationStateChangedSearch ( const DtEntEmbarkationStateChangedSearch & orig )

private

copy constructor; not implemented

Member Function Documentation

void DtEntEmbarkationStateChangedSearch::setEmbarkedOn ( const DtUUID & s )

inline

References myEmbarkedOn.

const DtUUID & DtEntEmbarkationStateChangedSearch::embarkedOn ( ) const

inline

References myEmbarkedOn.

virtual bool DtEntEmbarkationStateChangedSearch::initializeSearch ( const DtSimulationServices * vrfObjectManager )

protectedvirtual

Function to initialize the search.

Reimplemented from DtSimSubordinateSearch.

virtual bool DtEntEmbarkationStateChangedSearch::inspectEntity ( DtSimObjectReference entity )

protectedvirtual

Test any and all entities to find one that is embarked.

Reimplemented from DtSimSubordinateSearch.

virtual bool DtEntEmbarkationStateChangedSearch::searchSubordinates	(	DtSimObjectReference	pAggEntity,
		bool	excludeDestroyed
	)

protectedvirtual

Controls whether subordinates of a specified pseudo-aggregate are searched. If the "ANY" modifier was specified, it calls the base class version, otherwise it just returns false.

Reimplemented from DtSimSubordinateSearch.