makRadarFx::DtEntityListResponse Class Reference

Detailed Description

This message contains the response to an entity list request, providing descriptive information about all entities currently present in the simulation. If there are no entities, the list will be empty.

#include <rfxEntityListMessage.h>

Inheritance diagram for makRadarFx::DtEntityListResponse:

Public Member Functions
	DtEntityListResponse ()
virtual	~DtEntityListResponse ()
virtual void	setEntityList (std::vector< DtEntityDescription > entities)
virtual std::vector< DtEntityDescription >	entityList ()
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::vector< DtEntityDescription >	myEntities
Protected Attributes inherited from makRadarFx::DtBaseMessage
unsigned int	myMessageType
std::string	myRequestorId
int	myRequestId

Constructor & Destructor Documentation

DtEntityListResponse()

makRadarFx::DtEntityListResponse::DtEntityListResponse

(

)

Default constructor.

Initializes a new entity list response message with an empty entity list

~DtEntityListResponse()

virtual makRadarFx::DtEntityListResponse::~DtEntityListResponse ( )

virtual

Virtual destructor.

Member Function Documentation

setEntityList()

virtual void makRadarFx::DtEntityListResponse::setEntityList ( std::vector< DtEntityDescription > entities )

virtual

Sets the list of entities.

Parameters

entities

Vector of entity descriptions to set

Sets the list of all entities currently in the simulation. This list will be empty if there are no entities within the simulation.

entityList()

virtual std::vector< DtEntityDescription > makRadarFx::DtEntityListResponse::entityList ( )

virtual

Gets the list of entities.

Returns

Vector of entity descriptions

Returns the list of all entities currently in the simulation. This list will be empty if there are no entities within the simulation.

messageSize()

virtual int makRadarFx::DtEntityListResponse::messageSize ( )

virtual

size of the message

Reimplemented from makRadarFx::DtBaseMessage.

decode()

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

static

decode a message. Used by the factory

References makRadarFx::DtBaseMessage::DtBaseMessage().

clone()

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

virtual

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

Implements makRadarFx::DtBaseMessage.

References makRadarFx::DtBaseMessage::DtBaseMessage().

serialize()

virtual void makRadarFx::DtEntityListResponse::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::DtEntityListResponse::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

myEntities

std::vector<DtEntityDescription> makRadarFx::DtEntityListResponse::myEntities

protected

List of entity descriptions in the simulation.

---

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

• include/vrvExtensions/vreRadarFxShared/rfxEntityListMessage.h