DtEntLeftOfLineSearch Class Reference

Instances of DtEntLeftOfLineSearch are used to search the echelon entity structure for ANY entities left of a given phase line. More...

Inheritance diagram for DtEntLeftOfLineSearch:

Public Member Functions
	DtEntLeftOfLineSearch ()
	default constructor
	DtEntLeftOfLineSearch (const DtUUID &)
virtual	~DtEntLeftOfLineSearch ()
	destructor
virtual const DtUUID &	line () const
	Get the phase line.
virtual void	setLine (const DtUUID &)
	Set the phase line.
Public Member Functions inherited from DtSimSubordinateSearch
	DtSimSubordinateSearch ()
	default constructor
virtual	~DtSimSubordinateSearch ()=0
	destructor
bool	search (const DtUUID &search, const DtUUID &evaluator, DtSimManager *simManager)
	If the first field of the modifier is "PATTERN" or "SELF", this function will parse out any additional arguments for those searches.
virtual const DtString &	modifier () const
	Get the test modifier string.
virtual void	setModifier (const DtString &modifier)
	Set the test modifier.
virtual bool	searchBelow (const DtVrfObject &entity, bool excludeDestroyed)
	Call searchBelow to search the echelon hierarchy below a given entity.
virtual bool	searchBelow (const DtVrfObjectManager *mgr, int iForce, bool excludeDestroyed)
	This call will take an object manager and a force type over which to check the subtree against entities of that type.
virtual bool	result ()
	Result function: returns true if it found a matching entity.
virtual bool	isTopLevelEntity (const DtString &entity) const
	Returns true if entity supplied is a top level entity.
virtual bool	isValidEntity (const DtVrfObject &entity)
	Returns true if the object is an aggregate, a platform, or a lifeform or cultural feature.
virtual int	forceType (const DtString &entity) const
	Returns the force type of the entity based on the name pattern (1 Force, 2 Force, etc.) If name does not follow pattern, returns -1.
virtual const DtUUID &	simulationObject () const
	The object that satisfied the search.

Protected Member Functions
virtual bool	initializeSearch (const DtVrfObjectManager *vrfObjectManager)
	Function to initialize the search, it looks up the phase line name so that it won't have to do it for each test.
virtual bool	inspectEntity (const DtVrfObject &entity)
	Test any and all entities to find one that is left of the line.
virtual bool	searchSubordinates (const DtVrfObject &pAggEntity, bool excludeDestroyed)
	Controls whether subordinates of a specified pseudo-aggregate are searched.
Protected Member Functions inherited from DtSimSubordinateSearch
virtual bool	initializeSearch (const DtVrfObject &entity)
	Override initializeSearch if you need to do some initialization at the start of the search process.
bool	inspectTopLevelEntity (const DtVrfObject &entity, bool excludeDestroyed)
bool	inspectAggregateEntity (const DtVrfObject &entity, bool excludeDestroyed)
virtual bool	searchSubtree (const DtVrfObject &entity, bool excludeDestroyed)
	This function calls one of the inspect functions based on the type of the given entity.

Protected Attributes
DtUUID	myLine
	Member variables.
DtSharedVrfObjectReference	myPhaseLine
bool	myWarnedOnce
Protected Attributes inherited from DtSimSubordinateSearch
DtString	myModifier
bool	myAnyFlag
bool	myResult
DtUUID	mySimulationObject

Private Member Functions
	DtEntLeftOfLineSearch (const DtEntLeftOfLineSearch &orig)
	copy constructor; not implemented
DtEntLeftOfLineSearch &	operator= (const DtEntLeftOfLineSearch &orig)
	assignment operator; not implemented

Detailed Description

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().

Constructor & Destructor Documentation

DtEntLeftOfLineSearch::DtEntLeftOfLineSearch

(

)

default constructor

DtEntLeftOfLineSearch::DtEntLeftOfLineSearch

(

const DtUUID &

)

virtual DtEntLeftOfLineSearch::~DtEntLeftOfLineSearch ( )

virtual

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

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

protectedvirtual

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 ( const DtVrfObject &  entity )

protectedvirtual

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

Reimplemented from DtSimSubordinateSearch.

virtual bool DtEntLeftOfLineSearch::searchSubordinates ( const DtVrfObject &  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.

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

private

assignment operator; not implemented

Member Data Documentation

DtUUID DtEntLeftOfLineSearch::myLine

protected

Member variables.

DtSharedVrfObjectReference DtEntLeftOfLineSearch::myPhaseLine

protected

bool DtEntLeftOfLineSearch::myWarnedOnce

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfplanmgr/entLeftOfLineSearch.h