Instances of DtEntLeftOfLineSearch are used to search the echelon entity structure for ANY entities left of a given phase line. More...

Inheritance diagram for DtEntLeftOfLineSearch:

Public Member Functions
	DtEntLeftOfLineSearch ()
	default constructor
	DtEntLeftOfLineSearch (const DtString &lineName)
virtual	~DtEntLeftOfLineSearch ()
	destructor
virtual const DtString &	lineName () const
	Get the phase line name.
virtual void	setLineName (const DtString &lineName)
	Set the phase line name.
Protected Member Functions
virtual bool	initializeSearch (const DtVrfObjectManager *vrfObjectManager)
	Function to initialize the search, it looks up the phase line 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 left of the line.
virtual bool	searchSubordinates (const DtVrfObject &pAggEntity)
	Controls whether subordinates of a specified pseudo-aggregate are searched.
Protected Attributes
DtString	myLineName
	Member variables.
const DtVrfObject *	myPhaseLine
Private Member Functions
	DtEntLeftOfLineSearch (const DtEntLeftOfLineSearch &orig)
	copy constructor; not implemented
DtEntLeftOfLineSearch &	operator= (const DtEntLeftOfLineSearch &orig)
	assignment operator; not implemented

Detailed Description

Instances of DtEntLeftOfLineSearch are used to search the echelon entity structure for ANY entities left of a given phase line.

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

DtEntLeftOfLineSearch::DtEntLeftOfLineSearch ( )

default constructor

DtEntLeftOfLineSearch::DtEntLeftOfLineSearch ( const DtString & lineName )

virtual DtEntLeftOfLineSearch::~DtEntLeftOfLineSearch ( ) [virtual]

destructor

DtEntLeftOfLineSearch::DtEntLeftOfLineSearch ( const DtEntLeftOfLineSearch & orig ) [private]

copy constructor; not implemented

virtual const DtString& DtEntLeftOfLineSearch::lineName ( ) const [virtual]

Get the phase line name.

virtual void DtEntLeftOfLineSearch::setLineName ( const DtString & lineName ) [virtual]

Set the phase line name.

virtual bool DtEntLeftOfLineSearch::initializeSearch ( const DtVrfObjectManager * vrfObjectManager ) [protected, virtual]

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

virtual bool DtEntLeftOfLineSearch::inspectEntity ( const DtVrfObject & entity ) [protected, virtual]

Test any and all entities to find one that is left of the line.

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

DtEntLeftOfLineSearch& DtEntLeftOfLineSearch::operator= ( const DtEntLeftOfLineSearch & orig ) [private]

assignment operator; not implemented

Member variables.

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