makVre::DtSarSettingsRecord Class Reference

Detailed Description

DtSarSettingsRecord stores all configuration settings related to Synthetic Aperture Radar (SAR) imagery. It provides storage for ownship and target positions, image parameters, server settings, and other SAR-specific options. This class is used for persisting settings and transferring them between components.

#include <sarSettingsRecord.h>

Public Types
enum	OwnshipMode { OwnshipModeEntity , OwnshipModeObserver , OwnshipModeAbsolute }
enum	TargetMode {   TargetModeEntity , TargetModeObserver , TargetModeAbsolute , TargetModeMouseClick ,   TargetModeSensor }

Public Member Functions
	DtSarSettingsRecord ()
	DtSarSettingsRecord (const DtSarSettingsRecord &orig)
DtSarSettingsRecord &	operator= (const DtSarSettingsRecord &orig)
virtual	~DtSarSettingsRecord ()
virtual void	setOwnshipMode (int val)
virtual int	ownshipMode () const
virtual void	setOwnshipEntityName (const std::string &val)
virtual const std::string &	ownshipEntityName () const
virtual void	setOwnshipObserverName (const std::string &val)
virtual const std::string &	ownshipObserverName () const
virtual void	setOwnshipAbsoluteLat (double val)
virtual double	ownshipAbsoluteLat () const
virtual void	setOwnshipAbsoluteLon (double val)
virtual double	ownshipAbsoluteLon () const
virtual void	setOwnshipAbsoluteAlt (double val)
virtual double	ownshipAbsoluteAlt () const
virtual void	setTargetMode (int val)
virtual int	targetMode () const
virtual void	setTargetEntityName (const std::string &val)
virtual const std::string &	targetEntityName () const
virtual void	setTargetObserverName (const std::string &val)
virtual const std::string &	targetObserverName () const
virtual void	setTargetSensorName (const std::string &val)
virtual const std::string &	targetSensorName () const
virtual void	setTargetAbsoluteLat (double val)
virtual double	targetAbsoluteLat () const
virtual void	setTargetAbsoluteLon (double val)
virtual double	targetAbsoluteLon () const
virtual void	setTargetAbsoluteAlt (double val)
virtual double	targetAbsoluteAlt () const
virtual void	setImageSizeX (int val)
virtual int	imageSizeX () const
virtual void	setImageSizeY (int val)
virtual int	imageSizeY () const
virtual void	setImageRotation (int val)
virtual int	imageRotation () const
virtual void	setImageFormat (int val)
virtual int	imageFormat () const
virtual void	setImageDataType (int val)
virtual int	imageDataType () const
virtual void	setSensorToUse (const std::string &val)
virtual const std::string &	sensorToUse () const
virtual void	setSaveOnServer (bool val)
virtual bool	saveOnServer () const
virtual void	setServerSavePath (const std::string &val)
virtual const std::string &	serverSavePath () const
virtual void	setPower (double val)
virtual double	power () const
virtual void	setIsAgcPowerEnabled (bool isAgcPowerEnabled)
virtual bool	isAgcPowerEnabled () const
virtual void	setCrossrange (double val)
virtual double	crossrange () const
virtual void	setDownrange (double val)
virtual double	downrange () const
void	setOwnshipSpeed (float speed)
float	ownshipSpeed () const
virtual void	setServerIp (const std::string &val)
virtual const std::string &	serverIp () const
virtual void	setServerPort (int val)
virtual int	serverPort () const
virtual void	setOpenSarResponseWindow (bool val)
virtual bool	openSarResponseWindow () const

Protected Member Functions
template<class Archive>
void	serialize (Archive &ar, const unsigned int version)

Protected Attributes
int	myOwnshipMode
std::string	myOwnshipEntityName
std::string	myOwnshipObserverName
double	myOwnshipAbsoluteLat
double	myOwnshipAbsoluteLon
double	myOwnshipAbsoluteAlt
int	myTargetMode
std::string	myTargetEntityName
std::string	myTargetObserverName
std::string	myTargetSensorName
double	myTargetAbsoluteLat
double	myTargetAbsoluteLon
double	myTargetAbsoluteAlt
int	myImageSizeX
int	myImageSizeY
int	myImageRotation
int	myImageFormat
int	myImageDataType
std::string	mySensorToUse
bool	mySaveOnServer
std::string	myServerSavePath
bool	myIsAgcPowerEnabled
double	myPower
double	myDownrange
double	myCrossrange
float	myOwnshipSpeed
std::string	myServerIp
int	myServerPort
bool	myOpenSarResponseWindow

Friends
class	boost::serialization::access

Member Enumeration Documentation

OwnshipMode

enum makVre::DtSarSettingsRecord::OwnshipMode

Enumeration for ownship positioning modes.

Enumerator
OwnshipModeEntity	Use an entity as the ownship position source.
OwnshipModeObserver	Use an observer as the ownship position source.
OwnshipModeAbsolute	Use absolute coordinates as the ownship position.

TargetMode

enum makVre::DtSarSettingsRecord::TargetMode

Enumeration for target positioning modes.

Enumerator
TargetModeEntity	Use an entity as the target position source.
TargetModeObserver	Use an observer as the target position source.
TargetModeAbsolute	Use absolute coordinates as the target position.
TargetModeMouseClick	Use mouse-clicked position as the target position.
TargetModeSensor	Use a sensor as the target position source.

Constructor & Destructor Documentation

DtSarSettingsRecord() [1/2]

makVre::DtSarSettingsRecord::DtSarSettingsRecord

(

)

Default constructor.

Initializes all settings to their default values

Referenced by DtSarSettingsRecord(), and operator=().

DtSarSettingsRecord() [2/2]

makVre::DtSarSettingsRecord::DtSarSettingsRecord

(

const DtSarSettingsRecord &

orig

)

Copy constructor.

Parameters

orig	Source record to copy from

Creates a new record that is a copy of the original

References DtSarSettingsRecord().

~DtSarSettingsRecord()

virtual makVre::DtSarSettingsRecord::~DtSarSettingsRecord ( )

virtual

Virtual destructor.

Member Function Documentation

operator=()

DtSarSettingsRecord & makVre::DtSarSettingsRecord::operator=

(

const DtSarSettingsRecord &

orig

)

Assignment operator.

Parameters

orig	Source record to assign from

Returns

Reference to this record

Copies all settings from the original record

References DtSarSettingsRecord().

setOwnshipMode()

virtual void makVre::DtSarSettingsRecord::setOwnshipMode ( int val )

virtual

Sets the ownship mode.

Parameters

val	Mode value (typically 0=Entity, 1=Observer, 2=Absolute Position)

ownshipMode()

virtual int makVre::DtSarSettingsRecord::ownshipMode ( ) const

virtual

Gets the current ownship mode.

Returns

Current ownship mode value

setOwnshipEntityName()

virtual void makVre::DtSarSettingsRecord::setOwnshipEntityName ( const std::string & val )

virtual

Sets the ownship entity name.

Parameters

val	Entity name for the ownship

ownshipEntityName()

virtual const std::string & makVre::DtSarSettingsRecord::ownshipEntityName ( ) const

virtual

Gets the current ownship entity name.

Returns

Current ownship entity name

setOwnshipObserverName()

virtual void makVre::DtSarSettingsRecord::setOwnshipObserverName ( const std::string & val )

virtual

Sets the ownship observer name.

Parameters

val	Observer name for the ownship

ownshipObserverName()

virtual const std::string & makVre::DtSarSettingsRecord::ownshipObserverName ( ) const

virtual

Gets the current ownship observer name.

Returns

Current ownship observer name

setOwnshipAbsoluteLat()

virtual void makVre::DtSarSettingsRecord::setOwnshipAbsoluteLat ( double val )

virtual

Sets the ownship absolute latitude.

Parameters

val	Latitude value

ownshipAbsoluteLat()

virtual double makVre::DtSarSettingsRecord::ownshipAbsoluteLat ( ) const

virtual

Gets the current ownship absolute latitude.

Returns

Current ownship latitude

setOwnshipAbsoluteLon()

virtual void makVre::DtSarSettingsRecord::setOwnshipAbsoluteLon ( double val )

virtual

Sets the ownship absolute longitude.

Parameters

val	Longitude value

ownshipAbsoluteLon()

virtual double makVre::DtSarSettingsRecord::ownshipAbsoluteLon ( ) const

virtual

Gets the current ownship absolute longitude.

Returns

Current ownship longitude

setOwnshipAbsoluteAlt()

virtual void makVre::DtSarSettingsRecord::setOwnshipAbsoluteAlt ( double val )

virtual

Sets the ownship absolute altitude.

Parameters

val	Altitude value

ownshipAbsoluteAlt()

virtual double makVre::DtSarSettingsRecord::ownshipAbsoluteAlt ( ) const

virtual

Gets the current ownship absolute altitude.

Returns

Current ownship altitude

setTargetMode()

virtual void makVre::DtSarSettingsRecord::setTargetMode ( int val )

virtual

Sets the target mode.

Parameters

val	Mode value (typically 0=Entity, 1=Observer, 2=Absolute Position, 3=MouseClick, 4=Sensor)

targetMode()

virtual int makVre::DtSarSettingsRecord::targetMode ( ) const

virtual

Gets the current target mode.

Returns

Current target mode value

setTargetEntityName()

virtual void makVre::DtSarSettingsRecord::setTargetEntityName ( const std::string & val )

virtual

Sets the target entity name.

Parameters

val	Entity name for the target

targetEntityName()

virtual const std::string & makVre::DtSarSettingsRecord::targetEntityName ( ) const

virtual

Gets the current target entity name.

Returns

Current target entity name

setTargetObserverName()

virtual void makVre::DtSarSettingsRecord::setTargetObserverName ( const std::string & val )

virtual

Sets the target observer name.

Parameters

val	Observer name for the target

targetObserverName()

virtual const std::string & makVre::DtSarSettingsRecord::targetObserverName ( ) const

virtual

Gets the current target observer name.

Returns

Current target observer name

setTargetSensorName()

virtual void makVre::DtSarSettingsRecord::setTargetSensorName ( const std::string & val )

virtual

Sets the target sensor name.

Parameters

val	Sensor name for the target

targetSensorName()

virtual const std::string & makVre::DtSarSettingsRecord::targetSensorName ( ) const

virtual

Gets the current target sensor name.

Returns

Current target sensor name

setTargetAbsoluteLat()

virtual void makVre::DtSarSettingsRecord::setTargetAbsoluteLat ( double val )

virtual

Sets the target absolute latitude.

Parameters

val	Latitude value

targetAbsoluteLat()

virtual double makVre::DtSarSettingsRecord::targetAbsoluteLat ( ) const

virtual

Gets the current target absolute latitude.

Returns

Current target latitude

setTargetAbsoluteLon()

virtual void makVre::DtSarSettingsRecord::setTargetAbsoluteLon ( double val )

virtual

Sets the target absolute longitude.

Parameters

val	Longitude value

targetAbsoluteLon()

virtual double makVre::DtSarSettingsRecord::targetAbsoluteLon ( ) const

virtual

Gets the current target absolute longitude.

Returns

Current target longitude

setTargetAbsoluteAlt()

virtual void makVre::DtSarSettingsRecord::setTargetAbsoluteAlt ( double val )

virtual

Sets the target absolute altitude.

Parameters

val	Altitude value

targetAbsoluteAlt()

virtual double makVre::DtSarSettingsRecord::targetAbsoluteAlt ( ) const

virtual

Gets the current target absolute altitude.

Returns

Current target altitude

setImageSizeX()

virtual void makVre::DtSarSettingsRecord::setImageSizeX ( int val )

virtual

Sets the image X dimension (width)

Parameters

val	Width in pixels

imageSizeX()

virtual int makVre::DtSarSettingsRecord::imageSizeX ( ) const

virtual

Gets the current image X dimension.

Returns

Current image width in pixels

setImageSizeY()

virtual void makVre::DtSarSettingsRecord::setImageSizeY ( int val )

virtual

Sets the image Y dimension (height)

Parameters

val	Height in pixels

imageSizeY()

virtual int makVre::DtSarSettingsRecord::imageSizeY ( ) const

virtual

Gets the current image Y dimension.

Returns

Current image height in pixels

setImageRotation()

virtual void makVre::DtSarSettingsRecord::setImageRotation ( int val )

virtual

Sets the image rotation.

Parameters

val	Rotation angle in degrees

imageRotation()

virtual int makVre::DtSarSettingsRecord::imageRotation ( ) const

virtual

Gets the current image rotation.

Returns

Current image rotation in degrees

setImageFormat()

virtual void makVre::DtSarSettingsRecord::setImageFormat ( int val )

virtual

Sets the image format.

Parameters

val	Image format index

imageFormat()

virtual int makVre::DtSarSettingsRecord::imageFormat ( ) const

virtual

Gets the current image format.

Returns

Current image format index

setImageDataType()

virtual void makVre::DtSarSettingsRecord::setImageDataType ( int val )

virtual

Sets the image data type.

Parameters

val	Image data type index

imageDataType()

virtual int makVre::DtSarSettingsRecord::imageDataType ( ) const

virtual

Gets the current image data type.

Returns

Current image data type index

setSensorToUse()

virtual void makVre::DtSarSettingsRecord::setSensorToUse ( const std::string & val )

virtual

Sets the sensor to use for SAR imagery.

Parameters

val	Sensor name

sensorToUse()

virtual const std::string & makVre::DtSarSettingsRecord::sensorToUse ( ) const

virtual

Gets the current sensor used for SAR imagery.

Returns

Current sensor name

setSaveOnServer()

virtual void makVre::DtSarSettingsRecord::setSaveOnServer ( bool val )

virtual

Sets whether to save SAR images on the server.

Parameters

val	True to save on server, false otherwise

saveOnServer()

virtual bool makVre::DtSarSettingsRecord::saveOnServer ( ) const

virtual

Gets whether SAR images are saved on the server.

Returns

True if saving on server is enabled, false otherwise

setServerSavePath()

virtual void makVre::DtSarSettingsRecord::setServerSavePath ( const std::string & val )

virtual

Sets the path where images are saved on the server.

Parameters

val	Server save path

serverSavePath()

virtual const std::string & makVre::DtSarSettingsRecord::serverSavePath ( ) const

virtual

Gets the current server save path.

Returns

Path where images are saved on the server

setPower()

virtual void makVre::DtSarSettingsRecord::setPower ( double val )

virtual

Sets the radar power level.

Parameters

val	Power level value

power()

virtual double makVre::DtSarSettingsRecord::power ( ) const

virtual

Gets the current radar power level.

Returns

Current power level

setIsAgcPowerEnabled()

virtual void makVre::DtSarSettingsRecord::setIsAgcPowerEnabled ( bool isAgcPowerEnabled )

virtual

Sets whether Automatic Gain Control is enabled for power.

Parameters

isAgcPowerEnabled

True to enable AGC, false otherwise

References isAgcPowerEnabled().

isAgcPowerEnabled()

virtual bool makVre::DtSarSettingsRecord::isAgcPowerEnabled ( ) const

virtual

Gets whether Automatic Gain Control is enabled for power.

Returns

True if AGC is enabled, false otherwise

Referenced by setIsAgcPowerEnabled().

setCrossrange()

virtual void makVre::DtSarSettingsRecord::setCrossrange ( double val )

virtual

Sets the crossrange distance.

Parameters

val	Crossrange value in meters

crossrange()

virtual double makVre::DtSarSettingsRecord::crossrange ( ) const

virtual

Gets the current crossrange distance.

Returns

Current crossrange in meters

setDownrange()

virtual void makVre::DtSarSettingsRecord::setDownrange ( double val )

virtual

Sets the downrange distance.

Parameters

val	Downrange value in meters

downrange()

virtual double makVre::DtSarSettingsRecord::downrange ( ) const

virtual

Gets the current downrange distance.

Returns

Current downrange in meters

setOwnshipSpeed()

void makVre::DtSarSettingsRecord::setOwnshipSpeed

(

float

speed

)

Sets the ownship speed.

Parameters

speed

Speed value in meters per second

Speed of the observer when the SAR image is requested

ownshipSpeed()

float makVre::DtSarSettingsRecord::ownshipSpeed

(

)

const

Gets the current ownship speed.

Returns

Current ownship speed in meters per second

setServerIp()

virtual void makVre::DtSarSettingsRecord::setServerIp ( const std::string & val )

virtual

Sets the RadarFx server IP address.

Parameters

val	IP address string

serverIp()

virtual const std::string & makVre::DtSarSettingsRecord::serverIp ( ) const

virtual

Gets the current RadarFx server IP address.

Returns

Current server IP address

setServerPort()

virtual void makVre::DtSarSettingsRecord::setServerPort ( int val )

virtual

Sets the RadarFx server port.

Parameters

val	Port number

serverPort()

virtual int makVre::DtSarSettingsRecord::serverPort ( ) const

virtual

Gets the current RadarFx server port.

Returns

Current server port number

setOpenSarResponseWindow()

virtual void makVre::DtSarSettingsRecord::setOpenSarResponseWindow ( bool val )

virtual

Sets whether to automatically open the SAR response window.

Parameters

val	True to open window, false otherwise

openSarResponseWindow()

virtual bool makVre::DtSarSettingsRecord::openSarResponseWindow ( ) const

virtual

Gets whether the SAR response window opens automatically.

Returns

True if window opens automatically, false otherwise

serialize()

template<class Archive>

void makVre::DtSarSettingsRecord::serialize ( Archive & ar, const unsigned int version )

inlineprotected

Serializes the settings record to/from an archive.

Template Parameters

Archive

Type of archive (input or output)

Parameters

ar	Reference to the archive
version	Version number for the serialization format

When the Archive corresponds to an output archive, the & operator is defined similar to <<. Likewise, when the Archive is a type of input archive, the & operator is defined similar to >>.

References myCrossrange, myDownrange, myImageDataType, myImageFormat, myImageRotation, myImageSizeX, myImageSizeY, myIsAgcPowerEnabled, myOpenSarResponseWindow, myOwnshipAbsoluteAlt, myOwnshipAbsoluteLat, myOwnshipAbsoluteLon, myOwnshipEntityName, myOwnshipMode, myOwnshipObserverName, myOwnshipSpeed, myPower, mySaveOnServer, mySensorToUse, myServerIp, myServerPort, myServerSavePath, myTargetAbsoluteAlt, myTargetAbsoluteLat, myTargetAbsoluteLon, myTargetEntityName, myTargetMode, myTargetObserverName, and myTargetSensorName.

Friends And Related Symbol Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Grants access to boost serialization.

Member Data Documentation

myOwnshipMode

int makVre::DtSarSettingsRecord::myOwnshipMode

protected

Ownship positioning mode 1=simulated entity location 2=observer location 3=geodetic (deg) location.

Referenced by serialize().

myOwnshipEntityName

std::string makVre::DtSarSettingsRecord::myOwnshipEntityName

protected

Name of the entity to use for ownship positioning.

Referenced by serialize().

myOwnshipObserverName

std::string makVre::DtSarSettingsRecord::myOwnshipObserverName

protected

Name of the observer to use for ownship positioning.

Referenced by serialize().

myOwnshipAbsoluteLat

double makVre::DtSarSettingsRecord::myOwnshipAbsoluteLat

protected

Absolute latitude for ownship positioning (degrees)

Referenced by serialize().

myOwnshipAbsoluteLon

double makVre::DtSarSettingsRecord::myOwnshipAbsoluteLon

protected

Absolute longitude for ownship positioning (degrees)

Referenced by serialize().

myOwnshipAbsoluteAlt

double makVre::DtSarSettingsRecord::myOwnshipAbsoluteAlt

protected

Absolute altitude for ownship positioning (meters)

Referenced by serialize().

myTargetMode

int makVre::DtSarSettingsRecord::myTargetMode

protected

Target positioning mode 1=simulated entity location 2=observer location 3=geodetic (deg) location 4=mouse click location 5=sensor location.

Referenced by serialize().

myTargetEntityName

std::string makVre::DtSarSettingsRecord::myTargetEntityName

protected

Name of the entity to use for target positioning.

Referenced by serialize().

myTargetObserverName

std::string makVre::DtSarSettingsRecord::myTargetObserverName

protected

Name of the observer to use for target positioning.

Referenced by serialize().

myTargetSensorName

std::string makVre::DtSarSettingsRecord::myTargetSensorName

protected

Name of the sensor to use for target positioning.

Referenced by serialize().

myTargetAbsoluteLat

double makVre::DtSarSettingsRecord::myTargetAbsoluteLat

protected

Absolute latitude for target positioning (degrees)

Referenced by serialize().

myTargetAbsoluteLon

double makVre::DtSarSettingsRecord::myTargetAbsoluteLon

protected

Absolute longitude for target positioning (degrees)

Referenced by serialize().

myTargetAbsoluteAlt

double makVre::DtSarSettingsRecord::myTargetAbsoluteAlt

protected

Absolute altitude for target positioning (meters)

Referenced by serialize().

myImageSizeX

int makVre::DtSarSettingsRecord::myImageSizeX

protected

Image width in pixels.

Referenced by serialize().

myImageSizeY

int makVre::DtSarSettingsRecord::myImageSizeY

protected

Image height in pixels.

Referenced by serialize().

myImageRotation

int makVre::DtSarSettingsRecord::myImageRotation

protected

Image rotation in degrees.

Referenced by serialize().

myImageFormat

int makVre::DtSarSettingsRecord::myImageFormat

protected

Image format index.

Referenced by serialize().

myImageDataType

int makVre::DtSarSettingsRecord::myImageDataType

protected

Image data type index.

Referenced by serialize().

mySensorToUse

std::string makVre::DtSarSettingsRecord::mySensorToUse

protected

Name of the sensor to use for imaging.

Referenced by serialize().

mySaveOnServer

bool makVre::DtSarSettingsRecord::mySaveOnServer

protected

Flag indicating if images should be saved on the server.

Referenced by serialize().

myServerSavePath

std::string makVre::DtSarSettingsRecord::myServerSavePath

protected

Path where images are saved on the server.

Referenced by serialize().

myIsAgcPowerEnabled

bool makVre::DtSarSettingsRecord::myIsAgcPowerEnabled

protected

Flag indicating if Automatic Gain Control is enabled for power.

Referenced by serialize().

myPower

double makVre::DtSarSettingsRecord::myPower

protected

Radar power level.

Referenced by serialize().

myDownrange

double makVre::DtSarSettingsRecord::myDownrange

protected

Downrange distance in meters.

Distance in direction of aircraft heading

Referenced by serialize().

myCrossrange

double makVre::DtSarSettingsRecord::myCrossrange

protected

Crossrange distance in meters.

Distance perpendicular to aircraft heading

Referenced by serialize().

myOwnshipSpeed

float makVre::DtSarSettingsRecord::myOwnshipSpeed

protected

Ownship speed in meters per second when SAR image is requested.

Referenced by serialize().

myServerIp

std::string makVre::DtSarSettingsRecord::myServerIp

protected

RadarFx server IP address.

Referenced by serialize().

myServerPort

int makVre::DtSarSettingsRecord::myServerPort

protected

RadarFx server port number.

Referenced by serialize().

myOpenSarResponseWindow

bool makVre::DtSarSettingsRecord::myOpenSarResponseWindow

protected

Flag indicating if SAR response window should automatically open.

Referenced by serialize().

---

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

• include/roles/pilot/vrePilotSarClient/sarSettingsRecord.h