DtSurrenderSearch Class Reference

class DtSurrenderSearch: More...

Inheritance diagram for DtSurrenderSearch:

List of all members.

Public Member Functions
	DtSurrenderSearch ()
	default constructor
virtual	~DtSurrenderSearch ()
	destructor
void	setSurrenderTestValue (bool)
bool	surrenderTestValue () const
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 Attributes
bool	mySurrenderTestVal
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

)

[protected, virtual]

Function to initialize the search.

Reimplemented from DtSimSubordinateSearch.

virtual bool DtSurrenderSearch::inspectEntity

(

const DtVrfObject &

entity

)

[protected, virtual]

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

Reimplemented from DtSimSubordinateSearch.

virtual bool DtSurrenderSearch::searchSubordinates

(

const DtVrfObject &

pAggEntity

)

[protected, virtual]

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

)

[protected, virtual]

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