DtEntHasTargetSearch Class Reference

class DtEntHasTargetSearch: More...

Inheritance diagram for DtEntHasTargetSearch:

List of all members.

Public Member Functions
	DtEntHasTargetSearch ()
	default constructor
virtual	~DtEntHasTargetSearch ()
	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
	DtEntHasTargetSearch (const DtEntHasTargetSearch &orig)
	copy constructor; not implemented
DtEntHasTargetSearch &	operator= (const DtEntHasTargetSearch &orig)
	assignment operator; not implemented

---

Detailed Description

class DtEntHasTargetSearch:

Instances of DtEntHasTargetSearch are used to search the echelon entity structure for ANY entities that have targets. 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

DtEntHasTargetSearch::DtEntHasTargetSearch

(

)

default constructor

virtual DtEntHasTargetSearch::~DtEntHasTargetSearch

(

)

[virtual]

destructor

DtEntHasTargetSearch::DtEntHasTargetSearch

(

const DtEntHasTargetSearch &

orig

)

[private]

copy constructor; not implemented

---

Member Function Documentation

virtual bool DtEntHasTargetSearch::initializeSearch

(

const DtVrfObjectManager *

vrfObjectManager

)

[protected, virtual]

Function to initialize the search.

Reimplemented from DtSimSubordinateSearch.

virtual bool DtEntHasTargetSearch::inspectEntity

(

const DtVrfObject &

entity

)

[protected, virtual]

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

Reimplemented from DtSimSubordinateSearch.

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

DtEntHasTargetSearch& DtEntHasTargetSearch::operator=

(

const DtEntHasTargetSearch &

orig

)

[private]

assignment operator; not implemented

---

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

• include/vrfplanmgr/entHasTargetSearch.h