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:

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
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 bool	isValidEntity (const DtVrfObject &entity)
	Returns true if the object is an aggregate, a platform, or a lifeform or cultural feature.
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, 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 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
DtString	myAreaName
	Member variables.
const DtVrfObject *	myControlArea
bool	myWarnedOnce
Protected Attributes inherited from DtSimSubordinateSearch
DtString	myModifier
bool	myAnyFlag
bool	myResult

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 )

protectedvirtual

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 )

protectedvirtual

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

Reimplemented from DtSimSubordinateSearch.

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

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfplanmgr/entInAreaSrch.h