DtEntInAreaSearch Class Reference

Instances of DtEntInAreaSearch are used to search the echelon entity structure for ANY entities inside a given area. 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 DtEntInAreaSearch:

Public Member Functions
	DtEntInAreaSearch ()
	DtEntInAreaSearch (const DtUUID &area)
virtual	~DtEntInAreaSearch ()
virtual const DtUUID &	area () const
virtual void	setArea (const DtUUID &)
void	setWarnedOnce (bool)
bool	warnedOnce () 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)
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
DtUUID	myArea
DtSimObjectReference	myControlArea
bool	myWarnedOnce
DtTacticalGraphicSimObjectFacade	myTacticalGraphicSimObjectFacade
Protected Attributes inherited from DtSimSubordinateSearch
DtString	myModifier
bool	myAnyFlag
bool	myResult
DtUUID	mySimulationObject
const DtSimulationServices *	mySimulationServices

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

Constructor & Destructor Documentation

DtEntInAreaSearch::DtEntInAreaSearch

(

)

default constructor

DtEntInAreaSearch::DtEntInAreaSearch

(

const DtUUID &

area

)

virtual DtEntInAreaSearch::~DtEntInAreaSearch ( )

virtual

destructor

DtEntInAreaSearch::DtEntInAreaSearch ( const DtEntInAreaSearch &  orig )

private

copy constructor; not implemented

Member Function Documentation

virtual const DtUUID& DtEntInAreaSearch::area ( ) const

virtual

Get the area. Was: areaName.

virtual void DtEntInAreaSearch::setArea ( const DtUUID &  )

virtual

Set the area. Was: setAreaName.

void DtEntInAreaSearch::setWarnedOnce ( bool  b )

inline

References myWarnedOnce.

bool DtEntInAreaSearch::warnedOnce ( ) const

inline

References myWarnedOnce.

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

protectedvirtual

Function to initialize the search, it looks up area name so that it won't have to do it for each test.

Reimplemented from DtSimSubordinateSearch.

virtual bool DtEntInAreaSearch::inspectEntity ( DtSimObjectReference  entity )

protectedvirtual

Test any and all entities to find one that is in the area.

Reimplemented from DtSimSubordinateSearch.

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

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

private

assignment operator; not implemented

Member Data Documentation

DtUUID DtEntInAreaSearch::myArea

protected

Member variables.

DtSimObjectReference DtEntInAreaSearch::myControlArea

protected

bool DtEntInAreaSearch::myWarnedOnce

protected

Referenced by setWarnedOnce(), and warnedOnce().

DtTacticalGraphicSimObjectFacade DtEntInAreaSearch::myTacticalGraphicSimObjectFacade

protected

---

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

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