RadarFX API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
makRadarFx::DtElevationRequest Class Reference

The DtElevationRequest encapsulates a request for the elevation a given target location using the sensors on the named platform or from the ownship location. More...

Inheritance diagram for makRadarFx::DtElevationRequest:
Inheritance graph
[legend]

Public Member Functions

 DtElevationRequest ()
 CTOR/DTOR.
virtual ~DtElevationRequest ()
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 int messageSize ()
 size of the message
virtual DtBaseMessageclone ()
 clone a message. Caller of function is responsible managing this memory
- 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 DtBaseMessagedecode (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
- Protected Attributes inherited from makRadarFx::DtBaseMessage
unsigned int myMessageType
std::string myRequestorId
int myRequestId

Detailed Description

The DtElevationRequest encapsulates a request for the elevation a given target location using the sensors on the named platform or from the ownship location.

If line of sight is not available from the sensing platform the response will have an error value

Constructor & Destructor Documentation

makRadarFx::DtElevationRequest::DtElevationRequest ( )

CTOR/DTOR.

virtual makRadarFx::DtElevationRequest::~DtElevationRequest ( )
virtual

Member Function Documentation

virtual void makRadarFx::DtElevationRequest::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::DtElevationRequest::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::DtElevationRequest::ownshipLocation ( )
virtual
virtual void makRadarFx::DtElevationRequest::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::DtElevationRequest::ownshipEntityId ( )
virtual
virtual bool makRadarFx::DtElevationRequest::isUsingObserverAsHost ( )
virtual

functions to determine how to place the sensor

virtual bool makRadarFx::DtElevationRequest::isUsingEntityAsHost ( )
virtual
virtual bool makRadarFx::DtElevationRequest::isUsingAbsoluteLocation ( )
virtual
virtual void makRadarFx::DtElevationRequest::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::DtElevationRequest::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::DtElevationRequest::targetEntityId ( )
virtual
virtual void makRadarFx::DtElevationRequest::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::DtElevationRequest::targetLocation ( )
virtual
virtual bool makRadarFx::DtElevationRequest::isUsingObserverForTarget ( )
virtual

functions to determine how to place the target

virtual bool makRadarFx::DtElevationRequest::isUsingEntityForTarget ( )
virtual
virtual bool makRadarFx::DtElevationRequest::isUsingLocationForTarget ( )
virtual
virtual int makRadarFx::DtElevationRequest::messageSize ( )
virtual

size of the message

Reimplemented from makRadarFx::DtBaseMessage.

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

decode a message. Used by the factory

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

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

Implements makRadarFx::DtBaseMessage.

virtual void makRadarFx::DtElevationRequest::serialize ( DtStreamWriter writer)
protectedvirtual

Reimplemented from makRadarFx::DtBaseMessage.

virtual void makRadarFx::DtElevationRequest::deserialize ( DtStreamReader reader)
protectedvirtual

Reimplemented from makRadarFx::DtBaseMessage.

Member Data Documentation

bool makRadarFx::DtElevationRequest::myUseObserverAsHost
protected
bool makRadarFx::DtElevationRequest::myUseEntityAsHost
protected
bool makRadarFx::DtElevationRequest::myUseAbsoluteOwnship
protected
bool makRadarFx::DtElevationRequest::myUseObserverForTarget
protected
bool makRadarFx::DtElevationRequest::myUseEntityAsTarget
protected
bool makRadarFx::DtElevationRequest::myUseAbsoluteTarget
protected
std::string makRadarFx::DtElevationRequest::myOwnshipName
protected
std::string makRadarFx::DtElevationRequest::myTargetName
protected
DtVector makRadarFx::DtElevationRequest::myOwnshipLocation
protected
DtVector makRadarFx::DtElevationRequest::myTargetLocation
protected

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

Document ID: 1.0
Copyright © 2017 VT MAK Inc. All Rights Reserved (www.mak.com)