DtCheckEntityIdLevelSearch Class Reference

Inheritance diagram for DtCheckEntityIdLevelSearch:

Public Member Functions
	DtCheckEntityIdLevelSearch ()
virtual	~DtCheckEntityIdLevelSearch ()
void	setCombatIdLevel (int i)
void	setEntity (const DtLocalObject *)
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 (DtLocalObject *entity, DtSimObjectReference objectToCheck)
virtual bool	inspectEntity (DtSimObjectReference objectToCheck)
Protected Member Functions inherited from DtSimSubordinateSearch
virtual bool	initializeSearch (DtSimObjectReference entity)
virtual bool	isForSelfOnly () const
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)
virtual bool	searchSubordinates (DtSimObjectReference entity, bool excludeDestroyed)

Protected Attributes
int	myCombatIdLevel
const DtLocalObject *	myEntity
Protected Attributes inherited from DtSimSubordinateSearch
DtString	myModifier
bool	myAnyFlag
bool	myResult
DtUUID	mySimulationObject
const DtSimulationServices *	mySimulationServices

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

Constructor & Destructor Documentation

DtCheckEntityIdLevelSearch::DtCheckEntityIdLevelSearch

(

)

default constructor

virtual DtCheckEntityIdLevelSearch::~DtCheckEntityIdLevelSearch ( )

virtual

destructor

DtCheckEntityIdLevelSearch::DtCheckEntityIdLevelSearch ( const DtCheckEntityIdLevelSearch &  orig )

private

copy constructor; not implemented

Member Function Documentation

void DtCheckEntityIdLevelSearch::setCombatIdLevel ( int  i )

inline

References myCombatIdLevel.

void DtCheckEntityIdLevelSearch::setEntity ( const DtLocalObject *  o )

inline

References myEntity.

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

protectedvirtual

Function to initialize the search.

Reimplemented from DtSimSubordinateSearch.

virtual bool DtCheckEntityIdLevelSearch::inspectEntity ( DtLocalObject *  entity, DtSimObjectReference  objectToCheck  )

protectedvirtual

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

Reimplemented from DtSimSubordinateSearch.

virtual bool DtCheckEntityIdLevelSearch::inspectEntity ( DtSimObjectReference  entity )

protectedvirtual

Override inspectEntity to do any tests you want to do on base entities that are found in the search. It should return true only if it has found what it is looking for and wants to terminate the search early. By default it simply returns false. It is usually called either because a non-local entity has been found and the default version of inspectRemoteEntity was called, or because a local entity was found and the default version of inspectLocalEntity was called.

Reimplemented from DtSimSubordinateSearch.

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

private

assignment operator; not implemented

Member Data Documentation

int DtCheckEntityIdLevelSearch::myCombatIdLevel

protected

Referenced by setCombatIdLevel().

const DtLocalObject* DtCheckEntityIdLevelSearch::myEntity

protected

Referenced by setEntity().

---

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

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