DtSurrenderSearch Class Reference

class DtSurrenderSearch: More...

Inheritance diagram for DtSurrenderSearch:

Public Member Functions
	DtSurrenderSearch ()
	default constructor
virtual	~DtSurrenderSearch ()
	destructor
void	setSurrenderTestValue (bool)
bool	surrenderTestValue () const
Public Member Functions inherited from DtSimSubordinateSearch
	DtSimSubordinateSearch ()
	default constructor
virtual	~DtSimSubordinateSearch ()=0
	destructor
bool	search (const DtString &searchName, const DtString &evaluatorObjectName, 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)
	Call searchBelow to search the echelon hierarchy below a given entity.
virtual bool	searchBelow (const DtVrfObjectManager *mgr, int iForce)
	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 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.

Protected Member Functions
virtual bool	initializeSearch (const DtVrfObjectManager *vrfObjectManager)
	Function to initialize the search.
virtual bool	inspectEntity (const DtVrfObject &entity)
	Test any and all entities to find one that is at a certain altitude.
virtual bool	searchSubordinates (const DtVrfObject &pAggEntity)
	Controls whether subordinates of a specified pseudo-aggregate are searched.
virtual bool	isValidEntity (const DtVrfObject &entity)
	Returns true if an aggregate or lifeform (filters platform ents)
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	inspectAggregateEntity (const DtVrfObject &entity)
virtual bool	searchSubtree (const DtVrfObject &entity)
	This function calls one of the inspect functions based on the type of the given entity.

Protected Attributes
bool	mySurrenderTestVal
Protected Attributes inherited from DtSimSubordinateSearch
DtString	myModifier
bool	myAnyFlag
bool	myResult

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

Detailed Description

class DtSurrenderSearch:

Instances of DtSurrenderSearch are used to search the echelon entity structure for ANY entities that might have the given surrendered value. 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

DtSurrenderSearch::DtSurrenderSearch

(

)

default constructor

virtual DtSurrenderSearch::~DtSurrenderSearch ( )

virtual

destructor

DtSurrenderSearch::DtSurrenderSearch ( const DtSurrenderSearch &  orig )

private

copy constructor; not implemented

Member Function Documentation

void DtSurrenderSearch::setSurrenderTestValue ( bool  b )

inline

References mySurrenderTestVal.

bool DtSurrenderSearch::surrenderTestValue ( ) const

inline

References mySurrenderTestVal.

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

protectedvirtual

Function to initialize the search.

Reimplemented from DtSimSubordinateSearch.

virtual bool DtSurrenderSearch::inspectEntity ( const DtVrfObject &  entity )

protectedvirtual

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

Reimplemented from DtSimSubordinateSearch.

virtual bool DtSurrenderSearch::searchSubordinates ( const DtVrfObject &  pAggEntity )

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

protectedvirtual

Returns true if an aggregate or lifeform (filters platform ents)

Reimplemented from DtSimSubordinateSearch.

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

private

assignment operator; not implemented

Member Data Documentation

bool DtSurrenderSearch::mySurrenderTestVal

protected

Referenced by setSurrenderTestValue(), and surrenderTestValue().

---

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

• include/vrfplanmgr/surrenderSrch.h