makRadarFx::DtEntityLocationRequest Class Reference

Detailed Description

This message requests the current location, orientation, and velocity for a specific entity identified by its entity ID. The server will respond with the requested information or an error if the entity cannot be found.

#include <rfxEntityLocationMessage.h>

Inheritance diagram for makRadarFx::DtEntityLocationRequest:

Public Member Functions
	DtEntityLocationRequest ()
virtual	~DtEntityLocationRequest ()
virtual void	setEntityId (const std::string &name)
virtual std::string	entityId ()
virtual int	messageSize ()
virtual DtBaseMessage *	clone ()
Public Member Functions inherited from makRadarFx::DtBaseMessage
	DtBaseMessage ()
virtual	~DtBaseMessage ()
virtual unsigned int	messageType () const
virtual unsigned char *	encode ()
virtual void	setRequestorId (const std::string &requestor)
virtual std::string	requestorId ()
virtual void	setRequestId (int id)
virtual int	requestId ()

Static Public Member Functions
static DtBaseMessage *	decode (unsigned char *buffer, int length)

Protected Member Functions
virtual void	serialize (DtStreamWriter &writer)
virtual void	deserialize (DtStreamReader &reader)

Protected Attributes
std::string	myEntityId
Protected Attributes inherited from makRadarFx::DtBaseMessage
unsigned int	myMessageType
std::string	myRequestorId
int	myRequestId

Constructor & Destructor Documentation

DtEntityLocationRequest()

makRadarFx::DtEntityLocationRequest::DtEntityLocationRequest

(

)

Default constructor.

Initializes a new entity location request message with an empty entity ID

~DtEntityLocationRequest()

virtual makRadarFx::DtEntityLocationRequest::~DtEntityLocationRequest ( )

virtual

Virtual destructor.

Member Function Documentation

setEntityId()

virtual void makRadarFx::DtEntityLocationRequest::setEntityId ( const std::string & name )

virtual

Sets the entity ID to query.

Parameters

name	String identifier of the entity to look up

Sets the identifier of the entity that this request is querying the location, orientation, and velocity of.

entityId()

virtual std::string makRadarFx::DtEntityLocationRequest::entityId ( )

virtual

Gets the entity ID being queried.

Returns

String identifier of the entity

Returns the identifier of the entity that this request is querying.

messageSize()

virtual int makRadarFx::DtEntityLocationRequest::messageSize ( )

virtual

size of the message

Reimplemented from makRadarFx::DtBaseMessage.

decode()

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

static

decode a message. Used by the factory

References makRadarFx::DtBaseMessage::DtBaseMessage().

clone()

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

virtual

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

Implements makRadarFx::DtBaseMessage.

References makRadarFx::DtBaseMessage::DtBaseMessage().

serialize()

virtual void makRadarFx::DtEntityLocationRequest::serialize ( DtStreamWriter & writer )

protectedvirtual

Serializes the message data to a stream writer.

Parameters

writer

Reference to the stream writer to write the data to

Reimplemented from makRadarFx::DtBaseMessage.

deserialize()

virtual void makRadarFx::DtEntityLocationRequest::deserialize ( DtStreamReader & reader )

protectedvirtual

Deserializes message data from a stream reader.

Parameters

reader

Reference to the stream reader to read the data from

Reimplemented from makRadarFx::DtBaseMessage.

Member Data Documentation

myEntityId

std::string makRadarFx::DtEntityLocationRequest::myEntityId

protected

Entity identifier to query.

---

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

• include/vrvExtensions/vreRadarFxShared/rfxEntityLocationMessage.h