DtEntEmbarkationStateChangedSearch Class Reference

class DtEntEmbarkationStateChangedSearch: More...

Inheritance diagram for DtEntEmbarkationStateChangedSearch:

List of all members.

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

---

Detailed Description

class DtEntEmbarkationStateChangedSearch:

Instances of DtEntEmbarkationStateChangedSearch are used to search the echelon entity structure for ANY entities that have been embarked/disembarked. 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

DtEntEmbarkationStateChangedSearch::DtEntEmbarkationStateChangedSearch

(

)

default constructor

virtual DtEntEmbarkationStateChangedSearch::~DtEntEmbarkationStateChangedSearch

(

)

[virtual]

destructor

DtEntEmbarkationStateChangedSearch::DtEntEmbarkationStateChangedSearch

(

const DtEntEmbarkationStateChangedSearch &

orig

)

[private]

copy constructor; not implemented

---

Member Function Documentation

void DtEntEmbarkationStateChangedSearch::setEmbarkedOn

(

const DtString &

s

)

[inline]

References myEmbarkedOn.

const DtString & DtEntEmbarkationStateChangedSearch::embarkedOn

(

)

const [inline]

References myEmbarkedOn.

virtual bool DtEntEmbarkationStateChangedSearch::initializeSearch

(

const DtVrfObjectManager *

vrfObjectManager

)

[protected, virtual]

Function to initialize the search.

Reimplemented from DtSimSubordinateSearch.

virtual bool DtEntEmbarkationStateChangedSearch::inspectEntity

(

const DtVrfObject &

entity

)

[protected, virtual]

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

Reimplemented from DtSimSubordinateSearch.

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

DtEntEmbarkationStateChangedSearch& DtEntEmbarkationStateChangedSearch::operator=

(

const DtEntEmbarkationStateChangedSearch &

orig

)

[private]

assignment operator; not implemented

---

Member Data Documentation

DtString DtEntEmbarkationStateChangedSearch::myEmbarkedOn [protected]

Referenced by embarkedOn(), and setEmbarkedOn().

---

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

• include/vrfplanmgr/entEmbarkedSearch.h