makRadarFx::DtOcclusionResponse Class Reference

Detailed Description

This class encapsulates the response to an occlusion test request, providing information about whether there is an unobstructed line of sight between the observer position and the target position. If the line of sight is obstructed, additional information about the obstruction may be included.

#include <rfxOcclusionMessage.h>

Inheritance diagram for makRadarFx::DtOcclusionResponse:

Public Member Functions
	DtOcclusionResponse ()
virtual	~DtOcclusionResponse ()
virtual void	setOcclusion (bool occluded)
virtual bool	occluded ()
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
bool	myOcclusion
Protected Attributes inherited from makRadarFx::DtBaseMessage
unsigned int	myMessageType
std::string	myRequestorId
int	myRequestId

Constructor & Destructor Documentation

DtOcclusionResponse()

makRadarFx::DtOcclusionResponse::DtOcclusionResponse

(

)

Default constructor.

Initializes a new occlusion response message with default settings

~DtOcclusionResponse()

virtual makRadarFx::DtOcclusionResponse::~DtOcclusionResponse ( )

virtual

Virtual destructor.

Member Function Documentation

setOcclusion()

virtual void makRadarFx::DtOcclusionResponse::setOcclusion ( bool occluded )

virtual

Returns whether or not the requesting platform has line of sight of the target location.

References occluded().

occluded()

virtual bool makRadarFx::DtOcclusionResponse::occluded ( )

virtual

Referenced by setOcclusion().

messageSize()

virtual int makRadarFx::DtOcclusionResponse::messageSize ( )

virtual

size of the message

Reimplemented from makRadarFx::DtBaseMessage.

decode()

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

static

decode a message. Used by the factory

References makRadarFx::DtBaseMessage::DtBaseMessage().

clone()

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

virtual

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

Implements makRadarFx::DtBaseMessage.

References makRadarFx::DtBaseMessage::DtBaseMessage().

serialize()

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

protectedvirtual

Serializes the message data to a stream writer.

Parameters

writer

Reference to the stream writer to write the data to

Writes the message data to the provided stream writer. Derived classes should call the base class implementation before adding their own fields.

Reimplemented from makRadarFx::DtBaseMessage.

deserialize()

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

protectedvirtual

Deserializes message data from a stream reader.

Parameters

reader

Reference to the stream reader to read the data from

Reads the message data from the provided stream reader. Derived classes should call the base class implementation before reading their own fields.

Reimplemented from makRadarFx::DtBaseMessage.

Member Data Documentation

myOcclusion

bool makRadarFx::DtOcclusionResponse::myOcclusion

protected

---

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

• include/vrvExtensions/vreRadarFxShared/rfxOcclusionMessage.h