VR-Engage  2.2
Loading...
Searching...
No Matches
DtRwRwrContactInfo Class Reference

Detailed Description

This class represents the data gathered by an RWR about a particular emitter (radar) detected in the environment. It provides information about the contact's position, signal characteristics, and emitter identification. This is a readable/writable class that can store and read itself from a file. Note that entity IDs are not persisted, as they change between scenario runs.

#include <rwRwrContactInfo.h>

Inheritance diagram for DtRwRwrContactInfo:
[legend]

Public Member Functions

 DtRwRwrContactInfo ()
 
 DtRwRwrContactInfo (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwRwrContactInfo (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwRwrContactInfo (const DtRwRwrContactInfo &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
 
virtual ~DtRwRwrContactInfo () override
 
DtRwRwrContactInfooperator= (const DtRwRwrContactInfo &orig)
 
virtual void setContactAzimuth (double azimuth)
 
virtual double contactAzimuth () const
 
virtual void setContactElevation (double elevation)
 
virtual double contactElevation () const
 
virtual void setContactRange (double range)
 
virtual double contactRange () const
 
virtual void setContactRadarMode (int mode)
 
virtual int contactRadarMode () const
 
virtual void setContactPower (double power)
 
virtual double contactPower () const
 
virtual void setEmitterSystemId (const DtString &id)
 
virtual DtString emitterSystemId () const
 
DtRwTemplatedUUIDList & targets ()
 
virtual DtRwRwrContactInfoclone () const
 
bool operator== (const DtRwRwrContactInfo &other) const
 
bool operator!= (const DtRwRwrContactInfo &rhs)
 
virtual char * encode (char *buffer) const
 
virtual const char * decode (const char *buffer)
 
virtual int getSize () const
 

Protected Attributes

DtRwReal myContactAzimuth
 
DtRwReal myContactElevation
 
DtRwReal myContactRange
 
DtRwInt myRadarMode
 
DtRwReal mySignalPower
 
DtRwString myEmitterSystemId
 
DtRwTemplatedUUIDList myTargets
 

Constructor & Destructor Documentation

◆ DtRwRwrContactInfo() [1/4]

DtRwRwrContactInfo::DtRwRwrContactInfo ( )

Default constructor.

Initializes an RWR contact info object with default values.

Referenced by clone(), DtRwRwrContactInfo(), operator!=(), operator=(), and operator==().

◆ DtRwRwrContactInfo() [2/4]

DtRwRwrContactInfo::DtRwRwrContactInfo ( const DtString & name,
DtReaderWriterRegistry *const parentRegistry = NULL )

Constructor with name.

Parameters
nameThe name of the RWR contact
parentRegistryOptional reader-writer registry for serialization

◆ DtRwRwrContactInfo() [3/4]

DtRwRwrContactInfo::DtRwRwrContactInfo ( const DtSymbolString & name,
DtReaderWriterRegistry *const parentRegistry = NULL )

Constructor with symbol name.

Parameters
nameThe symbol name of the RWR contact
parentRegistryOptional reader-writer registry for serialization

◆ DtRwRwrContactInfo() [4/4]

DtRwRwrContactInfo::DtRwRwrContactInfo ( const DtRwRwrContactInfo & orig,
DtReaderWriterRegistry *const parentRegistry = NULL )

Copy constructor.

Parameters
origThe RWR contact info to copy from
parentRegistryOptional reader-writer registry for serialization

References DtRwRwrContactInfo().

◆ ~DtRwRwrContactInfo()

virtual DtRwRwrContactInfo::~DtRwRwrContactInfo ( )
overridevirtual

Virtual destructor.

Member Function Documentation

◆ operator=()

DtRwRwrContactInfo & DtRwRwrContactInfo::operator= ( const DtRwRwrContactInfo & orig)

Assignment operator.

Parameters
origThe RWR contact info to copy from
Returns
Reference to this object after assignment

References DtRwRwrContactInfo().

◆ setContactAzimuth()

virtual void DtRwRwrContactInfo::setContactAzimuth ( double azimuth)
virtual

Sets the contact's azimuth relative to the platform's heading.

Parameters
azimuthThe azimuth angle in degrees

Sets the azimuth angle (in degrees) of the contact relative to the platform's heading. Negative azimuth values indicate the contact is towards the left.

◆ contactAzimuth()

virtual double DtRwRwrContactInfo::contactAzimuth ( ) const
virtual

Gets the contact's azimuth.

Returns
The azimuth angle in degrees relative to the platform's heading

◆ setContactElevation()

virtual void DtRwRwrContactInfo::setContactElevation ( double elevation)
virtual

Sets the contact's elevation angle.

Parameters
elevationThe elevation angle in degrees

Sets the elevation angle (in degrees) of the contact relative to the platform.

◆ contactElevation()

virtual double DtRwRwrContactInfo::contactElevation ( ) const
virtual

Gets the contact's elevation angle.

Returns
The elevation angle in degrees

◆ setContactRange()

virtual void DtRwRwrContactInfo::setContactRange ( double range)
virtual

Sets the range to the contact.

Parameters
rangeThe range in meters

Sets the straight-line distance to the contact in meters.

◆ contactRange()

virtual double DtRwRwrContactInfo::contactRange ( ) const
virtual

Gets the range to the contact.

Returns
The range in meters

◆ setContactRadarMode()

virtual void DtRwRwrContactInfo::setContactRadarMode ( int mode)
virtual

Sets the radar mode of the contact.

Parameters
modeThe radar mode identifier

Sets the operational mode of the radar emitter that this contact represents.

◆ contactRadarMode()

virtual int DtRwRwrContactInfo::contactRadarMode ( ) const
virtual

Gets the radar mode of the contact.

Returns
The radar mode identifier

◆ setContactPower()

virtual void DtRwRwrContactInfo::setContactPower ( double power)
virtual

Sets the received signal power.

Parameters
powerThe signal power in Watts

Sets the power of the signal received from this contact, measured in Watts.

◆ contactPower()

virtual double DtRwRwrContactInfo::contactPower ( ) const
virtual

Gets the received signal power.

Returns
The signal power in Watts

◆ setEmitterSystemId()

virtual void DtRwRwrContactInfo::setEmitterSystemId ( const DtString & id)
virtual

Sets the emitter system identifier.

Parameters
idThe emitter system identifier string

Sets the identifier for the emitter system type of this contact.

◆ emitterSystemId()

virtual DtString DtRwRwrContactInfo::emitterSystemId ( ) const
virtual

Gets the emitter system identifier.

Returns
The emitter system identifier string

◆ targets()

DtRwTemplatedUUIDList & DtRwRwrContactInfo::targets ( )

Gets the list of target UUIDs associated with this contact.

Returns
Reference to the list of target UUIDs

Returns a reference to the list of entity UUIDs targeted by this emitter.

◆ clone()

virtual DtRwRwrContactInfo * DtRwRwrContactInfo::clone ( ) const
virtual

Creates a deep copy of this object.

Returns
Pointer to a newly created clone of this object

Returns a dynamically allocated copy of this RWR contact info.

References DtRwRwrContactInfo().

◆ operator==()

bool DtRwRwrContactInfo::operator== ( const DtRwRwrContactInfo & other) const

Equality comparison operator.

Parameters
otherThe RWR contact info to compare with
Returns
True if the objects are equal, false otherwise

References DtRwRwrContactInfo().

◆ operator!=()

bool DtRwRwrContactInfo::operator!= ( const DtRwRwrContactInfo & rhs)
inline

Inequality comparison operator.

Parameters
rhsThe RWR contact info to compare with
Returns
True if the objects are not equal, false otherwise

References DtRwRwrContactInfo().

◆ encode()

virtual char * DtRwRwrContactInfo::encode ( char * buffer) const
virtual

Encodes this object to a buffer.

Parameters
bufferThe buffer to encode into
Returns
Pointer to the buffer after the encoded data

◆ decode()

virtual const char * DtRwRwrContactInfo::decode ( const char * buffer)
virtual

Decodes this object from a buffer.

Parameters
bufferThe buffer to decode from
Returns
Pointer to the buffer after the decoded data

◆ getSize()

virtual int DtRwRwrContactInfo::getSize ( ) const
virtual

Gets the size of the encoded data in bytes.

Returns
The size in bytes

Member Data Documentation

◆ myContactAzimuth

DtRwReal DtRwRwrContactInfo::myContactAzimuth
protected

Azimuth angle to the contact relative to platform heading (degrees)

◆ myContactElevation

DtRwReal DtRwRwrContactInfo::myContactElevation
protected

Elevation angle to the contact relative to platform (degrees)

◆ myContactRange

DtRwReal DtRwRwrContactInfo::myContactRange
protected

Range to the contact (meters)

◆ myRadarMode

DtRwInt DtRwRwrContactInfo::myRadarMode
protected

Operational mode of the radar emitter.

◆ mySignalPower

DtRwReal DtRwRwrContactInfo::mySignalPower
protected

Received signal power (Watts)

◆ myEmitterSystemId

DtRwString DtRwRwrContactInfo::myEmitterSystemId
protected

Identifier for the emitter system type.

◆ myTargets

DtRwTemplatedUUIDList DtRwRwrContactInfo::myTargets
protected

List of entity UUIDs targeted by this emitter.


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