DtEntInRangeSearch Class Reference

Inheritance diagram for DtEntInRangeSearch:

Public Member Functions
	DtEntInRangeSearch ()
	DtEntInRangeSearch (const DtUUID &area)
virtual	~DtEntInRangeSearch () override
virtual const DtUUID &	target () const
virtual void	setTarget (const DtUUID &)
void	setRange (double)
double	range () const
void	setCoordinateSystem (const Coordinate_System *cs)
const Coordinate_System *	coordinateSystem ()
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) override
virtual bool	inspectEntity (DtSimObjectReference entity) 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	inspectAggregateEntity (DtSimObjectReference entity, bool excludeDestroyed)
virtual bool	searchSubtree (DtSimObjectReference entity, bool excludeDestroyed)
virtual bool	searchSubtree (DtLocalObject *entity, DtSimObjectReference targetOfCheck, bool excludeDestroyed)

Protected Attributes
DtUUID	myTarget
double	myRange
const Coordinate_System *	myLocalCS
DtSimObjectReference	myTargetObject
bool	myWarnedOnce
DtTacticalGraphicSimObjectFacade	myTacticalGraphicSimObjectFacade
Protected Attributes inherited from DtSimSubordinateSearch
DtString	myModifier
bool	myAnyFlag
bool	myResult
DtUUID	mySimulationObject
const DtSimulationServices *	mySimulationServices

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

Constructor & Destructor Documentation

DtEntInRangeSearch::DtEntInRangeSearch

(

)

default constructor

DtEntInRangeSearch::DtEntInRangeSearch

(

const DtUUID &

area

)

virtual DtEntInRangeSearch::~DtEntInRangeSearch ( )

overridevirtual

destructor

DtEntInRangeSearch::DtEntInRangeSearch ( const DtEntInRangeSearch &  orig )

private

copy constructor; not implemented

Member Function Documentation

virtual const DtUUID& DtEntInRangeSearch::target ( ) const

virtual

Get the target.

virtual void DtEntInRangeSearch::setTarget ( const DtUUID &  )

virtual

Set the target.

void DtEntInRangeSearch::setRange ( double  d )

inline

References myRange.

double DtEntInRangeSearch::range ( ) const

inline

References myRange.

void DtEntInRangeSearch::setCoordinateSystem

(

const Coordinate_System *

cs

)

const Coordinate_System* DtEntInRangeSearch::coordinateSystem

(

)

void DtEntInRangeSearch::setWarnedOnce ( bool  b )

inline

References myWarnedOnce.

bool DtEntInRangeSearch::warnedOnce ( ) const

inline

References myWarnedOnce.

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

overrideprotectedvirtual

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 DtEntInRangeSearch::inspectEntity ( DtSimObjectReference  entity )

overrideprotectedvirtual

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

Reimplemented from DtSimSubordinateSearch.

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

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

private

assignment operator; not implemented

Member Data Documentation

DtUUID DtEntInRangeSearch::myTarget

protected

Member variables.

double DtEntInRangeSearch::myRange

protected

Referenced by range(), and setRange().

const Coordinate_System* DtEntInRangeSearch::myLocalCS

protected

DtSimObjectReference DtEntInRangeSearch::myTargetObject

protected

bool DtEntInRangeSearch::myWarnedOnce

protected

Referenced by setWarnedOnce(), and warnedOnce().

DtTacticalGraphicSimObjectFacade DtEntInRangeSearch::myTacticalGraphicSimObjectFacade

protected

---

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

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