VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtEntAltitudeSearch Class Reference

class DtEntAltitudeSearch: More...

Inheritance diagram for DtEntAltitudeSearch:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtEntAltitudeSearch ()
 default constructor
virtual ~DtEntAltitudeSearch ()
 destructor
void setOper (const DtString &)
const DtStringoper () const
void setAltitude (double)
double altitude () const

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 at a certain altitude.
virtual bool searchSubordinates (const DtVrfObject &pAggEntity)
 Controls whether subordinates of a specified pseudo-aggregate are searched.
virtual bool atAltitude (const DtVector &, double alt, const DtString &oper) const
 Returns true if the world position given matches the altitude check.

Protected Attributes

double myAltitude
DtString myOperator

Private Member Functions

 DtEntAltitudeSearch (const DtEntAltitudeSearch &orig)
 copy constructor; not implemented
DtEntAltitudeSearchoperator= (const DtEntAltitudeSearch &orig)
 assignment operator; not implemented

Detailed Description

class DtEntAltitudeSearch:

Instances of DtEntAltitudeSearch are used to search the echelon entity structure for ANY entities that might be at a certain altitude. 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

default constructor

destructor

copy constructor; not implemented


Member Function Documentation

void DtEntAltitudeSearch::setOper ( const DtString o) [inline]

References myOperator.

const DtString & DtEntAltitudeSearch::oper ( ) const [inline]

References myOperator.

void DtEntAltitudeSearch::setAltitude ( double  d) [inline]

References myAltitude.

double DtEntAltitudeSearch::altitude ( ) const [inline]

References myAltitude.

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

Function to initialize the search.

Reimplemented from DtSimSubordinateSearch.

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

Test any and all entities to find one that is at a certain altitude.

Reimplemented from DtSimSubordinateSearch.

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

Reimplemented from DtSimSubordinateSearch.

virtual bool DtEntAltitudeSearch::atAltitude ( const DtVector ,
double  alt,
const DtString oper 
) const [protected, virtual]

Returns true if the world position given matches the altitude check.

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

assignment operator; not implemented


Member Data Documentation

double DtEntAltitudeSearch::myAltitude [protected]

Referenced by altitude(), and setAltitude().

Referenced by oper(), and setOper().


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)