Detailed Description

This class encapsulates a request for a Millimeter Wave radar image from the RadarFX server. It contains parameters that specify the sensor platform position, target location, radar system settings, and image format settings. MMW radar provides high-resolution imagery with material penetration capabilities, making it useful for detection of objects through certain obscurants.

#include <rfxMmwMessage.h>

Inheritance diagram for makRadarFx::DtMmwRequest:

[legend]

Public Member Functions
	DtMmwRequest ()

virtual	~DtMmwRequest ()

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 void	setRadarOffsetLocation (DtVector offset)

virtual DtVector	radarOffsetLocation ()

virtual void	setRadarOffsetOrientation (DtTaitBryan offsetOrientation)

virtual DtTaitBryan	radarOffsetOrientation ()

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

virtual std::string	radarSystemName ()

virtual void	setIsAgcPowerEnabled (bool isAgcPowerEnabled)

virtual bool	isAgcPowerEnabled () const

virtual void	setPower (float power)

virtual float	power ()

virtual void	setImageSize (const DtImageSize &size)

virtual DtImageSize	imageSize ()

virtual void	setImageFormat (DtImageFormat format)

virtual DtImageFormat	imageFormat ()

virtual void	setImageDataType (DtImageDataType type)

virtual DtImageDataType	imageDataType ()

virtual void	setImageRotation (DtImageRotation rotate)

virtual DtImageRotation	imageRotation ()

virtual void	setImageReturnMethod (unsigned int returnFlags)

virtual unsigned int	imageReturnMethod ()

virtual void	setImageSavePath (const std::string &filename)

virtual std::string	imageSavePath ()

virtual void	setImageFilename (const std::string &filename)

virtual std::string	imageFilename ()

virtual void	setRestoreState (bool restoreState)

virtual bool	restoreState ()

virtual void	setEnableSky (bool enableSky)

virtual bool	enableSky ()

virtual int	messageSize ()

virtual DtBaseMessage *	clone ()

Public Member Functions inherited from makRadarFx::DtImageRequest
	DtImageRequest ()

virtual	~DtImageRequest ()

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

bool	myEnableSky

bool	myIsAgcPowerEnabled

std::string	myOwnshipName

std::string	myTargetName

DtVector	myOwnshipLocation

DtVector	myTargetLocation

DtVector	myRadarOffsetLocation

DtTaitBryan	myRadarOffsetOrientation

std::string	myRadarName

float	myPower

DtImageSize	myImageSize

DtImageFormat	myImageFormat

DtImageDataType	myImageDataType

DtImageRotation	myImageRotation

unsigned int	myReturnMethod

bool	myRestoreState

std::string	myImageSavePath

std::string	myImageFilename

Protected Attributes inherited from makRadarFx::DtBaseMessage
unsigned int	myMessageType

std::string	myRequestorId

int	myRequestId

Constructor & Destructor Documentation

◆ DtMmwRequest()

makRadarFx::DtMmwRequest::DtMmwRequest ( )

Default constructor.

Initializes a new MMW image request message with default settings

◆ ~DtMmwRequest()

virtual makRadarFx::DtMmwRequest::~DtMmwRequest ( )

virtual

Virtual destructor.

Member Function Documentation

◆ useObserverAsHost()

virtual void makRadarFx::DtMmwRequest::useObserverAsHost ( )

virtual

calling this function causes the message to use the current observer's position and orientation for the MMW 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::DtMmwRequest::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::DtMmwRequest::ownshipLocation ( )

virtual

◆ setOwnshipEntityId()

virtual void makRadarFx::DtMmwRequest::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::DtMmwRequest::ownshipEntityId ( )

virtual

◆ isUsingObserverAsHost()

virtual bool makRadarFx::DtMmwRequest::isUsingObserverAsHost ( )

virtual

functions to determine how to place the sensor

◆ isUsingEntityAsHost()

virtual bool makRadarFx::DtMmwRequest::isUsingEntityAsHost ( )

virtual

◆ isUsingAbsoluteLocation()

virtual bool makRadarFx::DtMmwRequest::isUsingAbsoluteLocation ( )

virtual

◆ useObserverForTarget()

virtual void makRadarFx::DtMmwRequest::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::DtMmwRequest::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::DtMmwRequest::targetEntityId ( )

virtual

◆ setTargetLocation()

virtual void makRadarFx::DtMmwRequest::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::DtMmwRequest::targetLocation ( )

virtual

◆ isUsingObserverForTarget()

virtual bool makRadarFx::DtMmwRequest::isUsingObserverForTarget ( )

virtual

functions to determine how to place the target

◆ isUsingEntityForTarget()

virtual bool makRadarFx::DtMmwRequest::isUsingEntityForTarget ( )

virtual

◆ isUsingLocationForTarget()

virtual bool makRadarFx::DtMmwRequest::isUsingLocationForTarget ( )

virtual

◆ setRadarOffsetLocation()

virtual void makRadarFx::DtMmwRequest::setRadarOffsetLocation ( DtVector offset )

virtual

the offset location of the sensor on the hosting entity. Only valid when a hosting entity is defined

◆ radarOffsetLocation()

virtual DtVector makRadarFx::DtMmwRequest::radarOffsetLocation ( )

virtual

◆ setRadarOffsetOrientation()

virtual void makRadarFx::DtMmwRequest::setRadarOffsetOrientation ( DtTaitBryan offsetOrientation )

virtual

the offset orientation of the sensor from the hosting entite's orientation. Only valid when a hosting entity is defined

◆ radarOffsetOrientation()

virtual DtTaitBryan makRadarFx::DtMmwRequest::radarOffsetOrientation ( )

virtual

◆ setRadarSystemName()

virtual void makRadarFx::DtMmwRequest::setRadarSystemName ( const std::string & name )

virtual

The name of the sensor system to use. This must match one of the sensors that the RadarFX server has configured.

◆ radarSystemName()

virtual std::string makRadarFx::DtMmwRequest::radarSystemName ( )

virtual

◆ setIsAgcPowerEnabled()

virtual void makRadarFx::DtMmwRequest::setIsAgcPowerEnabled ( bool isAgcPowerEnabled )

virtual

Whether or not to use AGC for Power.

References isAgcPowerEnabled().

◆ isAgcPowerEnabled()

virtual bool makRadarFx::DtMmwRequest::isAgcPowerEnabled ( ) const

virtual

Referenced by setIsAgcPowerEnabled().

◆ setPower()

virtual void makRadarFx::DtMmwRequest::setPower ( float power )

virtual

Radar system power setting in Watts.

References power().

◆ power()

virtual float makRadarFx::DtMmwRequest::power ( )

virtual

Referenced by setPower().

◆ setImageSize()

virtual void makRadarFx::DtMmwRequest::setImageSize ( const DtImageSize & size )

virtual

Requested image pixel size. This may not be the returned size due to image rotation.

◆ imageSize()

virtual DtImageSize makRadarFx::DtMmwRequest::imageSize ( )

virtual

◆ setImageFormat()

virtual void makRadarFx::DtMmwRequest::setImageFormat ( DtImageFormat format )

virtual

Requested format of the returned image data.

◆ imageFormat()

virtual DtImageFormat makRadarFx::DtMmwRequest::imageFormat ( )

virtual

◆ setImageDataType()

virtual void makRadarFx::DtMmwRequest::setImageDataType ( DtImageDataType type )

virtual

Requested data type of the returned image data. Only available for RAW/NITF image types.

◆ imageDataType()

virtual DtImageDataType makRadarFx::DtMmwRequest::imageDataType ( )

virtual

◆ setImageRotation()

virtual void makRadarFx::DtMmwRequest::setImageRotation ( DtImageRotation rotate )

virtual

Requested rotation of the image.

◆ imageRotation()

virtual DtImageRotation makRadarFx::DtMmwRequest::imageRotation ( )

virtual

◆ setImageReturnMethod()

virtual void makRadarFx::DtMmwRequest::setImageReturnMethod ( unsigned int returnFlags )

virtual

Bitfield for image data return types.

◆ imageReturnMethod()

virtual unsigned int makRadarFx::DtMmwRequest::imageReturnMethod ( )

virtual

◆ setImageSavePath()

virtual void makRadarFx::DtMmwRequest::setImageSavePath ( const std::string & filename )

virtual

Requested path for image if it is to be saved by the server If the path does not exist, the server will attempt to create it.

◆ imageSavePath()

virtual std::string makRadarFx::DtMmwRequest::imageSavePath ( )

virtual

◆ setImageFilename()

virtual void makRadarFx::DtMmwRequest::setImageFilename ( const std::string & filename )

virtual

Requested filename for image if it is to be saved by the server If this is not set, then the date/timestamp will be used as the filename if this is set, then the filename will be used plus a date/time stamp and the extension will be determined automatically.

◆ imageFilename()

virtual std::string makRadarFx::DtMmwRequest::imageFilename ( )

virtual

◆ setRestoreState()

virtual void makRadarFx::DtMmwRequest::setRestoreState ( bool restoreState )

virtual

Lets the server know that it should restore the display/window/observer state after an image capture process is completed.

References restoreState().

◆ restoreState()

virtual bool makRadarFx::DtMmwRequest::restoreState ( )

virtual

Referenced by setRestoreState().

◆ setEnableSky()

virtual void makRadarFx::DtMmwRequest::setEnableSky ( bool enableSky )

virtual

lets the server know if it should render the sky or not with this request.

References enableSky().

◆ enableSky()

virtual bool makRadarFx::DtMmwRequest::enableSky ( )

virtual

Referenced by setEnableSky().

◆ messageSize()

virtual int makRadarFx::DtMmwRequest::messageSize ( )

virtual

size of the message

Reimplemented from makRadarFx::DtBaseMessage.

◆ decode()

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

static

decode a message. Used by the factory

◆ clone()

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

virtual

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

Implements makRadarFx::DtBaseMessage.

◆ serialize()

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

protected

◆ myUseEntityAsHost

bool makRadarFx::DtMmwRequest::myUseEntityAsHost

protected

◆ myUseAbsoluteOwnship

bool makRadarFx::DtMmwRequest::myUseAbsoluteOwnship

protected

◆ myUseObserverForTarget

bool makRadarFx::DtMmwRequest::myUseObserverForTarget

protected

◆ myUseEntityAsTarget

bool makRadarFx::DtMmwRequest::myUseEntityAsTarget

protected

◆ myUseAbsoluteTarget

bool makRadarFx::DtMmwRequest::myUseAbsoluteTarget

protected

◆ myEnableSky

bool makRadarFx::DtMmwRequest::myEnableSky

protected

◆ myIsAgcPowerEnabled

bool makRadarFx::DtMmwRequest::myIsAgcPowerEnabled

protected

◆ myOwnshipName

std::string makRadarFx::DtMmwRequest::myOwnshipName

protected

◆ myTargetName

std::string makRadarFx::DtMmwRequest::myTargetName

protected

◆ myOwnshipLocation

DtVector makRadarFx::DtMmwRequest::myOwnshipLocation

protected

◆ myTargetLocation

DtVector makRadarFx::DtMmwRequest::myTargetLocation

protected

◆ myRadarOffsetLocation

DtVector makRadarFx::DtMmwRequest::myRadarOffsetLocation

protected

◆ myRadarOffsetOrientation

DtTaitBryan makRadarFx::DtMmwRequest::myRadarOffsetOrientation

protected

◆ myRadarName

std::string makRadarFx::DtMmwRequest::myRadarName

protected

◆ myPower

float makRadarFx::DtMmwRequest::myPower

protected

◆ myImageSize

DtImageSize makRadarFx::DtMmwRequest::myImageSize

protected

◆ myImageFormat

DtImageFormat makRadarFx::DtMmwRequest::myImageFormat

protected

◆ myImageDataType

DtImageDataType makRadarFx::DtMmwRequest::myImageDataType

protected

◆ myImageRotation

DtImageRotation makRadarFx::DtMmwRequest::myImageRotation

protected

◆ myReturnMethod

unsigned int makRadarFx::DtMmwRequest::myReturnMethod

protected

◆ myRestoreState

bool makRadarFx::DtMmwRequest::myRestoreState

protected

◆ myImageSavePath

std::string makRadarFx::DtMmwRequest::myImageSavePath

protected

◆ myImageFilename

std::string makRadarFx::DtMmwRequest::myImageFilename

protected

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

include/vrvExtensions/vreRadarFxShared/rfxMmwMessage.h

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ DtMmwRequest()

◆ ~DtMmwRequest()

Member Function Documentation

◆ useObserverAsHost()

◆ setOwnshipLocation()

◆ ownshipLocation()

◆ setOwnshipEntityId()

◆ ownshipEntityId()

◆ isUsingObserverAsHost()

◆ isUsingEntityAsHost()

◆ isUsingAbsoluteLocation()

◆ useObserverForTarget()

◆ setTargetEntityId()

◆ targetEntityId()

◆ setTargetLocation()

◆ targetLocation()

◆ isUsingObserverForTarget()

◆ isUsingEntityForTarget()

◆ isUsingLocationForTarget()

◆ setRadarOffsetLocation()

◆ radarOffsetLocation()

◆ setRadarOffsetOrientation()

◆ radarOffsetOrientation()

◆ setRadarSystemName()

◆ radarSystemName()

◆ setIsAgcPowerEnabled()

◆ isAgcPowerEnabled()

◆ setPower()

◆ power()

◆ setImageSize()

◆ imageSize()

◆ setImageFormat()

◆ imageFormat()

◆ setImageDataType()

◆ imageDataType()

◆ setImageRotation()

◆ imageRotation()

◆ setImageReturnMethod()

◆ imageReturnMethod()

◆ setImageSavePath()

◆ imageSavePath()

◆ setImageFilename()

◆ imageFilename()

◆ setRestoreState()

◆ restoreState()

◆ setEnableSky()

◆ enableSky()

◆ messageSize()

◆ decode()

◆ clone()

◆ serialize()

◆ deserialize()

Member Data Documentation

◆ myUseObserverAsHost

◆ myUseEntityAsHost

◆ myUseAbsoluteOwnship

◆ myUseObserverForTarget

◆ myUseEntityAsTarget

◆ myUseAbsoluteTarget

◆ myEnableSky

◆ myIsAgcPowerEnabled

◆ myOwnshipName

◆ myTargetName

◆ myOwnshipLocation

◆ myTargetLocation

◆ myRadarOffsetLocation

◆ myRadarOffsetOrientation

◆ myRadarName

◆ myPower

◆ myImageSize

◆ myImageFormat

◆ myImageDataType

◆ myImageRotation

◆ myReturnMethod