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

Public Member Functions

 DtJtidsLetRadioSignalInteraction ()
 Default constructor. More...
 
virtual ~DtJtidsLetRadioSignalInteraction ()
 Destructor. More...
 
 DtJtidsLetRadioSignalInteraction (const DtJtidsLetRadioSignalInteraction &orig)
 Copy constructor. More...
 
DtJtidsLetRadioSignalInteractionoperator= (const DtJtidsLetRadioSignalInteraction &orig)
 Assignment operator. More...
 
virtual const char * name () const
 Name of the interaction. (Not necessarily the ClassName from the FOM.) More...
 
virtual void printDataToStream (std::ostream &stream) const
 Print the interaction's data to a stream. More...
 
virtual DtU32 numTadilJWords () const
 Return the number of J-Words in the message. More...
 
virtual const DtLetHeaderletHeader () const
 Set/Get the LET header. More...
 
virtual void setLetHeader (const DtLetHeader &data)
 Set/Get the LET header. More...
 
virtual const DtLetHeaderStructletHeaderRawData () const
 Set/Get the LET header. More...
 
virtual void setLetHeaderRawData (const DtLetHeaderStruct &data)
 Set/Get the LET header. More...
 
virtual const DtTadilJWordStructtadilJWord (DtU32 index) const
 Set/Get a J-Word in the TADIL-J message. More...
 
virtual void setTadilJWord (DtU32 index, const DtTadilJWordStruct &data)
 Set/Get a J-Word in the TADIL-J message. More...
 
- Public Member Functions inherited from DtL16RadioSignalInteraction
 DtL16RadioSignalInteraction ()
 Default constructor. More...
 
virtual ~DtL16RadioSignalInteraction ()
 Destructor. More...
 
 DtL16RadioSignalInteraction (const DtL16RadioSignalInteraction &orig)
 Copy constructor. More...
 
DtL16RadioSignalInteractionoperator= (const DtL16RadioSignalInteraction &orig)
 Assignment operator. More...
 
virtual void setPerceivedTransmitTimeFraction (DtU32 val)
 Set/Get the perceived transmit time (integer portion). More...
 
virtual DtU32 perceivedTransmitTimeFraction () const
 
virtual void setNpgNumber (DtU16 npg)
 Set/Get the NPG Number. More...
 
virtual DtU16 npgNumber () const
 Set/Get the NPG Number. More...
 
virtual void setNetNumber (DtU8 net)
 Set/Get the Net Number. More...
 
virtual DtU8 netNumber () const
 Set/Get the Net Number. More...
 
virtual void setTsecCvll (DtU8 val)
 Set/Get the TSEC CVLL. More...
 
virtual DtU8 tsecCvll () const
 Set/Get the TSEC CVLL. More...
 
virtual void setMsecCvll (DtU8 val)
 Set/Get the MSEC CVLL. More...
 
virtual DtU8 msecCvll () const
 Set/Get the MSEC CVLL. More...
 
virtual void setLink16MessageType (DtLink16MessageTypeEnum val)
 Set/Get the Message Type. More...
 
virtual DtLink16MessageTypeEnum link16MessageType () const
 Set/Get the Message Type. More...
 
virtual void setTimeIdSlotNumber (DtU32 val)
 Set/Get the Time Slot ID Slot Number. More...
 
virtual DtU32 timeIdSlotNumber () const
 Set/Get the Time Slot ID Slot Number. More...
 
virtual void setTimeIdEpochNumber (DtU8 val)
 Set/Get the Time Slot ID Epoch Number. More...
 
virtual DtU8 timeIdEpochNumber () const
 Set/Get the Time Slot ID Epoch Number. More...
 
virtual void setPerceivedTransmitTimeInteger (DtU32 val)
 Set/Get the perceived transmit time (integer portion). More...
 
virtual DtU32 perceivedTransmitTimeInteger () const
 Set/Get the perceived transmit time (integer portion). More...
 
- Public Member Functions inherited from DtSignalInteraction
 DtSignalInteraction ()
 Default constructor. More...
 
virtual ~DtSignalInteraction ()
 Destructor. More...
 
 DtSignalInteraction (const DtSignalInteraction &orig)
 Copy constructor. More...
 
DtSignalInteractionoperator= (const DtSignalInteraction &orig)
 Assignment operator. More...
 
virtual void printData () const
 Print the interaction's data. More...
 
virtual void setNumSamples (DtU32 count)
 Set/Get sample count. More...
 
virtual DtU32 numSamples () const
 
virtual void setTdlType (DtTacticalDataLinkType link)
 Set/Get tactical data link. More...
 
virtual DtTacticalDataLinkType tdlType () const
 
virtual unsigned long streamTag (DtLongWordPortion upperLower=DtLowerWord) const
 Get either the upper or lower word of the 64 bit StreamTag. More...
 
virtual void setRadioId (const DtGlobalObjectDesignator &id)
 Set/Get Host radio id. More...
 
virtual const
DtGlobalObjectDesignator
radioId () const
 Set/Get Host radio id. More...
 
virtual void setSampleRate (DtU32 rate)
 Set/Get sample rate. More...
 
virtual DtU32 sampleRate () const
 Set/Get sample rate. More...
 
virtual void setNumDataBytes (DtU16 len)
 Set/Get signal data length in bytes. More...
 
virtual DtU16 numDataBytes () const
 Set/Get signal data length in bytes. More...
 
virtual void setNumDataBits (DtU16 len)
 Set/Get signal data length in bits. More...
 
virtual DtU16 numDataBits () const
 Set/Get signal data length in bits. More...
 
virtual void setData (const void *data, int numBytes)
 Set/Get signal data. More...
 
virtual const void * data () const
 Set/Get signal data. More...
 
virtual DtU8 dataByte (int byteNum) const
 Set/Get the byteNum'th data byte. More...
 
virtual void setDataByte (int byteNum, DtU8 data)
 Set/Get the byteNum'th data byte. More...
 
virtual void setEncodingType (DtEncodingType encoding)
 Set/Get encoding type. More...
 
virtual DtEncodingType encodingType () const
 Set/Get encoding type. More...
 
virtual DtEncodingClass encodingClass () const
 Set/Get encoding class. More...
 
virtual void setEncodingClass (DtEncodingClass encodingClass)
 Set/Get encoding class. More...
 
virtual void setTdlMessageCount (DtU16 count)
 Set/Get TDL message count. More...
 
virtual DtU16 tdlMessageCount () const
 Set/Get TDL message count. More...
 
virtual void setProtocolId (DtUserProtocol id)
 Set/Get user protocol id. More...
 
virtual DtUserProtocol protocolId () const
 Set/Get user protocol id. More...
 
virtual void setDatabaseIndex (DtU32 index)
 Set/Get database index. More...
 
virtual DtU32 databaseIndex () const
 Set/Get database index. More...
 
virtual void setDuration (DtU32 duration)
 Set/Get duration. More...
 
virtual DtU32 duration () const
 Set/Get duration. More...
 
virtual void setStartOffset (DtU32 offset)
 Set/Get start offset. More...
 
virtual DtU32 startOffset () const
 Set/Get start offset. More...
 
virtual void setStreamTag (unsigned long upper, unsigned long lower)
 Set the Stream Tag, either as upper and lower word, or as full 64 bit integer. More...
 
virtual void setStreamTag (unsigned long st)
 Set the Stream Tag, either as upper and lower word, or as full 64 bit integer. More...
 
- Public Member Functions inherited from DtInteractionWithEncDec
 DtInteractionWithEncDec ()
 default constructor More...
 
virtual ~DtInteractionWithEncDec ()
 destructor More...
 
 DtInteractionWithEncDec (const DtInteractionWithEncDec &orig)
 copy constructor More...
 
DtInteractionWithEncDecoperator= (const DtInteractionWithEncDec &orig)
 assignment operator More...
 
virtual void setExConn (DtExerciseConn *exConn, DtInterClassDesc *classDesc=NULL)
 Sets the interaction's ExerciseConn and class descriptor. More...
 
virtual const
RTI::ParameterHandleValueMap & 
phvm () const
 Get the parameter handle value pair set for the interaction. More...
 
virtual void setFromPhvm (const RTI::ParameterHandleValueMap &pvList)
 Set contents from a parameter handle value pair set. More...
 
virtual void useThese (DtInteractionEncoder *enc, DtInteractionDecoder *dec, DtInteractionRep *data)
 Specify an encoder, decoder, and interaction data repository to use in encoding and decoding. More...
 
virtual DtInteractionEncoderencoder () const
 Return the encoder we are using. More...
 
virtual DtInteractionDecoderdecoder () const
 Return the decoder we are using. More...
 
virtual void setParameterByHandle (const RTI::ParameterHandle &attrHdl, const char *attrValue, unsigned size)
 Set the Parameter with the given handle. More...
 
virtual const char * getParameterByHandle (const RTI::ParameterHandle &attrHdl, unsigned &size) const
 Get a pointer to Parameter value for the Parameter with the given handle. More...
 
virtual void setParameterByName (const DtString &name, const char *attrValue, unsigned size)
 Set the Parameter with the given name. More...
 
virtual const char * getParameterByName (const DtString &name, unsigned &size) const
 Get a pointer to Parameter value for the Parameter with the given name. More...
 
- Public Member Functions inherited from DtInteraction
 DtInteraction ()
 default constructor More...
 
virtual ~DtInteraction ()
 destructor More...
 
 DtInteraction (const DtInteraction &orig)
 copy constructor More...
 
DtInteractionoperator= (const DtInteraction &orig)
 assignment operator More...
 
virtual RTI::InteractionClassHandle interactionClassHandle () const
 Get the interaction class handle. Returns 0 if no classDesc. More...
 
virtual char * interactionClassName () const
 Get the interaction class name. Returns NULL if no classDesc. More...
 
virtual int numParameters () const
 Get the number of parameters. Returns 0 if no classDesc. More...
 
virtual bool neededByFederation () const
 Returns true if the interaction class is needed by the federation false otherwise. More...
 
virtual void print () const
 Print the interaction's host rep data, including header. More...
 
virtual void printToStream (std::ostream &stream) const
 Print the interaction to a stream. More...
 
virtual void printHeader () const
 Print the header info. More...
 
virtual void printHeaderToStream (std::ostream &stream) const
 Print the header info to a stream. More...
 
virtual void printDataToString (DtString &buff) const
 Print the interaction's data to the string provided. More...
 
virtual void printParams (bool withHex) const
 Print the header followed by the interaction's parameters. More...
 
virtual void printParamsToStream (std::ostream &stream, bool withHex) const
 Print the header followed by the interaction's parameters to a stream. More...
 
virtual DtExerciseConnexerciseConn () const
 Get the current exercise connection. More...
 
virtual DtInterClassDescclassDesc () const
 Get the current class descriptor we're using for this interaction. More...
 
virtual bool customTagSet () const
 Get whether a custom tag has been set on the interaction or not. More...
 
virtual void setCustomTag (const RTI::VariableLengthData &a_tag)
 Set the user-defined tag. More...
 
virtual void setTag (const RTI::VariableLengthData &tag)
 Set the user-defined tag. More...
 
virtual const
RTI::VariableLengthData & 
tag () const
 Get the user-defined tag. More...
 
virtual const
RTI::RegionHandleSet * 
conveyedRegion () const
 Get & Set the conveyed region of the reflected state message. More...
 
virtual void setConveyedRegion (const RTI::RegionHandleSet *sentRegionHandleSet)
 
virtual void setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
 Set the time of validity of the message, and whether this represents relative or absolute time. More...
 
virtual DtTime timeStamp () const
 Return the time of validity of the message (in seconds past an hour) as set by setTimeStamp. More...
 
virtual DtTimeStampType timeStampType () const
 Return the type of the time stamp. More...
 
virtual DtTime guessTimeValid (DtTime referenceTime) const
 Since timestamp only represents number of seconds past the hour, guessTimeValid chooses the hour that would make the timestamp closest to reference time, and returns a time that is timestamp seconds past that hour. More...
 
virtual void setFedTime (const RTI::LogicalTime &ft)
 This is used for TSO interactions. More...
 
virtual const RTI::LogicalTime * fedTime () const
 When the interaction is received, if the federate sending the interaction had TSO set then the fedTime will be set. More...
 
virtual void setMessageRetractionHandle (const RTI::MessageRetractionHandle &handle)
 Get/Set the MessageRetractionHandle. More...
 
virtual
RTI::MessageRetractionHandle 
messageRetractionHandle () const
 Get the message retraction handle. For more info see setMessageRetractionHandle. More...
 

Static Public Member Functions

static DtInteractioncreate ()
 
static void addCallback (DtExerciseConn *conn, DtJtidsLetRadioSignalInteractionCb cb, void *usr)
 
static void removeCallback (DtExerciseConn *conn, DtJtidsLetRadioSignalInteractionCb cb, void *usr)
 
- Static Public Member Functions inherited from DtL16RadioSignalInteraction
static DtInteractioncreate ()
 
static void addCallback (DtExerciseConn *conn, DtL16RadioSignalInteractionCb cb, void *usr)
 
static void removeCallback (DtExerciseConn *conn, DtL16RadioSignalInteractionCb cb, void *usr)
 
- Static Public Member Functions inherited from DtSignalInteraction
static DtInteractioncreate ()
 Create a DtSignalInteraction. More...
 
static void addCallback (DtExerciseConn *conn, DtSignalInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
 Add (register)/Remove (deregister) function to be called when interaction occurs. More...
 
static void removeCallback (DtExerciseConn *conn, DtSignalInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
 
- Static Public Member Functions inherited from DtInteraction
static void setTagIsAsciiTime (bool val)
 Set/Get flag that tells us whether we're using the RPR FOM convention that the UserDefinedTag in updates and interactions represents a DIS-style timestamp. More...
 
static bool tagIsAsciiTime ()
 
static void addCallback (DtExerciseConn *conn, const std::vector< DtString > *classes, DtReceiveInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
 Register/Deregister callback function cb with conn, on all interaction class name (char*) contained in classes. More...
 
static void removeCallback (DtExerciseConn *conn, const std::vector< DtString > *classes, DtReceiveInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
 
static void addCallback (DtExerciseConn *conn, const char *className, DtReceiveInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
 Can be used instead of above for a single class. More...
 
static void removeCallback (DtExerciseConn *conn, const char *className, DtReceiveInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
 

Protected Member Functions

virtual const char * interactionClassToUse (DtExerciseConn *exConn) const
 Virtual function override. More...
 
virtual DtInteractionDecodercreateDecoder (DtExerciseConn *exConn) const
 Virtual function override. More...
 
virtual DtInteractionEncodercreateEncoder (DtExerciseConn *exConn) const
 Virtual function override. More...
 
- Protected Member Functions inherited from DtInteractionWithEncDec
virtual DtInteractionDecoderdecoderToUse (DtExerciseConn *exConn) const
 Returns a decoder to use for decoding the interaction. More...
 
virtual DtInteractionEncoderencoderToUse (DtExerciseConn *exConn) const
 Returns an encoder to use for encoding the interaction. More...
 
- Protected Member Functions inherited from DtInteraction
virtual
RTI::ParameterHandleValueMap & 
privPvList () const
 Returns a pointer to a private pvList that can be used as a return value by phvps. More...
 
DtInteractionself () const
 Get rid of const-ness on the "this" pointer in order to access non-const functions from const member functions (such as simple accessors). More...
 

Protected Attributes

DtLetHeader myLetHeader
 The LET header. More...
 
std::vector< DtTadilJWordStructmyTadiljMessageData
 The TADILJ message. More...
 
- Protected Attributes inherited from DtL16RadioSignalInteraction
DtU16 myNpgNumber
 
DtU8 myNetNumber
 
DtU8 myTsecCvll
 
DtU8 myMsecCvll
 
DtLink16MessageTypeEnum myMessageType
 
DtU32 myTimeIdSlotNum
 
DtU8 myTimeIdEpochNum
 
DtU32 myTimeInteger
 
DtU32 myTimeFraction
 
- Protected Attributes inherited from DtSignalInteraction
DtGlobalObjectDesignator myHostRadioId
 
DtU16 mySignalDataLength
 
DtU8mySignalData
 bits More...
 
DtTacticalDataLinkType myTacticalDataLink
 
DtU16 myTDLMessageCount
 
DtUserProtocol myUserProtocolId
 
DtU32 myDatabaseIndex
 
DtU32 myDuration
 
DtU32 myStartOffset
 
DtEncodingType myEncodingType
 
DtEncodingClass myEncodingClass
 
DtU32 mySampleRate
 
DtU32 mySampleCount
 
DtU32 myStreamTagHi
 Stream tag unsigned long long. More...
 
DtU32 myStreamTagLo
 
- Protected Attributes inherited from DtInteractionWithEncDec
DtInteractionDecodermyDecoder
 
DtInteractionEncodermyEncoder
 
DtInteractionRep * myData
 
std::map< RTI::ParameterHandle,
DtGenericParameterInfo * > 
myParametersByHandle
 parameters by handle. More...
 
- Protected Attributes inherited from DtInteraction
DtInterClassDescmyClassDesc
 
DtExerciseConnmyExConn
 
DtTime myTime
 
DtTimeStampType myTimeType
 
RTI::LogicalTime * myFedTime
 
RTI::ParameterHandleValueMap myPvList
 
RTI::MessageRetractionHandle myRetractionHandle
 
RTI::VariableLengthData myTag
 
const RTI::RegionHandleSet * myConveyedRegion
 
bool myCustomTagSet
 

Additional Inherited Members

- Static Protected Attributes inherited from DtL16RadioSignalInteraction
static const DtU32 theMaxTimeIdSlotNum
 
- Static Protected Attributes inherited from DtInteraction
static bool theTagIsAsciiTime
 

Constructor & Destructor Documentation

DtJtidsLetRadioSignalInteraction::DtJtidsLetRadioSignalInteraction ( )

Default constructor.

virtual DtJtidsLetRadioSignalInteraction::~DtJtidsLetRadioSignalInteraction ( )
virtual

Destructor.

DtJtidsLetRadioSignalInteraction::DtJtidsLetRadioSignalInteraction ( const DtJtidsLetRadioSignalInteraction orig)

Copy constructor.

Member Function Documentation

static void DtJtidsLetRadioSignalInteraction::addCallback ( DtExerciseConn conn,
DtJtidsLetRadioSignalInteractionCb  cb,
void *  usr 
)
static
static DtInteraction* DtJtidsLetRadioSignalInteraction::create ( )
static
virtual DtInteractionDecoder* DtJtidsLetRadioSignalInteraction::createDecoder ( DtExerciseConn exConn) const
protectedvirtual

Virtual function override.

Creates and returns a decoder to be used by setFromPhvps to decode a ParameterHandleValuePairSet into this interaction. Implementing this function is required, unless you would like to rely on the default behavior - which is to obtain a new instance of the right decoder from the FOM Mapper. If you choose this option, you must configure the FOM Mapper so that it can correctly provide this object.

Reimplemented from DtL16RadioSignalInteraction.

virtual DtInteractionEncoder* DtJtidsLetRadioSignalInteraction::createEncoder ( DtExerciseConn exConn) const
protectedvirtual

Virtual function override.

Creates and returns an encoder to be used by phvps to encode the data in this interaction into a ParameterHandleValuePairSet. Implementing this function is required, unless you would like to rely on the default behavior - which is to obtain a new instance of the right encoder from the FOM Mapper. If you choose this option, you must configure the FOM Mapper so that it can correctly provide this object.

Reimplemented from DtL16RadioSignalInteraction.

virtual const char* DtJtidsLetRadioSignalInteraction::interactionClassToUse ( DtExerciseConn exConn) const
protectedvirtual

Virtual function override.

Returns the name of the FOM class to use to represent this interaction when sending. It is called from within setExConn, when that function is called by DtExerciseConn::send. Implementing this function is required unless you would like to rely on the default behavior - which is to obtain the class to use from the FOM Mapper. If you choose this option, you must configure the FomMapper so that it can correctly provide this information.

Reimplemented from DtL16RadioSignalInteraction.

virtual const DtLetHeader& DtJtidsLetRadioSignalInteraction::letHeader ( ) const
virtual

Set/Get the LET header.

virtual const DtLetHeaderStruct& DtJtidsLetRadioSignalInteraction::letHeaderRawData ( ) const
virtual

Set/Get the LET header.

virtual const char* DtJtidsLetRadioSignalInteraction::name ( ) const
virtual

Name of the interaction. (Not necessarily the ClassName from the FOM.)

Reimplemented from DtL16RadioSignalInteraction.

virtual DtU32 DtJtidsLetRadioSignalInteraction::numTadilJWords ( ) const
virtual

Return the number of J-Words in the message.

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

Assignment operator.

virtual void DtJtidsLetRadioSignalInteraction::printDataToStream ( std::ostream &  stream) const
virtual

Print the interaction's data to a stream.

Reimplemented from DtL16RadioSignalInteraction.

static void DtJtidsLetRadioSignalInteraction::removeCallback ( DtExerciseConn conn,
DtJtidsLetRadioSignalInteractionCb  cb,
void *  usr 
)
static
virtual void DtJtidsLetRadioSignalInteraction::setLetHeader ( const DtLetHeader data)
virtual

Set/Get the LET header.

virtual void DtJtidsLetRadioSignalInteraction::setLetHeaderRawData ( const DtLetHeaderStruct data)
virtual

Set/Get the LET header.

virtual void DtJtidsLetRadioSignalInteraction::setTadilJWord ( DtU32  index,
const DtTadilJWordStruct data 
)
virtual

Set/Get a J-Word in the TADIL-J message.

virtual const DtTadilJWordStruct* DtJtidsLetRadioSignalInteraction::tadilJWord ( DtU32  index) const
virtual

Set/Get a J-Word in the TADIL-J message.

Member Data Documentation

DtLetHeader DtJtidsLetRadioSignalInteraction::myLetHeader
protected

The LET header.

std::vector<DtTadilJWordStruct> DtJtidsLetRadioSignalInteraction::myTadiljMessageData
protected

The TADILJ message.


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

Document ID: Generated on Tue Aug 10 00:12:31 EDT 2021 from SVN revision 232765
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)