 |
VR-Forces 4.10 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.10 Class Documentation
|
class DtEntUnderFireSearch: More...
Public Member Functions | |
| DtEntUnderFireSearch () | |
| default constructor More... | |
| virtual | ~DtEntUnderFireSearch () |
| destructor More... | |
 Public Member Functions inherited from DtSimSubordinateSearch | |
| DtSimSubordinateSearch () | |
| default constructor More... | |
| virtual | ~DtSimSubordinateSearch ()=0 |
| destructor More... | |
| bool | search (const DtUUID &search, const DtUUID &evaluator, DtSimManager *simManager) |
| If the first field of the modifier is "PATTERN" or "SELF", this function will parse out any additional arguments for those searches. More... | |
| virtual const DtString & | modifier () const |
| Get the test modifier string. More... | |
| virtual void | setModifier (const DtString &modifier) |
| Set the test modifier. More... | |
| virtual bool | searchBelow (const DtVrfObject &entity, bool excludeDestroyed) |
| Call searchBelow to search the echelon hierarchy below a given entity. More... | |
| virtual bool | searchBelow (const DtVrfObjectManager *mgr, int iForce, bool excludeDestroyed) |
| This call will take an object manager and a force type over which to check the subtree against entities of that type. More... | |
| virtual bool | result () |
| Result function: returns true if it found a matching entity. More... | |
| virtual bool | isTopLevelEntity (const DtString &entity) const |
| Returns true if entity supplied is a top level entity. More... | |
| virtual bool | isValidEntity (const DtVrfObject &entity) |
| Returns true if the object is an aggregate, a platform, or a lifeform or cultural feature. More... | |
| 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. More... | |
| virtual const DtUUID & | simulationObject () const |
| The object that satisfied the search. More... | |
Protected Member Functions | |
| virtual bool | initializeSearch (const DtVrfObjectManager *vrfObjectManager) |
| Function to initialize the search. More... | |
| virtual bool | inspectEntity (const DtVrfObject &entity) |
| Test any and all entities to find one that is destroyed. More... | |
| virtual bool | searchSubordinates (const DtVrfObject &pAggEntity, bool excludeDestroyed) |
| Controls whether subordinates of a specified pseudo-aggregate are searched. More... | |
| 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. More... | |
| virtual bool | inspectTopLevelEntity (const DtVrfObject &entity, bool excludeDestroyed) |
| virtual bool | inspectAggregateEntity (const DtVrfObject &entity, bool excludeDestroyed) |
| virtual bool | searchSubtree (const DtVrfObject &entity, bool excludeDestroyed) |
| This function calls one of the inspect functions based on the type of the given entity. More... | |
Private Member Functions | |
| DtEntUnderFireSearch (const DtEntUnderFireSearch &orig) | |
| copy constructor; not implemented More... | |
| DtEntUnderFireSearch & | operator= (const DtEntUnderFireSearch &orig) |
| assignment operator; not implemented More... | |
Additional Inherited Members | |
| Protected Attributes inherited from DtSimSubordinateSearch | |
| DtString | myModifier |
| bool | myAnyFlag |
| bool | myResult |
| DtUUID | mySimulationObject |
class DtEntUnderFireSearch:
Instances of DtEntUnderFireSearch are used to search the echelon entity structure for ANY entities that are under fire. If any are detected the search is terminated. Call the searchBelow() function to do the actual search. Test the result by calling result().
| DtEntUnderFireSearch::DtEntUnderFireSearch | ( | ) |
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