Detailed Description

This message requests the elevation at a specific target location using sensors on a specified platform or from the ownship location. The request supports multiple methods of specifying both the sensor position (ownship) and the target position, including using the observer's current view, specifying an entity by ID, or using absolute coordinates. If line of sight is not available from the sensing platform to the target location, the corresponding response will contain an error.

#include <rfxElevationMessage.h>

Inheritance diagram for makRadarFx::DtElevationRequest:

[legend]

Public Member Functions
	DtElevationRequest ()

virtual	~DtElevationRequest ()

virtual void	useObserverAsHost ()

virtual void	setOwnshipLocation (DtVector location)

virtual DtVector	ownshipLocation ()

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

virtual std::string	ownshipEntityId ()

virtual void	useObserverForTarget ()

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

virtual std::string	targetEntityId ()

virtual void	setTargetLocation (DtVector location)

virtual DtVector	targetLocation ()

virtual int	messageSize ()

virtual DtBaseMessage *	clone ()

Sensor Placement Mode Queries
Methods to determine how the sensor is being positioned
virtual bool	isUsingObserverAsHost ()

virtual bool	isUsingEntityAsHost ()

virtual bool	isUsingAbsoluteLocation ()

Target Placement Mode Queries
Methods to determine how the target is being positioned
virtual bool	isUsingObserverForTarget ()

virtual bool	isUsingEntityForTarget ()

virtual bool	isUsingLocationForTarget ()

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

◆ DtElevationRequest()

makRadarFx::DtElevationRequest::DtElevationRequest ( )

Default constructor.

Initializes a new elevation request message with default settings

◆ ~DtElevationRequest()

virtual makRadarFx::DtElevationRequest::~DtElevationRequest ( )

virtual

Virtual destructor.

Member Function Documentation

◆ useObserverAsHost()

virtual void makRadarFx::DtElevationRequest::useObserverAsHost ( )

virtual

Uses the current observer's position for the sensor location.

When called, this function configures the request to use the current observer's position and orientation for the sensor placement. The client does not need to set an ownship location if using this method to position the sensor.

◆ setOwnshipLocation()

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

virtual

Sets an absolute position for the sensor location.

Parameters

location Vector containing the sensor position (latitude, longitude, altitude)

If the ownship is not hosted in the simulation system, this method allows explicit specification of the sensor position for the elevation test.

◆ ownshipLocation()

virtual DtVector makRadarFx::DtElevationRequest::ownshipLocation ( )

virtual

Gets the absolute sensor position.

Returns: Vector containing the sensor position (latitude, longitude, altitude)

Returns the currently set absolute sensor position

◆ setOwnshipEntityId()

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

virtual

Sets an entity ID to use for the sensor position.

Parameters

name	String identifier of the entity to use as the sensor platform

If the sensor platform is hosted by the simulation system, this method allows specification of the entity by its global simulation name or ID.

◆ ownshipEntityId()

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

virtual

Gets the entity ID used for the sensor position.

Returns: String identifier of the entity used as the sensor platform

◆ isUsingObserverAsHost()

virtual bool makRadarFx::DtElevationRequest::isUsingObserverAsHost ( )

virtual

Checks if using the observer position for the sensor.

Returns: True if the observer is being used as the sensor host

◆ isUsingEntityAsHost()

virtual bool makRadarFx::DtElevationRequest::isUsingEntityAsHost ( )

virtual

Checks if using an entity as the sensor platform.

Returns: True if an entity ID is being used for the sensor host

◆ isUsingAbsoluteLocation()

virtual bool makRadarFx::DtElevationRequest::isUsingAbsoluteLocation ( )

virtual

Checks if using an absolute position for the sensor.

Returns: True if absolute coordinates are being used for the sensor position

◆ useObserverForTarget()

virtual void makRadarFx::DtElevationRequest::useObserverForTarget ( )

virtual

Uses the current observer's view direction for the target position.

When called, this function configures the request to use the current observer's view direction to determine the target position for the elevation query.

◆ setTargetEntityId()

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

virtual

Sets an entity ID to use for the target position.

Parameters

name	String identifier of the entity to use as the target

Specifies an entity by its global simulation name or ID to use as the target location for the elevation query.

◆ targetEntityId()

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

virtual

Gets the entity ID used for the target position.

Returns: String identifier of the entity used as the target

◆ setTargetLocation()

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

virtual

Sets an absolute position for the target location.

Parameters

location Vector containing the target position (latitude, longitude, altitude)

Specifies the absolute coordinates of the target location for the elevation query. Location format is latitude/longitude/altitude (in degrees/meters). The altitude component is not required and will be determined by the query.

◆ targetLocation()

virtual DtVector makRadarFx::DtElevationRequest::targetLocation ( )

virtual

Gets the absolute target position.

Returns: Vector containing the target position (latitude, longitude, altitude)

◆ isUsingObserverForTarget()

virtual bool makRadarFx::DtElevationRequest::isUsingObserverForTarget ( )

virtual

Checks if using the observer view for the target position.

Returns: True if the observer view is being used to determine the target

◆ isUsingEntityForTarget()

virtual bool makRadarFx::DtElevationRequest::isUsingEntityForTarget ( )

virtual

Checks if using an entity as the target.

Returns: True if an entity ID is being used for the target

◆ isUsingLocationForTarget()

virtual bool makRadarFx::DtElevationRequest::isUsingLocationForTarget ( )

virtual

Checks if using an absolute position for the target.

Returns: True if absolute coordinates are being used for the target position

◆ messageSize()

virtual int makRadarFx::DtElevationRequest::messageSize ( )

virtual

size of the message

Reimplemented from makRadarFx::DtBaseMessage.

◆ decode()

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

static

decode a message. Used by the factory

References makRadarFx::DtBaseMessage::DtBaseMessage().

◆ clone()

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

virtual

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

Implements makRadarFx::DtBaseMessage.

References makRadarFx::DtBaseMessage::DtBaseMessage().

◆ serialize()

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

◆ myUseObserverAsHost

bool makRadarFx::DtElevationRequest::myUseObserverAsHost

protected

Flag indicating if using observer as the sensor host.

◆ myUseEntityAsHost

bool makRadarFx::DtElevationRequest::myUseEntityAsHost

protected

Flag indicating if using an entity as the sensor host.

◆ myUseAbsoluteOwnship

bool makRadarFx::DtElevationRequest::myUseAbsoluteOwnship

protected

Flag indicating if using absolute coordinates for the sensor position.

◆ myUseObserverForTarget

bool makRadarFx::DtElevationRequest::myUseObserverForTarget

protected

Flag indicating if using observer view for the target.

◆ myUseEntityAsTarget

bool makRadarFx::DtElevationRequest::myUseEntityAsTarget

protected

Flag indicating if using an entity as the target.

◆ myUseAbsoluteTarget

bool makRadarFx::DtElevationRequest::myUseAbsoluteTarget

protected

Flag indicating if using absolute coordinates for the target position.

◆ myOwnshipName

std::string makRadarFx::DtElevationRequest::myOwnshipName

protected

Name/ID of the entity to use as the sensor host.

◆ myTargetName

std::string makRadarFx::DtElevationRequest::myTargetName

protected

Name/ID of the entity to use as the target.

◆ myOwnshipLocation

DtVector makRadarFx::DtElevationRequest::myOwnshipLocation

protected

Absolute coordinates for the sensor position.

◆ myTargetLocation

DtVector makRadarFx::DtElevationRequest::myTargetLocation

protected

Absolute coordinates for the target position.

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

include/vrvExtensions/vreRadarFxShared/rfxElevationMessage.h

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ DtElevationRequest()

◆ ~DtElevationRequest()

Member Function Documentation

◆ useObserverAsHost()

◆ setOwnshipLocation()

◆ ownshipLocation()

◆ setOwnshipEntityId()

◆ ownshipEntityId()

◆ isUsingObserverAsHost()

◆ isUsingEntityAsHost()

◆ isUsingAbsoluteLocation()

◆ useObserverForTarget()

◆ setTargetEntityId()

◆ targetEntityId()

◆ setTargetLocation()

◆ targetLocation()

◆ isUsingObserverForTarget()

◆ isUsingEntityForTarget()

◆ isUsingLocationForTarget()

◆ messageSize()

◆ decode()

◆ clone()

◆ serialize()

◆ deserialize()

Member Data Documentation

◆ myUseObserverAsHost

◆ myUseEntityAsHost

◆ myUseAbsoluteOwnship

◆ myUseObserverForTarget

◆ myUseEntityAsTarget

◆ myUseAbsoluteTarget

◆ myOwnshipName

◆ myTargetName

◆ myOwnshipLocation

◆ myTargetLocation