makRadarFx::DtOcclusionRequest Class Reference

Detailed Description

This class encapsulates a request for an occlusion test between an observer position and a target position. The test determines if there is an unobstructed line of sight between the two points, taking into account terrain and objects in the simulation. Both the observer and target can be specified as absolute positions, entities in the simulation, or using the current observer's position and view.

#include <rfxOcclusionMessage.h>

Inheritance diagram for makRadarFx::DtOcclusionRequest:

Public Member Functions
	DtOcclusionRequest ()
virtual	~DtOcclusionRequest ()
virtual void	useObserverAsHost ()
virtual void	setOwnshipLocation (DtVector location)
virtual DtVector	ownshipLocation ()
virtual void	setOwnshipEntityId (const std::string &name)
virtual std::string	ownshipEntityId ()
virtual bool	isUsingObserverAsHost ()
virtual bool	isUsingEntityAsHost ()
virtual bool	isUsingAbsoluteLocation ()
virtual void	useObserverForTarget ()
virtual void	setTargetEntityId (const std::string &name)
virtual std::string	targetEntityId ()
virtual void	setTargetLocation (DtVector location)
virtual DtVector	targetLocation ()
virtual bool	isUsingObserverForTarget ()
virtual bool	isUsingEntityForTarget ()
virtual bool	isUsingLocationForTarget ()
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	myUseObserverAsHost
bool	myUseEntityAsHost
bool	myUseAbsoluteOwnship
bool	myUseObserverForTarget
bool	myUseEntityAsTarget
bool	myUseAbsoluteTarget
std::string	myOwnshipName
std::string	myTargetName
DtVector	myOwnshipLocation
DtVector	myTargetLocation
Protected Attributes inherited from makRadarFx::DtBaseMessage
unsigned int	myMessageType
std::string	myRequestorId
int	myRequestId

Constructor & Destructor Documentation

DtOcclusionRequest()

makRadarFx::DtOcclusionRequest::DtOcclusionRequest

(

)

Default constructor.

Initializes a new occlusion request message with default settings

~DtOcclusionRequest()

virtual makRadarFx::DtOcclusionRequest::~DtOcclusionRequest ( )

virtual

Virtual destructor.

Member Function Documentation

useObserverAsHost()

virtual void makRadarFx::DtOcclusionRequest::useObserverAsHost ( )

virtual

calling this function causes the message to use the current observer's position and orientation for the SAR image setup. The client doees not need to set an ownship location or target location if using this method to orient the sensor.

setOwnshipLocation()

virtual void makRadarFx::DtOcclusionRequest::setOwnshipLocation ( DtVector location )

virtual

if the ownship is not hosted in the simulation system, we can explicitly state where we want to perform the elevation test from

ownshipLocation()

virtual DtVector makRadarFx::DtOcclusionRequest::ownshipLocation ( )

virtual

setOwnshipEntityId()

virtual void makRadarFx::DtOcclusionRequest::setOwnshipEntityId ( const std::string & name )

virtual

If the ownship is hosted by the simulation system, we can use its global simulation name to look it up.

ownshipEntityId()

virtual std::string makRadarFx::DtOcclusionRequest::ownshipEntityId ( )

virtual

isUsingObserverAsHost()

virtual bool makRadarFx::DtOcclusionRequest::isUsingObserverAsHost ( )

virtual

functions to determine how to place the sensor

isUsingEntityAsHost()

virtual bool makRadarFx::DtOcclusionRequest::isUsingEntityAsHost ( )

virtual

isUsingAbsoluteLocation()

virtual bool makRadarFx::DtOcclusionRequest::isUsingAbsoluteLocation ( )

virtual

useObserverForTarget()

virtual void makRadarFx::DtOcclusionRequest::useObserverForTarget ( )

virtual

calling this function causes the message to use the current observer's view to determine the target for the SAR image setup.

setTargetEntityId()

virtual void makRadarFx::DtOcclusionRequest::setTargetEntityId ( const std::string & name )

virtual

If the ownship is the target of the sensor, we can use its global simulation name to look it up.

targetEntityId()

virtual std::string makRadarFx::DtOcclusionRequest::targetEntityId ( )

virtual

setTargetLocation()

virtual void makRadarFx::DtOcclusionRequest::setTargetLocation ( DtVector location )

virtual

this is the target that we would like to look at. Location format is latitude/longitude/altitude (in degrees/meters). the altitude of the target location is not required.

targetLocation()

virtual DtVector makRadarFx::DtOcclusionRequest::targetLocation ( )

virtual

isUsingObserverForTarget()

virtual bool makRadarFx::DtOcclusionRequest::isUsingObserverForTarget ( )

virtual

functions to determine how to place the target

isUsingEntityForTarget()

virtual bool makRadarFx::DtOcclusionRequest::isUsingEntityForTarget ( )

virtual

isUsingLocationForTarget()

virtual bool makRadarFx::DtOcclusionRequest::isUsingLocationForTarget ( )

virtual

messageSize()

virtual int makRadarFx::DtOcclusionRequest::messageSize ( )

virtual

size of the message

Reimplemented from makRadarFx::DtBaseMessage.

decode()

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

static

decode a message. Used by the factory

References makRadarFx::DtBaseMessage::DtBaseMessage().

clone()

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

virtual

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

Implements makRadarFx::DtBaseMessage.

References makRadarFx::DtBaseMessage::DtBaseMessage().

serialize()

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

myUseObserverAsHost

bool makRadarFx::DtOcclusionRequest::myUseObserverAsHost

protected

myUseEntityAsHost

bool makRadarFx::DtOcclusionRequest::myUseEntityAsHost

protected

myUseAbsoluteOwnship

bool makRadarFx::DtOcclusionRequest::myUseAbsoluteOwnship

protected

myUseObserverForTarget

bool makRadarFx::DtOcclusionRequest::myUseObserverForTarget

protected

myUseEntityAsTarget

bool makRadarFx::DtOcclusionRequest::myUseEntityAsTarget

protected

myUseAbsoluteTarget

bool makRadarFx::DtOcclusionRequest::myUseAbsoluteTarget

protected

myOwnshipName

std::string makRadarFx::DtOcclusionRequest::myOwnshipName

protected

myTargetName

std::string makRadarFx::DtOcclusionRequest::myTargetName

protected

myOwnshipLocation

DtVector makRadarFx::DtOcclusionRequest::myOwnshipLocation

protected

myTargetLocation

DtVector makRadarFx::DtOcclusionRequest::myTargetLocation

protected

---

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

• include/vrvExtensions/vreRadarFxShared/rfxOcclusionMessage.h