VR-Link API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
TransmitterStateMessage Class Reference
+ Inheritance diagram for TransmitterStateMessage:
+ Collaboration diagram for TransmitterStateMessage:

Classes

struct  BeamAntennaPattern
 
struct  ModulationType
 
struct  OmniAntennaPattern
 
struct  SphericalAntennaPattern
 

Public Types

enum  ModulationSystemType {
  ModulationSystemType_OTHER, ModulationSystemType_GENERIC, ModulationSystemType_HQ, ModulationSystemType_HQII,
  ModulationSystemType_HQIIA, ModulationSystemType_SINCGARS, ModulationSystemType_CCTT_SINCGARS, ModulationSystemType_EPLRS,
  ModulationSystemType_JTIDS
}
 
enum  ModulationDetailAplitudeAngleType { ModulationDetailAplitudeAngleType_OTHER, ModulationDetailAplitudeAngleType_APLITUDE_ANGLE }
 
enum  ClearChannel { ClearChannel_NOT_CLEAR, ClearChannel_CLEAR }
 
enum  CryptoSystem {
  CryptoSystem_OTHER, CryptoSystem_KY_28, CryptoSystem_VINSON, CryptoSystem_NSVE,
  CryptoSystem_WSVE, CryptoSystem_SINGARS_ICOM, CryptoSystem_KY_75, CryptoSystem_KY_100
}
 
enum  ModulationDetailPulseType { ModulationDetailPulseType_OTHER, ModulationDetailPulseType_PULSE, ModulationDetailPulseType_X_BAND, ModulationDetailPulseType_Y_BAND }
 
enum  InputSource {
  InputSource_OTHER, InputSource_PILOT, InputSource_COPILOT, InputSource_FIRST_OFFICER,
  InputSource_DRIVER, InputSource_LOADER, InputSource_GUNNER, InputSource_COMMANDER,
  InputSource_DIGITAL_DATA_DEVICE, InputSource_INTERCOM
}
 
enum  ReferenceSystem { ReferenceSystem_WORLDCOORD =1, ReferenceSystem_ENTITYCOORD =2 }
 
enum  ModulationDetailCombinationType { ModulationDetailCombinationType_OTHER, ModulationDetailCombinationType_AMPLITUDE_ANGLE_PULSE }
 
enum  ModulationMajorType {
  ModulationMajorType_OTHER, ModulationMajorType_AMPLITUDE, ModulationMajorType_AMPLITUDE_ANGLE, ModulationMajorType_ANGLE =3,
  ModulationMajorType_COMBINATION =4, ModulationMajorType_PULSE =5, ModulationMajorType_UNMODULATED =6, ModulationMajorType_CARRIER_PHASE_SHIFT =7
}
 
enum  TransmitTerminalSecondaryMode { TransmitTerminalSecondaryMode_NONE, TransmitTerminalSecondaryMode_NET_POSITION_REFERENCE, TransmitTerminalSecondaryMode_PRIMARY_NAVIGATION_CONTROLLER, TransmitTerminalSecondaryMode_SECONDARY_NAVIGATION_CONTROLLER }
 
enum  TransmitState { TransmitState_OFF, TransmitState_RADIO_ON_NOT_TRANSMITTING, TransmitState_ON }
 
enum  CryptoMode { CryptoMode_BASEBAND, CryptoMode_DIPHASE }
 
enum  StartOfMessage { StartOfMessage_NOT_START, StartOfMessage_START }
 
enum  TransmitTerminalPrimaryMode { TransmitTerminalPrimaryMode_NTR, TransmitTerminalPrimaryMode_JTIDS }
 
enum  SyncState { SyncState_COURSE =1, SyncState_FINE =2 }
 
enum  ModulationDetailCarrierPhaseShiftType { ModulationDetailCarrierPhaseShiftType_OTHER }
 
enum  ModulationDetailUnmodulatedType { ModulationDetailUnmodulatedType_OTHER, ModulationDetailUnmodulatedType_CONTINOUS_WAVE }
 
enum  ModulationDetailAngleType { ModulationDetailAngleType_OTHER, ModulationDetailAngleType_FM, ModulationDetailAngleType_FSK, ModulationDetailAngleType_PM }
 
enum  ModulationDetailAplitudeType {
  ModulationDetailAplitudeType_OTHER, ModulationDetailAplitudeType_AFSK, ModulationDetailAplitudeType_AM, ModulationDetailAplitudeType_CW,
  ModulationDetailAplitudeType_DSB, ModulationDetailAplitudeType_ISB, ModulationDetailAplitudeType_LSB, ModulationDetailAplitudeType_SSB_FULL,
  ModulationDetailAplitudeType_SSB_REDUC, ModulationDetailAplitudeType_USB, ModulationDetailAplitudeType_VSB
}
 
enum  AntennaPatternType { AntennaPatternType_OMNIDIRECTIONAL =0, AntennaPatternType_BEAM =1, AntennaPatternType_SPHERICALHARMONIC =2 }
 

Public Member Functions

 TransmitterStateMessage ()
 
virtual ~TransmitterStateMessage ()
 
virtual std::string getEntityId ()
 
virtual void setEntityId (std::string val)
 
virtual unsigned short getRadioId ()
 
virtual void setRadioId (unsigned short val)
 
virtual std::string getHostObjectId ()
 
virtual void setHostObjectId (std::string val)
 
virtual DtEntityType getRadioEntityType ()
 
virtual void setRadioEntityType (DtEntityType val)
 
virtual TransmitState getTransmitState ()
 
virtual void setTransmitState (TransmitState val)
 
virtual InputSource getInputSource ()
 
virtual void setInputSource (InputSource val)
 
virtual DtVector getWorldAntennaLocation ()
 
virtual void setWorldAntennaLocation (DtVector val)
 
virtual DtVector32 getRelativeAntennaLocation ()
 
virtual void setRelativeAntennaLocation (DtVector32 val)
 
virtual AntennaPatternType getAntennaPatternType ()
 
virtual void setAntennaPatternType (AntennaPatternType val)
 
virtual unsigned long long getFrequency ()
 
virtual void setFrequency (unsigned long long val)
 
virtual float getTransmitBandwidth ()
 
virtual void setTransmitBandwidth (float val)
 
virtual float getPower ()
 
virtual void setPower (float val)
 
virtual ModulationType getModulationType ()
 
virtual void setModulationType (ModulationType val)
 
virtual CryptoMode getCryptoMode ()
 
virtual void setCryptoMode (CryptoMode val)
 
virtual CryptoSystem getCryptoSystem ()
 
virtual void setCryptoSystem (CryptoSystem val)
 
virtual unsigned short getCryptoKey ()
 
virtual void setCryptoKey (unsigned short val)
 
virtual std::vector< unsigned
char > 		getModulationParameters ()
 
virtual void setModulationParameters (std::vector< unsigned char > val)
 
virtual std::vector< unsigned
char > 		getAntennaPatternParameters ()
 
virtual void setAntennaPatternParameters (std::vector< unsigned char > val)
 
virtual bool getFreqHopInUse ()
 
virtual void setFreqHopInUse (bool val)
 
virtual bool getPseudoNoiseInUse ()
 
virtual void setPseudoNoiseInUse (bool val)
 
virtual bool getTimeHopInUse ()
 
virtual void setTimeHopInUse (bool val)
 
virtual int messageSize ()
 this function needs to be in each derived class for decoding More...
 
- Public Member Functions inherited from DtMessage
 DtMessage ()
 constructor More...
 
virtual ~DtMessage ()
 destructor More...
 
virtual std::string name () const
 Get the name of the message type. More...
 
virtual double timeStamp ()
 
virtual void setTimeStamp (double ts)
 
virtual unsigned char * encode ()
 Encode the message as an array of bytes and return the bytes. More...
 

Static Public Member Functions

static DtMessage * decode (unsigned char *buffer, int length)
 
static std::string theMessageName ()
 

Protected Member Functions

virtual void serialize (DtStreamWriter &writer)
 
virtual void deserialize (DtStreamReader &reader)
 

Protected Attributes

std::string myEntityId
 
unsigned short myRadioId
 
std::string myHostObjectId
 
DtEntityType myRadioEntityType
 
TransmitState myTransmitState
 
InputSource myInputSource
 
DtVector myWorldAntennaLocation
 
DtVector32 myRelativeAntennaLocation
 
AntennaPatternType myAntennaPatternType
 
unsigned long long myFrequency
 
float myTransmitBandwidth
 
float myPower
 
ModulationType myModulationType
 
CryptoMode myCryptoMode
 
CryptoSystem myCryptoSystem
 
unsigned short myCryptoKey
 
std::vector< unsigned char > myModulationParameters
 
std::vector< unsigned char > myAntennaPatternParameters
 
bool myFreqHopInUse
 
bool myPseudoNoiseInUse
 
bool myTimeHopInUse
 
- Protected Attributes inherited from DtMessage
std::string myName
 
DtTime myTimeStamp
 

Static Protected Attributes

static std::string theFullName
 

Detailed Description

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!This is an auto-generated file. Any changes will be destroyed!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Member Enumeration Documentation

enum TransmitterStateMessage::AntennaPatternType
Enumerator
AntennaPatternType_OMNIDIRECTIONAL 
AntennaPatternType_BEAM 
AntennaPatternType_SPHERICALHARMONIC 
enum TransmitterStateMessage::ClearChannel
Enumerator
ClearChannel_NOT_CLEAR 
ClearChannel_CLEAR 
enum TransmitterStateMessage::CryptoMode
Enumerator
CryptoMode_BASEBAND 
CryptoMode_DIPHASE 
enum TransmitterStateMessage::CryptoSystem
Enumerator
CryptoSystem_OTHER 
CryptoSystem_KY_28 
CryptoSystem_VINSON 
CryptoSystem_NSVE 
CryptoSystem_WSVE 
CryptoSystem_SINGARS_ICOM 
CryptoSystem_KY_75 
CryptoSystem_KY_100 
enum TransmitterStateMessage::InputSource
Enumerator
InputSource_OTHER 
InputSource_PILOT 
InputSource_COPILOT 
InputSource_FIRST_OFFICER 
InputSource_DRIVER 
InputSource_LOADER 
InputSource_GUNNER 
InputSource_COMMANDER 
InputSource_DIGITAL_DATA_DEVICE 
InputSource_INTERCOM 
enum TransmitterStateMessage::ModulationDetailAngleType
Enumerator
ModulationDetailAngleType_OTHER 
ModulationDetailAngleType_FM 
ModulationDetailAngleType_FSK 
ModulationDetailAngleType_PM 
enum TransmitterStateMessage::ModulationDetailAplitudeAngleType
Enumerator
ModulationDetailAplitudeAngleType_OTHER 
ModulationDetailAplitudeAngleType_APLITUDE_ANGLE 
enum TransmitterStateMessage::ModulationDetailAplitudeType
Enumerator
ModulationDetailAplitudeType_OTHER 
ModulationDetailAplitudeType_AFSK 
ModulationDetailAplitudeType_AM 
ModulationDetailAplitudeType_CW 
ModulationDetailAplitudeType_DSB 
ModulationDetailAplitudeType_ISB 
ModulationDetailAplitudeType_LSB 
ModulationDetailAplitudeType_SSB_FULL 
ModulationDetailAplitudeType_SSB_REDUC 
ModulationDetailAplitudeType_USB 
ModulationDetailAplitudeType_VSB 
enum TransmitterStateMessage::ModulationDetailCarrierPhaseShiftType
Enumerator
ModulationDetailCarrierPhaseShiftType_OTHER 
enum TransmitterStateMessage::ModulationDetailCombinationType
Enumerator
ModulationDetailCombinationType_OTHER 
ModulationDetailCombinationType_AMPLITUDE_ANGLE_PULSE 
enum TransmitterStateMessage::ModulationDetailPulseType
Enumerator
ModulationDetailPulseType_OTHER 
ModulationDetailPulseType_PULSE 
ModulationDetailPulseType_X_BAND 
ModulationDetailPulseType_Y_BAND 
enum TransmitterStateMessage::ModulationDetailUnmodulatedType
Enumerator
ModulationDetailUnmodulatedType_OTHER 
ModulationDetailUnmodulatedType_CONTINOUS_WAVE 
enum TransmitterStateMessage::ModulationMajorType
Enumerator
ModulationMajorType_OTHER 
ModulationMajorType_AMPLITUDE 
ModulationMajorType_AMPLITUDE_ANGLE 
ModulationMajorType_ANGLE 
ModulationMajorType_COMBINATION 
ModulationMajorType_PULSE 
ModulationMajorType_UNMODULATED 
ModulationMajorType_CARRIER_PHASE_SHIFT 
enum TransmitterStateMessage::ModulationSystemType
Enumerator
ModulationSystemType_OTHER 
ModulationSystemType_GENERIC 
ModulationSystemType_HQ 
ModulationSystemType_HQII 
ModulationSystemType_HQIIA 
ModulationSystemType_SINCGARS 
ModulationSystemType_CCTT_SINCGARS 
ModulationSystemType_EPLRS 
ModulationSystemType_JTIDS 
enum TransmitterStateMessage::ReferenceSystem
Enumerator
ReferenceSystem_WORLDCOORD 
ReferenceSystem_ENTITYCOORD 
enum TransmitterStateMessage::StartOfMessage
Enumerator
StartOfMessage_NOT_START 
StartOfMessage_START 
enum TransmitterStateMessage::SyncState
Enumerator
SyncState_COURSE 
SyncState_FINE 
enum TransmitterStateMessage::TransmitState
Enumerator
TransmitState_OFF 
TransmitState_RADIO_ON_NOT_TRANSMITTING 
TransmitState_ON 
enum TransmitterStateMessage::TransmitTerminalPrimaryMode
Enumerator
TransmitTerminalPrimaryMode_NTR 
TransmitTerminalPrimaryMode_JTIDS 
enum TransmitterStateMessage::TransmitTerminalSecondaryMode
Enumerator
TransmitTerminalSecondaryMode_NONE 
TransmitTerminalSecondaryMode_NET_POSITION_REFERENCE 
TransmitTerminalSecondaryMode_PRIMARY_NAVIGATION_CONTROLLER 
TransmitTerminalSecondaryMode_SECONDARY_NAVIGATION_CONTROLLER 

Constructor & Destructor Documentation

TransmitterStateMessage::TransmitterStateMessage ( )
virtual TransmitterStateMessage::~TransmitterStateMessage ( )
virtual

Member Function Documentation

static DtMessage* TransmitterStateMessage::decode ( unsigned char *  buffer,
int  length 
)
static
virtual void TransmitterStateMessage::deserialize ( DtStreamReader &  reader)
protectedvirtual

Reimplemented from DtMessage.

virtual std::vector<unsigned char> TransmitterStateMessage::getAntennaPatternParameters ( )
virtual
virtual AntennaPatternType TransmitterStateMessage::getAntennaPatternType ( )
virtual
virtual unsigned short TransmitterStateMessage::getCryptoKey ( )
virtual
virtual CryptoMode TransmitterStateMessage::getCryptoMode ( )
virtual
virtual CryptoSystem TransmitterStateMessage::getCryptoSystem ( )
virtual
virtual std::string TransmitterStateMessage::getEntityId ( )
virtual
virtual bool TransmitterStateMessage::getFreqHopInUse ( )
virtual
virtual unsigned long long TransmitterStateMessage::getFrequency ( )
virtual
virtual std::string TransmitterStateMessage::getHostObjectId ( )
virtual
virtual InputSource TransmitterStateMessage::getInputSource ( )
virtual
virtual std::vector<unsigned char> TransmitterStateMessage::getModulationParameters ( )
virtual
virtual ModulationType TransmitterStateMessage::getModulationType ( )
virtual
virtual float TransmitterStateMessage::getPower ( )
virtual
virtual bool TransmitterStateMessage::getPseudoNoiseInUse ( )
virtual
virtual DtEntityType TransmitterStateMessage::getRadioEntityType ( )
virtual
virtual unsigned short TransmitterStateMessage::getRadioId ( )
virtual
virtual DtVector32 TransmitterStateMessage::getRelativeAntennaLocation ( )
virtual
virtual bool TransmitterStateMessage::getTimeHopInUse ( )
virtual
virtual float TransmitterStateMessage::getTransmitBandwidth ( )
virtual
virtual TransmitState TransmitterStateMessage::getTransmitState ( )
virtual
virtual DtVector TransmitterStateMessage::getWorldAntennaLocation ( )
virtual
virtual int TransmitterStateMessage::messageSize ( )
virtual

this function needs to be in each derived class for decoding

Get the size of the message data in bytes

Reimplemented from DtMessage.

virtual void TransmitterStateMessage::serialize ( DtStreamWriter &  writer)
protectedvirtual

Reimplemented from DtMessage.

virtual void TransmitterStateMessage::setAntennaPatternParameters ( std::vector< unsigned char >  val)
virtual
virtual void TransmitterStateMessage::setAntennaPatternType ( AntennaPatternType  val)
virtual
virtual void TransmitterStateMessage::setCryptoKey ( unsigned short  val)
virtual
virtual void TransmitterStateMessage::setCryptoMode ( CryptoMode  val)
virtual
virtual void TransmitterStateMessage::setCryptoSystem ( CryptoSystem  val)
virtual
virtual void TransmitterStateMessage::setEntityId ( std::string  val)
virtual
virtual void TransmitterStateMessage::setFreqHopInUse ( bool  val)
virtual
virtual void TransmitterStateMessage::setFrequency ( unsigned long long  val)
virtual
virtual void TransmitterStateMessage::setHostObjectId ( std::string  val)
virtual
virtual void TransmitterStateMessage::setInputSource ( InputSource  val)
virtual
virtual void TransmitterStateMessage::setModulationParameters ( std::vector< unsigned char >  val)
virtual
virtual void TransmitterStateMessage::setModulationType ( ModulationType  val)
virtual
virtual void TransmitterStateMessage::setPower ( float  val)
virtual
virtual void TransmitterStateMessage::setPseudoNoiseInUse ( bool  val)
virtual
virtual void TransmitterStateMessage::setRadioEntityType ( DtEntityType  val)
virtual
virtual void TransmitterStateMessage::setRadioId ( unsigned short  val)
virtual
virtual void TransmitterStateMessage::setRelativeAntennaLocation ( DtVector32  val)
virtual
virtual void TransmitterStateMessage::setTimeHopInUse ( bool  val)
virtual
virtual void TransmitterStateMessage::setTransmitBandwidth ( float  val)
virtual
virtual void TransmitterStateMessage::setTransmitState ( TransmitState  val)
virtual
virtual void TransmitterStateMessage::setWorldAntennaLocation ( DtVector  val)
virtual
static std::string TransmitterStateMessage::theMessageName ( )
static

Member Data Documentation

std::vector<unsigned char> TransmitterStateMessage::myAntennaPatternParameters
protected
AntennaPatternType TransmitterStateMessage::myAntennaPatternType
protected
unsigned short TransmitterStateMessage::myCryptoKey
protected
CryptoMode TransmitterStateMessage::myCryptoMode
protected
CryptoSystem TransmitterStateMessage::myCryptoSystem
protected
std::string TransmitterStateMessage::myEntityId
protected
bool TransmitterStateMessage::myFreqHopInUse
protected
unsigned long long TransmitterStateMessage::myFrequency
protected
std::string TransmitterStateMessage::myHostObjectId
protected
InputSource TransmitterStateMessage::myInputSource
protected
std::vector<unsigned char> TransmitterStateMessage::myModulationParameters
protected
ModulationType TransmitterStateMessage::myModulationType
protected
float TransmitterStateMessage::myPower
protected
bool TransmitterStateMessage::myPseudoNoiseInUse
protected
DtEntityType TransmitterStateMessage::myRadioEntityType
protected
unsigned short TransmitterStateMessage::myRadioId
protected
DtVector32 TransmitterStateMessage::myRelativeAntennaLocation
protected
bool TransmitterStateMessage::myTimeHopInUse
protected
float TransmitterStateMessage::myTransmitBandwidth
protected
TransmitState TransmitterStateMessage::myTransmitState
protected
DtVector TransmitterStateMessage::myWorldAntennaLocation
protected
std::string TransmitterStateMessage::theFullName
staticprotected
The documentation for this class was generated from the following file:
Document ID: Generated on Tue Feb 2 21:02:17 EST 2021 from SVN revision 223668
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)