DtEntUnderFireSearch Class Reference

class DtEntUnderFireSearch:

Instances of DtEntUnderFireSearch are used to search the echelon entity structure for ANY entities that are under fire. 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 DtEntUnderFireSearch:

Public Member Functions
	DtEntUnderFireSearch ()
virtual	~DtEntUnderFireSearch ()
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)
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	inspectAggregateEntity (DtSimObjectReference entity, bool excludeDestroyed)
virtual bool	searchSubtree (DtSimObjectReference entity, bool excludeDestroyed)
virtual bool	searchSubtree (DtLocalObject *entity, DtSimObjectReference targetOfCheck, bool excludeDestroyed)

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

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

Constructor & Destructor Documentation

DtEntUnderFireSearch::DtEntUnderFireSearch

(

)

default constructor

virtual DtEntUnderFireSearch::~DtEntUnderFireSearch ( )

virtual

destructor

DtEntUnderFireSearch::DtEntUnderFireSearch ( const DtEntUnderFireSearch &  orig )

private

copy constructor; not implemented

Member Function Documentation

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

protectedvirtual

Function to initialize the search.

Reimplemented from DtSimSubordinateSearch.

virtual bool DtEntUnderFireSearch::inspectEntity ( DtSimObjectReference  entity )

protectedvirtual

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

Reimplemented from DtSimSubordinateSearch.

virtual bool DtEntUnderFireSearch::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.

DtEntUnderFireSearch& DtEntUnderFireSearch::operator= ( const DtEntUnderFireSearch &  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-0-branch/include/vrfplanmgr/entUnderFireSearch.h