makRadarFx::DtIsarRequest Class Reference

DtIsarRequest defines a request for an image from the RadarFX Server. More...

Inheritance diagram for makRadarFx::DtIsarRequest:

Public Member Functions
	DtIsarRequest ()
	CTOR/DTOR.
virtual	~DtIsarRequest ()
virtual void	useObserverAsHost ()
	calling this function causes the message to use the current observer's position and orientation for the SAR image setup.
virtual void	setOwnshipLocation (DtVector location)
	if the ownship is not hosted in the simulation system, we can explicitly state where we want to perform the elevation test from
virtual DtVector	ownshipLocation ()
virtual void	setOwnshipEntityId (const std::string &name)
	If the ownship is hosted by the simulation system, we can use its global simulation name to look it up.
virtual std::string	ownshipEntityId ()
virtual bool	isUsingObserverAsHost ()
	functions to determine how to place the sensor
virtual bool	isUsingEntityAsHost ()
virtual bool	isUsingAbsoluteLocation ()
virtual void	useObserverForTarget ()
	calling this function causes the message to use the current observer's view to determine the target for the SAR image setup.
virtual void	setTargetEntityId (const std::string &name)
	If the ownship is the target of the sensor, we can use its global simulation name to look it up.
virtual std::string	targetEntityId ()
virtual void	setTargetLocation (DtVector location)
	this is the target that we would like to look at.
virtual DtVector	targetLocation ()
virtual bool	isUsingObserverForTarget ()
	functions to determine how to place the target
virtual bool	isUsingEntityForTarget ()
virtual bool	isUsingLocationForTarget ()
virtual void	setRadarOffsetLocation (DtVector offset)
	the offset location of the sensor on the hosting entity.
virtual DtVector	radarOffsetLocation ()
virtual void	setRadarOffsetOrientation (DtTaitBryan offsetOrientation)
	the offset orientation of the sensor from the hosting entite's orientation.
virtual DtTaitBryan	radarOffsetOrientation ()
virtual void	setRadarSystemName (const std::string &name)
	The name of the sensor system to use. This must match one of the sensors that the RadarFX server has configured.
virtual std::string	radarSystemName ()
virtual void	setPower (float power)
	Radar system power setting in Watts.
virtual float	power ()
virtual void	setImageSize (const DtImageSize &size)
	Requested image pixel size. This may not be the returned size due to image rotation.
virtual DtImageSize	imageSize ()
virtual void	setImageDataType (DtImageDataType type)
	Requested data type of the returned image data. Only available for RAW/NITF image types.
virtual DtImageDataType	imageDataType ()
virtual void	setImageFormat (DtImageFormat format)
	Requested format of the returned image data.
virtual DtImageFormat	imageFormat ()
virtual void	setImageReturnMethod (unsigned int returnFlags)
	Bitfield for image data return types.
virtual unsigned int	imageReturnMethod ()
virtual void	setImageSavePath (const std::string &filename)
	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.
virtual std::string	imageSavePath ()
virtual void	setImageFilename (const std::string &filename)
	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.
virtual std::string	imageFilename ()
virtual int	numRequestedImages ()
	accessors for the number of images/responses to generate
virtual void	setNumRequestedImages (int numImages)
virtual float	viewMagnification ()
	accessors for the view magnification to use for this request
virtual void	setViewMagnification (float zoom)
virtual int	messageSize ()
	size of the message
virtual DtBaseMessage *	clone ()
	clone a message. Caller of function is responsible managing this memory
Public Member Functions inherited from makRadarFx::DtImageRequest
	DtImageRequest ()
	CTOR/DTOR.
virtual	~DtImageRequest ()
Public Member Functions inherited from makRadarFx::DtBaseMessage
	DtBaseMessage ()
	CTOR/DTOR.
virtual	~DtBaseMessage ()
virtual unsigned int	messageType () const
	Get the name of the message type.
virtual unsigned char *	encode ()
	Encode the message as an array of bytes and return the bytes the receiver is responsible for calling delete [] on these bytes.
virtual void	setRequestorId (const std::string &requestor)
	Assigns the requestor name of this message.
virtual std::string	requestorId ()
virtual void	setRequestId (int id)
	Assigns the request id of this message.
virtual int	requestId ()

Static Public Member Functions
static DtBaseMessage *	decode (unsigned char *buffer, int length)
	decode a message. Used by the factory

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
DtVector	myRadarOffsetLocation
DtTaitBryan	myRadarOffsetOrientation
std::string	myRadarName
float	myPower
DtImageSize	myImageSize
DtImageFormat	myImageFormat
DtImageDataType	myImageDataType
unsigned int	myReturnMethod
std::string	myImageSavePath
std::string	myImageFilename
int	myNumRequestedImages
float	myViewMagnification

Detailed Description

DtIsarRequest defines a request for an image from the RadarFX Server.

Constructor & Destructor Documentation

makRadarFx::DtIsarRequest::DtIsarRequest

(

)

CTOR/DTOR.

virtual makRadarFx::DtIsarRequest::~DtIsarRequest ( )

virtual

Member Function Documentation

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

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

virtual DtVector makRadarFx::DtIsarRequest::ownshipLocation ( )

virtual

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

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

virtual

virtual bool makRadarFx::DtIsarRequest::isUsingObserverAsHost ( )

virtual

functions to determine how to place the sensor

virtual bool makRadarFx::DtIsarRequest::isUsingEntityAsHost ( )

virtual

virtual bool makRadarFx::DtIsarRequest::isUsingAbsoluteLocation ( )

virtual

virtual void makRadarFx::DtIsarRequest::useObserverForTarget ( )

virtual

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

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

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

virtual

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

virtual DtVector makRadarFx::DtIsarRequest::targetLocation ( )

virtual

virtual bool makRadarFx::DtIsarRequest::isUsingObserverForTarget ( )

virtual

functions to determine how to place the target

virtual bool makRadarFx::DtIsarRequest::isUsingEntityForTarget ( )

virtual

virtual bool makRadarFx::DtIsarRequest::isUsingLocationForTarget ( )

virtual

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

virtual

the offset location of the sensor on the hosting entity.

Only valid when a hosting entity is defined

virtual DtVector makRadarFx::DtIsarRequest::radarOffsetLocation ( )

virtual

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

virtual

the offset orientation of the sensor from the hosting entite's orientation.

Only valid when a hosting entity is defined

virtual DtTaitBryan makRadarFx::DtIsarRequest::radarOffsetOrientation ( )

virtual

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

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

virtual

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

virtual

Radar system power setting in Watts.

virtual float makRadarFx::DtIsarRequest::power ( )

virtual

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

virtual

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

virtual DtImageSize makRadarFx::DtIsarRequest::imageSize ( )

virtual

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

virtual

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

virtual DtImageDataType makRadarFx::DtIsarRequest::imageDataType ( )

virtual

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

virtual

Requested format of the returned image data.

virtual DtImageFormat makRadarFx::DtIsarRequest::imageFormat ( )

virtual

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

virtual

Bitfield for image data return types.

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

virtual

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

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

virtual

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

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

virtual

virtual int makRadarFx::DtIsarRequest::numRequestedImages ( )

virtual

accessors for the number of images/responses to generate

virtual void makRadarFx::DtIsarRequest::setNumRequestedImages ( int  numImages )

virtual

virtual float makRadarFx::DtIsarRequest::viewMagnification ( )

virtual

accessors for the view magnification to use for this request

virtual void makRadarFx::DtIsarRequest::setViewMagnification ( float  zoom )

virtual

virtual int makRadarFx::DtIsarRequest::messageSize ( )

virtual

size of the message

Reimplemented from makRadarFx::DtBaseMessage.

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

static

decode a message. Used by the factory

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

virtual

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

Implements makRadarFx::DtBaseMessage.

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

protectedvirtual

Reimplemented from makRadarFx::DtBaseMessage.

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

protectedvirtual

Reimplemented from makRadarFx::DtBaseMessage.

Member Data Documentation

bool makRadarFx::DtIsarRequest::myUseObserverAsHost

protected

bool makRadarFx::DtIsarRequest::myUseEntityAsHost

protected

bool makRadarFx::DtIsarRequest::myUseAbsoluteOwnship

protected

bool makRadarFx::DtIsarRequest::myUseObserverForTarget

protected

bool makRadarFx::DtIsarRequest::myUseEntityAsTarget

protected

bool makRadarFx::DtIsarRequest::myUseAbsoluteTarget

protected

std::string makRadarFx::DtIsarRequest::myOwnshipName

protected

std::string makRadarFx::DtIsarRequest::myTargetName

protected

DtVector makRadarFx::DtIsarRequest::myOwnshipLocation

protected

DtVector makRadarFx::DtIsarRequest::myTargetLocation

protected

DtVector makRadarFx::DtIsarRequest::myRadarOffsetLocation

protected

DtTaitBryan makRadarFx::DtIsarRequest::myRadarOffsetOrientation

protected

std::string makRadarFx::DtIsarRequest::myRadarName

protected

float makRadarFx::DtIsarRequest::myPower

protected

DtImageSize makRadarFx::DtIsarRequest::myImageSize

protected

DtImageFormat makRadarFx::DtIsarRequest::myImageFormat

protected

DtImageDataType makRadarFx::DtIsarRequest::myImageDataType

protected

unsigned int makRadarFx::DtIsarRequest::myReturnMethod

protected

std::string makRadarFx::DtIsarRequest::myImageSavePath

protected

std::string makRadarFx::DtIsarRequest::myImageFilename

protected

int makRadarFx::DtIsarRequest::myNumRequestedImages

protected

float makRadarFx::DtIsarRequest::myViewMagnification

protected

---

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

• rfxIsarMessage.h