MySearch Class Reference

Inheritance diagram for MySearch:

Public Member Functions
	MySearch ()
virtual	~MySearch ()
Public Member Functions inherited from DtSimSubordinateSearch
	DtSimSubordinateSearch ()
virtual	~DtSimSubordinateSearch ()=0
bool	search (const DtUUID &search, DtLocalObject *owner, const DtSimulationServices *)
virtual const DtString &	modifier () const
virtual void	setModifier (const DtString &modifier)
virtual bool	searchBelow (DtSimObjectReference entity, bool excludeDestroyed)
virtual bool	searchBelow (DtLocalObject *entity, DtSimObjectReference targetOfCheck, bool excludeDestroyed)
virtual bool	searchBelow (int iForce, bool excludeDestroyed)
virtual bool	result ()
virtual bool	isTopLevelEntity (const DtString &entity) const
virtual bool	isValidEntity (DtSimObjectReference entity)
virtual int	forceType (const DtString &entity) const
virtual const DtUUID &	simulationObject () const

Protected Member Functions
virtual bool	initializeSearch (DtSimObjectReference entity)
virtual bool	inspectEntity (DtSimObjectReference entity)
virtual bool	searchSubordinates (DtSimObjectReference pAggEntity, bool excludeDestroyed)
	MySearch (const MySearch &orig)
MySearch &	operator= (const MySearch &orig)
Protected Member Functions inherited from DtSimSubordinateSearch
virtual bool	initializeSearch (const DtSimulationServices *vrfObjectManager)
virtual bool	isForSelfOnly () const
virtual bool	inspectEntity (DtLocalObject *entity, DtSimObjectReference targetOfCheck)
virtual bool	inspectTopLevelEntity (DtSimObjectReference entity, bool excludeDestroyed)
virtual bool	inspectAggregateEntity (DtSimObjectReference entity, bool excludeDestroyed)
virtual bool	searchSubtree (DtSimObjectReference entity, bool excludeDestroyed)
virtual bool	searchSubtree (DtLocalObject *entity, DtSimObjectReference targetOfCheck, bool excludeDestroyed)

Additional Inherited Members
Protected Attributes inherited from DtSimSubordinateSearch
DtString	myModifier
bool	myAnyFlag
bool	myResult
DtUUID	mySimulationObject
const DtSimulationServices *	mySimulationServices

Constructor & Destructor Documentation

MySearch::MySearch

(

)

virtual MySearch::~MySearch ( )

virtual

MySearch::MySearch ( const MySearch &  orig )

protected

Member Function Documentation

virtual bool MySearch::initializeSearch ( DtSimObjectReference  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 ( DtSimObjectReference  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 ( DtSimObjectReference  entity, bool  excludeDestroyed  )

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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/examples/addConditional/addConditionalSim/search.h