VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Attributes
DtRetreatController Class Reference
Inheritance diagram for DtRetreatController:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtRetreatController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=NULL, DtReaderWriterRegistry *parentRegistry=0)
virtual ~DtRetreatController ()
 DtRetreatController (const DtRetreatController &orig)
DtRetreatControlleroperator= (const DtRetreatController &orig)
virtual DtString type () const
 Returns a string identifies the class type of component.
virtual void registerTaskMsgCallbacks ()
virtual void processRetreatTask (DtSimMessage *msg)
virtual void processUserTask (DtSimMessage *msg)
virtual void tick ()
 This gives the thread of control to the component.
virtual double getHeading ()
virtual double fuelLeft () const

Static Public Member Functions

static void retreatTaskCallback (DtSimMessage *msg, void *usr)
static void userTaskCallback (DtSimMessage *msg, void *usr)
static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc, DtReaderWriterRegistry *parentRegistry)

Protected Attributes

DtReal myCurrentHeading
bool myHoldGround

Constructor & Destructor Documentation

DtRetreatController::DtRetreatController ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = NULL,
DtReaderWriterRegistry parentRegistry = 0 
)

Member Function Documentation

DtRetreatController& DtRetreatController::operator= ( const DtRetreatController orig)
virtual DtString DtRetreatController::type ( ) const [virtual]

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Returns:
DtGroundAutoMovementControllerType

Reimplemented from DtGroundAutoControllerComponent.

Reimplemented from DtTaskControllerComponent.

static void DtRetreatController::retreatTaskCallback ( DtSimMessage msg,
void *  usr 
) [static]
static void DtRetreatController::userTaskCallback ( DtSimMessage msg,
void *  usr 
) [static]
virtual void DtRetreatController::processRetreatTask ( DtSimMessage msg) [virtual]
virtual void DtRetreatController::processUserTask ( DtSimMessage msg) [virtual]
virtual void DtRetreatController::tick ( ) [virtual]

This gives the thread of control to the component.

The component is ticked once each simulation from by the component list it's on. This base class tick has no functionality.

Reimplemented from DtSimComponent.

static DtSimComponent* DtRetreatController::creator ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc,
DtReaderWriterRegistry parentRegistry 
) [static]
virtual double DtRetreatController::getHeading ( ) [virtual]
virtual double DtRetreatController::fuelLeft ( ) const [virtual]

Member Data Documentation


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)