DtEntDestroyedSearch Class Reference

class DtEntDestroyedSearch:

Instances of DtEntDestroyedSearch are used to search the echelon entity structure for ANY entities that have been destroyed. 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 DtEntDestroyedSearch:

Public Member Functions
	DtEntDestroyedSearch ()
virtual	~DtEntDestroyedSearch () override
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) override
virtual bool	inspectEntity (DtSimObjectReference entity) override
virtual bool	inspectAggregateEntity (DtSimObjectReference entity, bool excludeDestroyed) override
virtual bool	searchSubordinates (DtSimObjectReference pAggEntity, bool excludeDestroyed) override
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)

Private Member Functions
	DtEntDestroyedSearch (const DtEntDestroyedSearch &orig)
DtEntDestroyedSearch &	operator= (const DtEntDestroyedSearch &orig)

Additional Inherited Members
Protected Attributes inherited from DtSimSubordinateSearch
DtString	myModifier
bool	myAnyFlag
bool	myResult
DtUUID	mySimulationObject
const DtSimulationServices *	mySimulationServices

Constructor & Destructor Documentation

DtEntDestroyedSearch::DtEntDestroyedSearch

(

)

default constructor

virtual DtEntDestroyedSearch::~DtEntDestroyedSearch ( )

overridevirtual

destructor

DtEntDestroyedSearch::DtEntDestroyedSearch ( const DtEntDestroyedSearch &  orig )

private

copy constructor; not implemented

Member Function Documentation

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

overrideprotectedvirtual

Function to initialize the search.

Reimplemented from DtSimSubordinateSearch.

virtual bool DtEntDestroyedSearch::inspectEntity ( DtSimObjectReference  entity )

overrideprotectedvirtual

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

Reimplemented from DtSimSubordinateSearch.

virtual bool DtEntDestroyedSearch::inspectAggregateEntity ( DtSimObjectReference  entity, bool  excludeDestroyed  )

overrideprotectedvirtual

Test an aggregate to find one that is destroyed.

Reimplemented from DtSimSubordinateSearch.

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

overrideprotectedvirtual

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.

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

private

assignment operator; not implemented

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfplanmgr/entDestroyedSearch.h