DtEntInAreaSearch Class Reference

Instances of DtEntInAreaSearch are used to search the echelon entity structure for ANY entities inside a given area. More...

Inheritance diagram for DtEntInAreaSearch:

List of all members.

Public Member Functions
	DtEntInAreaSearch ()
	default constructor
	DtEntInAreaSearch (const DtString &areaName)
virtual	~DtEntInAreaSearch ()
	destructor
virtual const DtString &	areaName () const
	Get the area name.
virtual void	setAreaName (const DtString &areaName)
	Set the area name.
void	setWarnedOnce (bool)
bool	warnedOnce () const
Protected Member Functions
virtual bool	initializeSearch (const DtVrfObjectManager *vrfObjectManager)
	Function to initialize the search, it looks up area 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 in the area.
virtual bool	searchSubordinates (const DtVrfObject &pAggEntity)
	Controls whether subordinates of a specified pseudo-aggregate are searched.
Protected Attributes
DtString	myAreaName
	Member variables.
const DtVrfObject *	myControlArea
bool	myWarnedOnce
Private Member Functions
	DtEntInAreaSearch (const DtEntInAreaSearch &orig)
	copy constructor; not implemented
DtEntInAreaSearch &	operator= (const DtEntInAreaSearch &orig)
	assignment operator; not implemented

---

Detailed Description

Instances of DtEntInAreaSearch are used to search the echelon entity structure for ANY entities inside a given area.

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

DtEntInAreaSearch::DtEntInAreaSearch

(

)

default constructor

DtEntInAreaSearch::DtEntInAreaSearch

(

const DtString &

areaName

)

virtual DtEntInAreaSearch::~DtEntInAreaSearch

(

)

[virtual]

destructor

DtEntInAreaSearch::DtEntInAreaSearch

(

const DtEntInAreaSearch &

orig

)

[private]

copy constructor; not implemented

---

Member Function Documentation

virtual const DtString& DtEntInAreaSearch::areaName

(

)

const [virtual]

Get the area name.

virtual void DtEntInAreaSearch::setAreaName

(

const DtString &

areaName

)

[virtual]

Set the area name.

void DtEntInAreaSearch::setWarnedOnce

(

bool

b

)

[inline]

References myWarnedOnce.

bool DtEntInAreaSearch::warnedOnce

(

)

const [inline]

References myWarnedOnce.

virtual bool DtEntInAreaSearch::initializeSearch

(

const DtVrfObjectManager *

vrfObjectManager

)

[protected, virtual]

Function to initialize the search, it looks up area name so that it won't have to do it for each test.

Reimplemented from DtSimSubordinateSearch.

virtual bool DtEntInAreaSearch::inspectEntity

(

const DtVrfObject &

entity

)

[protected, virtual]

Test any and all entities to find one that is in the area.

Reimplemented from DtSimSubordinateSearch.

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

DtEntInAreaSearch& DtEntInAreaSearch::operator=

(

const DtEntInAreaSearch &

orig

)

[private]

assignment operator; not implemented

---

Member Data Documentation

DtString DtEntInAreaSearch::myAreaName [protected]

Member variables.

const DtVrfObject* DtEntInAreaSearch::myControlArea [protected]

bool DtEntInAreaSearch::myWarnedOnce [protected]

Referenced by setWarnedOnce(), and warnedOnce().

---

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

• include/vrfplanmgr/entInAreaSrch.h