DtSurrenderSearch Class Reference

class DtSurrenderSearch:

Instances of DtSurrenderSearch are used to search the echelon entity structure for ANY entities that might have the given surrendered value. 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 DtSurrenderSearch:

Public Member Functions
	DtSurrenderSearch ()
virtual	~DtSurrenderSearch ()
void	setSurrenderTestValue (bool)
bool	surrenderTestValue () 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 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	isValidEntity (DtSimObjectReference entity)
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)

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

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

Constructor & Destructor Documentation

DtSurrenderSearch::DtSurrenderSearch

(

)

default constructor

virtual DtSurrenderSearch::~DtSurrenderSearch ( )

virtual

destructor

DtSurrenderSearch::DtSurrenderSearch ( const DtSurrenderSearch &  orig )

private

copy constructor; not implemented

Member Function Documentation

void DtSurrenderSearch::setSurrenderTestValue ( bool  b )

inline

References mySurrenderTestVal.

bool DtSurrenderSearch::surrenderTestValue ( ) const

inline

References mySurrenderTestVal.

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

protectedvirtual

Function to initialize the search.

Reimplemented from DtSimSubordinateSearch.

virtual bool DtSurrenderSearch::inspectEntity ( DtSimObjectReference  entity )

protectedvirtual

Test any and all entities to find one that is at a certain altitude.

Reimplemented from DtSimSubordinateSearch.

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

virtual bool DtSurrenderSearch::isValidEntity ( DtSimObjectReference  entity )

protectedvirtual

Returns true if an aggregate or lifeform (filters platform ents)

Reimplemented from DtSimSubordinateSearch.

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

private

assignment operator; not implemented

Member Data Documentation

bool DtSurrenderSearch::mySurrenderTestVal

protected

Referenced by setSurrenderTestValue(), and surrenderTestValue().

---

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

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