 |
VR-Forces 4.2 Class Documentation
|
|
VR-Forces 4.2 Class Documentation
|
class DtEntHasTargetSearch: More...
Public Member Functions | |
| DtEntHasTargetSearch () | |
| default constructor | |
| virtual | ~DtEntHasTargetSearch () |
| destructor | |
 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. | |
| virtual bool | inspectEntity (const DtVrfObject &entity) |
| Test any and all entities to find one that is destroyed. | |
| 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. | |
Private Member Functions | |
| DtEntHasTargetSearch (const DtEntHasTargetSearch &orig) | |
| copy constructor; not implemented | |
| DtEntHasTargetSearch & | operator= (const DtEntHasTargetSearch &orig) |
| assignment operator; not implemented | |
Additional Inherited Members | |
| Protected Attributes inherited from DtSimSubordinateSearch | |
| DtString | myModifier |
| bool | myAnyFlag |
| bool | myResult |
class DtEntHasTargetSearch:
Instances of DtEntHasTargetSearch are used to search the echelon entity structure for ANY entities that have targets. If any are detected the search is terminated. Call the searchBelow() function to do the actual search. Test the result by calling result().
| DtEntHasTargetSearch::DtEntHasTargetSearch | ( | ) |
default constructor
|
virtual |
destructor
|
private |
copy constructor; not implemented
|
protectedvirtual |
Function to initialize the search.
Reimplemented from DtSimSubordinateSearch.
|
protectedvirtual |
Test any and all entities to find one that is destroyed.
Reimplemented from DtSimSubordinateSearch.
|
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.
|
private |
assignment operator; not implemented