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

DtSetSpeedRequest is used to set the speed for an entity. More...

Inheritance diagram for DtSetSpeedRequest:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtSetSpeedRequest ()
 default constructor
 DtSetSpeedRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 constructor If you have a request 'put' itself, the writeName will preface it.
 DtSetSpeedRequest (const DtString &writeName, const DtSetSpeedRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const DtSetSpeedRequestoperator= (const DtSetSpeedRequest &orig)
 assignment operator
virtual ~DtSetSpeedRequest ()
virtual int type () const
 Returns DtSetSpeedRequestType.
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 speed () const
 In meters/second.
virtual void setSpeed (DtReal speed)
virtual int netRepSize () const
 Returns the size of the full network representation 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 DtSetDataRequestcreator ()

Protected Attributes

DtRwReal mySpeed

Detailed Description

DtSetSpeedRequest is used to set the speed for an entity.

It inherits read/writableness from DtSetDataRequest, and includes the speed (in m/s) to use.

set-data-request-type: DtSetSpeedRequestType

parameters: speed - Speed in meters per second.


Constructor & Destructor Documentation

default constructor

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

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

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

copy constructor


Member Function Documentation

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

assignment operator

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

Returns DtSetSpeedRequestType.

Implements DtSetDataRequest.

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

Creates a copy of the request.

Implements DtSetDataRequest.

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

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual DtReal DtSetSpeedRequest::speed ( ) const [virtual]

In meters/second.

virtual void DtSetSpeedRequest::setSpeed ( DtReal  speed) [virtual]
virtual int DtSetSpeedRequest::netRepSize ( ) const [virtual]

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSetDataRequest.

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

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetSpeedRequest::setToNet ( ) [virtual]

Fills in the network buffer (created by base class simTask) with the task 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)