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

DtMoveToAltitudeTask represents a MoveToAlt task for an entity to perform. More...

Inheritance diagram for DtMoveToAltitudeTask:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtMoveToAltitudeTask ()
 default constructor
 DtMoveToAltitudeTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 constructor If you have a task 'put' itself, the writeName will preface the task.
 DtMoveToAltitudeTask (const DtString &writeName, const DtMoveToAltitudeTask &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const DtMoveToAltitudeTaskoperator= (const DtMoveToAltitudeTask &orig)
 assignment operator
virtual ~DtMoveToAltitudeTask ()
virtual int type () const
 Returns DtMoveToAltitudeType.
virtual DtSimTaskclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
 Creates a copy of this move-to task.
virtual DtString stringRep () const
 Get a readable string representation of this task.
virtual DtReal altitude () const
virtual void setAltitude (DtReal altitude)
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.

Static Public Member Functions

static DtSimTaskcreator ()

Protected Attributes

DtRwReal myAltitude

Detailed Description

DtMoveToAltitudeTask represents a MoveToAlt task for an entity to perform.

It inherits read/writableness from SimTask, and includes the altitude to move to.

DtMoveToAltitudeTask is used to move the entity to the desired altitude. It is ignored if the vehicle is not an air-going vehicle.

task-type: DtMoveToAltType

parameters: altitude - Altitude for the entity (in meters). It is the height above the terrain in local coordinates.


Constructor & Destructor Documentation

default constructor

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

constructor If you have a task 'put' itself, the writeName will preface the task.

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

copy constructor


Member Function Documentation

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

assignment operator

virtual int DtMoveToAltitudeTask::type ( ) const [virtual]

Returns DtMoveToAltitudeType.

Implements DtSimTask.

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

Creates a copy of this move-to task.

Implements DtSimTask.

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

Get a readable string representation of this task.

Implements DtSimTask.

virtual DtReal DtMoveToAltitudeTask::altitude ( ) const [virtual]
virtual void DtMoveToAltitudeTask::setAltitude ( DtReal  altitude) [virtual]
virtual int DtMoveToAltitudeTask::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 DtMoveToAltitudeTask::setFromNet ( const char *  contentBuffer,
unsigned  contentSize 
) [virtual]

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtMoveToAltitudeTask::setToNet ( ) [virtual]

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

Reimplemented from DtSimTask.


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)