MySearch Class Reference

Inheritance diagram for MySearch:

Public Member Functions
	MySearch ()
virtual	~MySearch ()
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 DtVrfObject &entity)
	Override initializeSearch if you need to do some initialization at the start of the search process.
virtual bool	inspectEntity (const DtVrfObject &entity)
	Override inspectEntity to do any tests you want to do on base entities that are found in the search.
virtual bool	searchSubordinates (const DtVrfObject &pAggEntity)
	SearchSubordinates will call searchSubtree on all the immediate children of a given pseudo aggregate.
	MySearch (const MySearch &orig)
MySearch &	operator= (const MySearch &orig)
Protected Member Functions inherited from DtSimSubordinateSearch
virtual bool	initializeSearch (const DtVrfObjectManager *vrfObjectManager)
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.

Additional Inherited Members
Protected Attributes inherited from DtSimSubordinateSearch
DtString	myModifier
bool	myAnyFlag
bool	myResult

Constructor & Destructor Documentation

MySearch::MySearch

(

)

virtual MySearch::~MySearch ( )

virtual

MySearch::MySearch ( const MySearch &  orig )

protected

Member Function Documentation

virtual bool MySearch::initializeSearch ( const DtVrfObject &  entity )

protectedvirtual

Override initializeSearch if you need to do some initialization at the start of the search process.

It will only be called once per search before any of the inspect functions are called, and if this function returns false, then the search is canceled. By default it returns true.

Reimplemented from DtSimSubordinateSearch.

virtual bool MySearch::inspectEntity ( const DtVrfObject &  entity )

protectedvirtual

Override inspectEntity to do any tests you want to do on base entities that are found in the search.

It should return true only if it has found what it is looking for and wants to terminate the search early. By default it simply returns false. It is usually called either because a non-local entity has been found and the default version of inspectRemoteEntity was called, or because a local entity was found and the default version of inspectLocalEntity was called.

Reimplemented from DtSimSubordinateSearch.

virtual bool MySearch::searchSubordinates ( const DtVrfObject &  entity )

protectedvirtual

SearchSubordinates will call searchSubtree on all the immediate children of a given pseudo aggregate.

Reimplemented from DtSimSubordinateSearch.

MySearch& MySearch::operator= ( const MySearch &  orig )

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/examples/addConditional/addConditionalSim/search.h