VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Attributes
DtFlyAltitudeTask Class Reference

A task to fly at a specified altitude, maintaining whatever the current or commanded heading and speed are. More...

Inheritance diagram for DtFlyAltitudeTask:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtFlyAltitudeTask ()
 default constructor
 DtFlyAltitudeTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 constructor
 DtFlyAltitudeTask (const DtString &writeName, const DtFlyAltitudeTask &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const DtFlyAltitudeTaskoperator= (const DtFlyAltitudeTask &orig)
 assignment operator
virtual ~DtFlyAltitudeTask ()
virtual int type () const
virtual DtSimTaskclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
 Make a copy of this task.
virtual DtString stringRep () const
 Get a readable string representation of this task.
virtual int netRepSize () const
 Returns the size of the full network representation (control object name included) padded to an 8-byte boundary.
virtual bool setFromNet (const char *contentBuffer, unsigned contentSize)
 Fills in the task from the network buffer.
virtual bool setToNet ()
 Fills in the network buffer (created by base class simTask) with the task contents.
virtual double altitude () const
 The altitude to fly at.
virtual void setAltitude (double altitude)
 The altitude to fly at.
virtual double climbDescentRate () const
 Climb / Descent rate used to reach the desired altitude.
virtual void setClimbDescentRate (double rate)
 Climb / Descent rate used to reach the desired altitude.

Static Public Member Functions

static DtSimTaskcreator ()
static double theDefaultClimbDescentRate ()

Protected Attributes

DtRwReal myAltitude
DtRwReal myClimbDescentRate

Detailed Description

A task to fly at a specified altitude, maintaining whatever the current or commanded heading and speed are.


Constructor & Destructor Documentation

default constructor

DtFlyAltitudeTask::DtFlyAltitudeTask ( const DtString writeName,
DtReaderWriterRegistry parentRegistry = 0 
)

constructor

DtFlyAltitudeTask::DtFlyAltitudeTask ( const DtString writeName,
const DtFlyAltitudeTask orig,
DtReaderWriterRegistry parentRegistry = 0 
)

copy constructor


Member Function Documentation

const DtFlyAltitudeTask& DtFlyAltitudeTask::operator= ( const DtFlyAltitudeTask orig)

assignment operator

virtual int DtFlyAltitudeTask::type ( ) const [virtual]
Returns:
DtFlyAltitudeTaskType

Implements DtSimTask.

virtual DtSimTask* DtFlyAltitudeTask::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
) const [virtual]

Make a copy of this task.

Returns a newly allocated instance of a DtSimTask. Override this member function to return a pointer to a newly allocated instance of the derived class.

Implements DtSimTask.

virtual DtString DtFlyAltitudeTask::stringRep ( ) const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

virtual double DtFlyAltitudeTask::altitude ( ) const [virtual]

The altitude to fly at.

virtual void DtFlyAltitudeTask::setAltitude ( double  altitude) [virtual]

The altitude to fly at.

virtual double DtFlyAltitudeTask::climbDescentRate ( ) const [virtual]

Climb / Descent rate used to reach the desired altitude.

Specified in meters / second.

Note:
Will always be positive.
virtual void DtFlyAltitudeTask::setClimbDescentRate ( double  rate) [virtual]

Climb / Descent rate used to reach the desired altitude.

Specified in meters / second.

Note:
Will always be positive.
virtual int DtFlyAltitudeTask::netRepSize ( ) const [virtual]

Returns the size of the full network representation (control object name included) padded to an 8-byte boundary.

Reimplemented from DtSimTask.

virtual bool DtFlyAltitudeTask::setFromNet ( const char *  contentBuffer,
unsigned  contentSize 
) [virtual]

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtFlyAltitudeTask::setToNet ( ) [virtual]

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSimTask.

static DtSimTask* DtFlyAltitudeTask::creator ( ) [static]
Returns:
The default value used for climb/descent rate in meters / second which is 1000 ft / min (in meters/second)

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)