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

DtSetAltitudeRequest is used to set the altitude for an entity. More...

Inheritance diagram for DtSetAltitudeRequest:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtSetAltitudeRequest ()
 default constructor
 DtSetAltitudeRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 constructor If you have a request 'put' itself, the writeName will preface it.
 DtSetAltitudeRequest (const DtString &writeName, const DtSetAltitudeRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const DtSetAltitudeRequestoperator= (const DtSetAltitudeRequest &orig)
 assignment operator
virtual ~DtSetAltitudeRequest ()
virtual int type () const
 Returns DtSetAltitudeRequestType.
virtual DtSetDataRequestclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
 Creates a copy of the request.
virtual DtString stringRep () const
 Get a readable string representation of this setDataRequest.
virtual DtReal altitude () const
virtual void setAltitude (DtReal altitude)
virtual int netRepSize () const
 Returns the size of the full network representation (altitude included) padded to an 8-byte boundary.
virtual bool setFromNet (const char *contentBuffer, unsigned contentSize)
 Fills in the request from the network buffer.
virtual bool setToNet ()
 Fills in the network buffer (created by base class setDataRequest) with the set data request contents.

Static Public Member Functions

static DtSetDataRequestcreator ()

Protected Attributes

DtRwReal myAltitude

Detailed Description

DtSetAltitudeRequest is used to set the altitude for an entity.

It is ignored if the vehicle is not an air-going vehicle. It inherits read/writableness from DtSetDataRequest, and includes the altitude (in meters) to use.

set-data-request-type: DtSetAltitudeRequestType

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


Constructor & Destructor Documentation

default constructor

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

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

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

copy constructor


Member Function Documentation

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

assignment operator

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

Returns DtSetAltitudeRequestType.

Implements DtSetDataRequest.

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

Creates a copy of the request.

Implements DtSetDataRequest.

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

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual DtReal DtSetAltitudeRequest::altitude ( ) const [virtual]
virtual void DtSetAltitudeRequest::setAltitude ( DtReal  altitude) [virtual]
virtual int DtSetAltitudeRequest::netRepSize ( ) const [virtual]

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

Reimplemented from DtSetDataRequest.

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

Fills in the request from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetAltitudeRequest::setToNet ( ) [virtual]

Fills in the network buffer (created by base class setDataRequest) with the set data request contents.

Reimplemented from DtSetDataRequest.


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)