RadarFX API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
makRadarFx::DtEntityLocationResponse Class Reference

DtEntityLocationResponse contains the response from the server with the current list of entities within the simulation. More...

Inheritance diagram for makRadarFx::DtEntityLocationResponse:
Inheritance graph
[legend]

Public Types

enum  DtEntityLocationError { ENTITY_LOC_NO_ERROR, ENTITY_LOC_NO_ENTITY, ENTITY_LOC_ERROR_OTHER }

Public Member Functions

 DtEntityLocationResponse ()
 CTOR/DTOR.
virtual ~DtEntityLocationResponse ()
virtual void setEntityLocation (DtVector location)
 the location of the entity at the time the request was fulfilled.
virtual DtVector entityLocation ()
virtual void setEntityTopoOrientation (DtTaitBryan topoOrientation)
 the topograpic orientation of the entity at the time the request was fulfilled.
virtual DtTaitBryan entityOrientation ()
virtual void setEntityVelocity (DtVector32 velocity)
 the velocity in m/s of the entity at the time the request was fulfilled.
virtual DtVector32 entityVelocity ()
virtual void setError (DtEntityLocationError error)
 Error value if there is one.
virtual DtEntityLocationError error ()
virtual int messageSize ()
 size of the message
virtual DtBaseMessageclone ()
 clone a message. Caller of function is responsible managing this memory
- Public Member Functions inherited from makRadarFx::DtBaseMessage
 DtBaseMessage ()
 CTOR/DTOR.
virtual ~DtBaseMessage ()
virtual unsigned int messageType () const
 Get the name of the message type.
virtual unsigned char * encode ()
 Encode the message as an array of bytes and return the bytes the receiver is responsible for calling delete [] on these bytes.
virtual void setRequestorId (const std::string &requestor)
 Assigns the requestor name of this message.
virtual std::string requestorId ()
virtual void setRequestId (int id)
 Assigns the request id of this message.
virtual int requestId ()

Static Public Member Functions

static DtBaseMessagedecode (unsigned char *buffer, int length)
 decode a message. Used by the factory

Protected Member Functions

virtual void serialize (DtStreamWriter &writer)
virtual void deserialize (DtStreamReader &reader)

Protected Attributes

DtVector myEntityLocation
DtTaitBryan myEntityTopoOrientation
DtVector32 myEntityVelocity
DtEntityLocationError myError
- Protected Attributes inherited from makRadarFx::DtBaseMessage
unsigned int myMessageType
std::string myRequestorId
int myRequestId

Detailed Description

DtEntityLocationResponse contains the response from the server with the current list of entities within the simulation.

Member Enumeration Documentation

Enumerator:
ENTITY_LOC_NO_ERROR 
ENTITY_LOC_NO_ENTITY 
ENTITY_LOC_ERROR_OTHER 

Constructor & Destructor Documentation

makRadarFx::DtEntityLocationResponse::DtEntityLocationResponse ( )

CTOR/DTOR.

virtual makRadarFx::DtEntityLocationResponse::~DtEntityLocationResponse ( )
virtual

Member Function Documentation

virtual void makRadarFx::DtEntityLocationResponse::setEntityLocation ( DtVector  location)
virtual

the location of the entity at the time the request was fulfilled.

virtual DtVector makRadarFx::DtEntityLocationResponse::entityLocation ( )
virtual
virtual void makRadarFx::DtEntityLocationResponse::setEntityTopoOrientation ( DtTaitBryan  topoOrientation)
virtual

the topograpic orientation of the entity at the time the request was fulfilled.

virtual DtTaitBryan makRadarFx::DtEntityLocationResponse::entityOrientation ( )
virtual
virtual void makRadarFx::DtEntityLocationResponse::setEntityVelocity ( DtVector32  velocity)
virtual

the velocity in m/s of the entity at the time the request was fulfilled.

virtual DtVector32 makRadarFx::DtEntityLocationResponse::entityVelocity ( )
virtual
virtual void makRadarFx::DtEntityLocationResponse::setError ( DtEntityLocationError  error)
virtual

Error value if there is one.

virtual DtEntityLocationError makRadarFx::DtEntityLocationResponse::error ( )
virtual
virtual int makRadarFx::DtEntityLocationResponse::messageSize ( )
virtual

size of the message

Reimplemented from makRadarFx::DtBaseMessage.

static DtBaseMessage* makRadarFx::DtEntityLocationResponse::decode ( unsigned char *  buffer,
int  length 
)
static

decode a message. Used by the factory

virtual DtBaseMessage* makRadarFx::DtEntityLocationResponse::clone ( )
virtual

clone a message. Caller of function is responsible managing this memory

Implements makRadarFx::DtBaseMessage.

virtual void makRadarFx::DtEntityLocationResponse::serialize ( DtStreamWriter writer)
protectedvirtual

Reimplemented from makRadarFx::DtBaseMessage.

virtual void makRadarFx::DtEntityLocationResponse::deserialize ( DtStreamReader reader)
protectedvirtual

Reimplemented from makRadarFx::DtBaseMessage.

Member Data Documentation

DtVector makRadarFx::DtEntityLocationResponse::myEntityLocation
protected
DtTaitBryan makRadarFx::DtEntityLocationResponse::myEntityTopoOrientation
protected
DtVector32 makRadarFx::DtEntityLocationResponse::myEntityVelocity
protected
DtEntityLocationError makRadarFx::DtEntityLocationResponse::myError
protected

The documentation for this class was generated from the following file:

Document ID: 1.0
Copyright © 2017 VT MAK Inc. All Rights Reserved (www.mak.com)