Detailed Description

This message contains the response to an entity location request, providing the current position, orientation, and velocity of the requested entity. If the entity cannot be found, an error code will be set.

#include <rfxEntityLocationMessage.h>

Inheritance diagram for makRadarFx::DtEntityLocationResponse:

[legend]

Public Types
enum	DtEntityLocationError { ENTITY_LOC_NO_ERROR , ENTITY_LOC_NO_ENTITY , ENTITY_LOC_ERROR_OTHER }

Public Member Functions
	DtEntityLocationResponse ()

virtual	~DtEntityLocationResponse ()

virtual void	setEntityLocation (DtVector location)

virtual DtVector	entityLocation ()

virtual void	setEntityTopoOrientation (DtTaitBryan topoOrientation)

virtual DtTaitBryan	entityOrientation ()

virtual void	setEntityVelocity (DtVector32 velocity)

virtual DtVector32	entityVelocity ()

virtual void	setError (DtEntityLocationError error)

virtual DtEntityLocationError	error ()

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
DtVector	myEntityLocation

DtTaitBryan	myEntityTopoOrientation

DtVector32	myEntityVelocity

DtEntityLocationError	myError

Protected Attributes inherited from makRadarFx::DtBaseMessage
unsigned int	myMessageType

std::string	myRequestorId

int	myRequestId

Member Enumeration Documentation

◆ DtEntityLocationError

enum makRadarFx::DtEntityLocationResponse::DtEntityLocationError

Error codes for entity location responses.

Enumerator
ENTITY_LOC_NO_ERROR	No error, location information is valid.
ENTITY_LOC_NO_ENTITY	Entity not found in the simulation.
ENTITY_LOC_ERROR_OTHER	Other unspecified error.

Constructor & Destructor Documentation

◆ DtEntityLocationResponse()

makRadarFx::DtEntityLocationResponse::DtEntityLocationResponse ( )

Default constructor.

Initializes a new entity location response message with default values

◆ ~DtEntityLocationResponse()

virtual makRadarFx::DtEntityLocationResponse::~DtEntityLocationResponse ( )

virtual

Virtual destructor.

Member Function Documentation

◆ setEntityLocation()

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

virtual

Sets the entity's position.

Parameters

location Vector containing the entity's position (latitude, longitude, altitude)

Sets the location of the entity at the time the request was fulfilled. Position is in geodetic coordinates (latitude, longitude, altitude).

◆ entityLocation()

virtual DtVector makRadarFx::DtEntityLocationResponse::entityLocation ( )

virtual

Gets the entity's position.

Returns: Vector containing the entity's position (latitude, longitude, altitude)

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

◆ setEntityTopoOrientation()

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

virtual

Sets the entity's orientation.

Parameters

topoOrientation Tait-Bryan angles representing the entity's orientation

Sets the topographic orientation of the entity at the time the request was fulfilled. Orientation is expressed as Tait-Bryan angles (heading, pitch, roll).

◆ entityOrientation()

virtual DtTaitBryan makRadarFx::DtEntityLocationResponse::entityOrientation ( )

virtual

Gets the entity's orientation.

Returns: Tait-Bryan angles representing the entity's orientation

Returns the topographic orientation of the entity at the time the request was fulfilled.

◆ setEntityVelocity()

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

virtual

Sets the entity's velocity.

Parameters

velocity Vector containing the entity's velocity components in m/s

Sets the velocity vector of the entity at the time the request was fulfilled. Velocity is in meters per second along each axis.

◆ entityVelocity()

virtual DtVector32 makRadarFx::DtEntityLocationResponse::entityVelocity ( )

virtual

Gets the entity's velocity.

Returns: Vector containing the entity's velocity components in m/s

Returns the velocity vector of the entity at the time the request was fulfilled.

◆ setError()

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

virtual

Sets the error code.

Parameters

error The error code to set

Sets the error status for this entity location response. Use ENTITY_LOC_NO_ERROR if the location information is valid.

References error().

◆ error()

virtual DtEntityLocationError makRadarFx::DtEntityLocationResponse::error ( )

virtual

Gets the error code.

Returns: The current error code

Returns the error status for this entity location response.

Referenced by setError().

◆ messageSize()

virtual int makRadarFx::DtEntityLocationResponse::messageSize ( )

virtual

size of the message

Reimplemented from makRadarFx::DtBaseMessage.

◆ decode()

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

static

decode a message. Used by the factory

References makRadarFx::DtBaseMessage::DtBaseMessage().

◆ clone()

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

virtual

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

Implements makRadarFx::DtBaseMessage.

References makRadarFx::DtBaseMessage::DtBaseMessage().

◆ serialize()

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

◆ myEntityLocation

DtVector makRadarFx::DtEntityLocationResponse::myEntityLocation

protected

Entity's position in geodetic coordinates.

◆ myEntityTopoOrientation

DtTaitBryan makRadarFx::DtEntityLocationResponse::myEntityTopoOrientation

protected

Entity's orientation as Tait-Bryan angles.

◆ myEntityVelocity

DtVector32 makRadarFx::DtEntityLocationResponse::myEntityVelocity

protected

Entity's velocity vector in m/s.

◆ myError

DtEntityLocationError makRadarFx::DtEntityLocationResponse::myError

protected

Error code for this response.

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

include/vrvExtensions/vreRadarFxShared/rfxEntityLocationMessage.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Enumeration Documentation

◆ DtEntityLocationError

Constructor & Destructor Documentation

◆ DtEntityLocationResponse()

◆ ~DtEntityLocationResponse()

Member Function Documentation

◆ setEntityLocation()

◆ entityLocation()

◆ setEntityTopoOrientation()

◆ entityOrientation()

◆ setEntityVelocity()

◆ entityVelocity()

◆ setError()

◆ error()

◆ messageSize()

◆ decode()

◆ clone()

◆ serialize()

◆ deserialize()

Member Data Documentation

◆ myEntityLocation

◆ myEntityTopoOrientation

◆ myEntityVelocity

◆ myError