DtEntAltitudeSearch Class Reference

class DtEntAltitudeSearch:

Instances of DtEntAltitudeSearch are used to search the echelon entity structure for ANY entities that might be at a certain altitude. 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 DtEntAltitudeSearch:

Public Member Functions
	DtEntAltitudeSearch ()
virtual	~DtEntAltitudeSearch ()
void	setOper (const DtString &)
const DtString &	oper () const
void	setAltitude (double)
double	altitude () 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)
virtual bool	atAltitude (const DtVector &, double alt, const DtString &oper) const
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
double	myAltitude
DtString	myOperator
Protected Attributes inherited from DtSimSubordinateSearch
DtString	myModifier
bool	myAnyFlag
bool	myResult
DtUUID	mySimulationObject
const DtSimulationServices *	mySimulationServices

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

Constructor & Destructor Documentation

DtEntAltitudeSearch::DtEntAltitudeSearch

(

)

default constructor

virtual DtEntAltitudeSearch::~DtEntAltitudeSearch ( )

virtual

destructor

DtEntAltitudeSearch::DtEntAltitudeSearch ( const DtEntAltitudeSearch &  orig )

private

copy constructor; not implemented

Member Function Documentation

void DtEntAltitudeSearch::setOper ( const DtString &  o )

inline

References myOperator.

const DtString & DtEntAltitudeSearch::oper ( ) const

inline

References myOperator.

void DtEntAltitudeSearch::setAltitude ( double  d )

inline

References myAltitude.

double DtEntAltitudeSearch::altitude ( ) const

inline

References myAltitude.

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

protectedvirtual

Function to initialize the search.

Reimplemented from DtSimSubordinateSearch.

virtual bool DtEntAltitudeSearch::inspectEntity ( DtSimObjectReference  entity )

protectedvirtual

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

Reimplemented from DtSimSubordinateSearch.

virtual bool DtEntAltitudeSearch::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 DtEntAltitudeSearch::atAltitude ( const DtVector &  , double  alt, const DtString &  oper  ) const

protectedvirtual

Returns true if the world position given matches the altitude check.

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

private

assignment operator; not implemented

Member Data Documentation

double DtEntAltitudeSearch::myAltitude

protected

Referenced by altitude(), and setAltitude().

DtString DtEntAltitudeSearch::myOperator

protected

Referenced by oper(), and setOper().

---

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

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