DtEntUnderFireSearch Class Reference

class DtEntUnderFireSearch: More...

Inheritance diagram for DtEntUnderFireSearch:

List of all members.

Public Member Functions
	DtEntUnderFireSearch ()
	default constructor
virtual	~DtEntUnderFireSearch ()
	destructor
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 destroyed.
virtual bool	searchSubordinates (const DtVrfObject &pAggEntity)
	Controls whether subordinates of a specified pseudo-aggregate are searched.
Private Member Functions
	DtEntUnderFireSearch (const DtEntUnderFireSearch &orig)
	copy constructor; not implemented
DtEntUnderFireSearch &	operator= (const DtEntUnderFireSearch &orig)
	assignment operator; not implemented

---

Detailed Description

class DtEntUnderFireSearch:

Instances of DtEntUnderFireSearch are used to search the echelon entity structure for ANY entities that are under fire. 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

DtEntUnderFireSearch::DtEntUnderFireSearch

(

)

default constructor

virtual DtEntUnderFireSearch::~DtEntUnderFireSearch

(

)

[virtual]

destructor

DtEntUnderFireSearch::DtEntUnderFireSearch

(

const DtEntUnderFireSearch &

orig

)

[private]

copy constructor; not implemented

---

Member Function Documentation

virtual bool DtEntUnderFireSearch::initializeSearch

(

const DtVrfObjectManager *

vrfObjectManager

)

[protected, virtual]

Function to initialize the search.

Reimplemented from DtSimSubordinateSearch.

virtual bool DtEntUnderFireSearch::inspectEntity

(

const DtVrfObject &

entity

)

[protected, virtual]

Test any and all entities to find one that is destroyed.

Reimplemented from DtSimSubordinateSearch.

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

DtEntUnderFireSearch& DtEntUnderFireSearch::operator=

(

const DtEntUnderFireSearch &

orig

)

[private]

assignment operator; not implemented

---

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

• include/vrfplanmgr/entUnderFireSearch.h