DtEntLeftOfLineSearch Class Reference

Instances of DtEntLeftOfLineSearch are used to search the echelon entity structure for ANY entities left of a given phase line. 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 DtEntLeftOfLineSearch:

Public Member Functions
	DtEntLeftOfLineSearch ()
	DtEntLeftOfLineSearch (const DtUUID &)
virtual	~DtEntLeftOfLineSearch () override
virtual const DtUUID &	line () const
virtual void	setLine (const DtUUID &)
void	setWarnedOnce (bool b)
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	myLine
DtSimObjectReference	myPhaseLine
bool	myWarnedOnce
DtTacticalGraphicSimObjectFacade	myTacticalGraphicSimObjectFacade
Protected Attributes inherited from DtSimSubordinateSearch
DtString	myModifier
bool	myAnyFlag
bool	myResult
DtUUID	mySimulationObject
const DtSimulationServices *	mySimulationServices

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

Constructor & Destructor Documentation

DtEntLeftOfLineSearch::DtEntLeftOfLineSearch

(

)

default constructor

DtEntLeftOfLineSearch::DtEntLeftOfLineSearch

(

const DtUUID &

)

virtual DtEntLeftOfLineSearch::~DtEntLeftOfLineSearch ( )

overridevirtual

destructor

DtEntLeftOfLineSearch::DtEntLeftOfLineSearch ( const DtEntLeftOfLineSearch &  orig )

private

copy constructor; not implemented

Member Function Documentation

virtual const DtUUID& DtEntLeftOfLineSearch::line ( ) const

virtual

Get the phase line. Was: lineName.

virtual void DtEntLeftOfLineSearch::setLine ( const DtUUID &  )

virtual

Set the phase line. Was: setLineName.

void DtEntLeftOfLineSearch::setWarnedOnce ( bool  b )

inline

bool DtEntLeftOfLineSearch::warnedOnce ( ) const

inline

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

overrideprotectedvirtual

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

Reimplemented from DtSimSubordinateSearch.

virtual bool DtEntLeftOfLineSearch::inspectEntity ( DtSimObjectReference  entity )

overrideprotectedvirtual

Test any and all entities to find one that is left of the line.

Reimplemented from DtSimSubordinateSearch.

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

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

private

assignment operator; not implemented

Member Data Documentation

DtUUID DtEntLeftOfLineSearch::myLine

protected

Member variables.

DtSimObjectReference DtEntLeftOfLineSearch::myPhaseLine

protected

bool DtEntLeftOfLineSearch::myWarnedOnce

protected

DtTacticalGraphicSimObjectFacade DtEntLeftOfLineSearch::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/entLeftOfLineSearch.h