VR-Link API Documentation for HLA 1.3
Classes | Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes
DtLink16Signal Class Reference

The DtLink16Signal class is a helper class that is used to assist the user in setting Link16 data as defined by the SISO-STD-002-2006 document. More...

+ Collaboration diagram for DtLink16Signal:

List of all members.

Classes

struct  DtNetLink16SignalFields
 This is the net structure that's used to encode the Link16 fields in the data section of the signal PDU/interaction. More...

Public Member Functions

 DtLink16Signal ()
 Default constructor.
 DtLink16Signal (const DtSignalInteraction *signal)
 Constructor that takes a signal interaction.
virtual ~DtLink16Signal ()
 Destructor.
virtual void encode (DtSignalInteraction *inter, int numJWords, const void *data, int sizeOfData)
 Encodes the Link 16 data contained in this class into the interaction passed in.
virtual void * decode (const DtSignalInteraction *inter)
 Decodes the interaction passed in, into this class.
virtual void setNpgNumber (DtU16 npg)
 Set/Get the NPG Number.
virtual DtU16 npgNumber () const
 Set/Get the NPG Number.
virtual void setNetNumber (DtU8 net)
 Set/Get the Net Number.
virtual DtU8 netNumber () const
 Set/Get the Net Number.
virtual void setTsecCvll (DtU8 val)
 Set/Get the TSEC CVLL.
virtual DtU8 tsecCvll () const
 Set/Get the TSEC CVLL.
virtual void setMsecCvll (DtU8 val)
 Set/Get the MSEC CVLL.
virtual DtU8 msecCvll () const
 Set/Get the MSEC CVLL.
virtual void setLink16MessageType (DtLink16MessageTypeEnum val)
 Set/Get the Message Type.
virtual DtLink16MessageTypeEnum link16MessageType () const
 Set/Get the Message Type.
virtual void setTimeIdSlotNumber (DtU32 val)
 Set/Get the Time Slot ID Slot Number.
virtual DtU32 timeIdSlotNumber () const
 Set/Get the Time Slot ID Slot Number.
virtual void setTimeIdEpochNumber (DtU8 val)
 Set/Get the Time Slot ID Epoch Number.
virtual DtU8 timeIdEpochNumber () const
 Set/Get the Time Slot ID Epoch Number.
virtual void setPerceivedTransmitTimeInteger (DtU32 val)
 Set/Get the perceived transmit time (integer portion).
virtual DtU32 perceivedTransmitTimeInteger () const
 Set/Get the perceived transmit time (integer portion).
virtual void setPerceivedTransmitTimeFraction (DtU32 val)
 Set/Get the perceived transmit time (fraction portion).
virtual DtU32 perceivedTransmitTimeFraction () const
 Set/Get the perceived transmit time (fraction portion).

Static Public Member Functions

static char * link16SignalClassChooser (DtExerciseConn *exConn, const DtInteraction &inter)
 The Link-16 chooser class.
static void setInteractionClasses (DtExerciseConn *exConn)
 Tells the exConn's FOM Mapper to subscribe to all the Link 16 interactions.
static void setUpRprFomMapper (DtExerciseConn *exConn)
 Sets up the exConn's RPR FOM Mapper to subscribe to/send all of the Link 16 messages.

Protected Attributes

DtU16 myNpgNumber
DtU8 myNetNumber
DtU8 myTsecCvll
DtU8 myMsecCvll
DtLink16MessageTypeEnum myMessagetype
DtU32 myTimeSlotId
DtU32 myTimeInteger
DtU32 myTimeFraction

Static Protected Attributes

static const char * theInteractionClasses [8]

Detailed Description

The DtLink16Signal class is a helper class that is used to assist the user in setting Link16 data as defined by the SISO-STD-002-2006 document.

The user is responsible for setting the data for the actual Link16 message, and passes the message data into the encode method, which will place it after the Link 16 fields in the data section of the interaction/PDU.


Constructor & Destructor Documentation

Default constructor.

Constructor that takes a signal interaction.

Calls decode, passing in the signal.

virtual DtLink16Signal::~DtLink16Signal ( ) [virtual]

Destructor.


Member Function Documentation

virtual void* DtLink16Signal::decode ( const DtSignalInteraction inter) [virtual]

Decodes the interaction passed in, into this class.

Returns the data section of the interaction, after the Link-16 fields. The size of this data can be determined by the DtSignalInteraction's numDataBytes() method minus 20 (the size of the Link 16 data).

virtual void DtLink16Signal::encode ( DtSignalInteraction inter,
int  numJWords,
const void *  data,
int  sizeOfData 
) [virtual]

Encodes the Link 16 data contained in this class into the interaction passed in.

The number of J-Words needs to be specified, along with the data (Link-16 message), and the size of that data, in bytes.

Set/Get the Message Type.

In HLA, this is used to determine what type of Link 16 Signal interaction is sent.

static char* DtLink16Signal::link16SignalClassChooser ( DtExerciseConn exConn,
const DtInteraction inter 
) [static]

The Link-16 chooser class.

This function is used with a FOM Mapper to choose the correct FOM type to send, when sending a Link 16 signal interaction. This is done based on the Link 16 message type.

virtual DtU8 DtLink16Signal::msecCvll ( ) const [virtual]

Set/Get the MSEC CVLL.

virtual DtU8 DtLink16Signal::netNumber ( ) const [virtual]

Set/Get the Net Number.

virtual DtU16 DtLink16Signal::npgNumber ( ) const [virtual]

Set/Get the NPG Number.

Set/Get the perceived transmit time (fraction portion).

Set/Get the perceived transmit time (integer portion).

static void DtLink16Signal::setInteractionClasses ( DtExerciseConn exConn) [static]

Tells the exConn's FOM Mapper to subscribe to all the Link 16 interactions.

Set/Get the Message Type.

In HLA, this is used to determine what type of Link 16 Signal interaction is sent.

virtual void DtLink16Signal::setMsecCvll ( DtU8  val) [virtual]

Set/Get the MSEC CVLL.

virtual void DtLink16Signal::setNetNumber ( DtU8  net) [virtual]

Set/Get the Net Number.

virtual void DtLink16Signal::setNpgNumber ( DtU16  npg) [virtual]

Set/Get the NPG Number.

Set/Get the perceived transmit time (fraction portion).

virtual void DtLink16Signal::setPerceivedTransmitTimeInteger ( DtU32  val) [virtual]

Set/Get the perceived transmit time (integer portion).

virtual void DtLink16Signal::setTimeIdEpochNumber ( DtU8  val) [virtual]

Set/Get the Time Slot ID Epoch Number.

virtual void DtLink16Signal::setTimeIdSlotNumber ( DtU32  val) [virtual]

Set/Get the Time Slot ID Slot Number.

virtual void DtLink16Signal::setTsecCvll ( DtU8  val) [virtual]

Set/Get the TSEC CVLL.

static void DtLink16Signal::setUpRprFomMapper ( DtExerciseConn exConn) [static]

Sets up the exConn's RPR FOM Mapper to subscribe to/send all of the Link 16 messages.

Only this method needs to be called after exercise connection instantiation to use the Link 16 signal interactions, provided they are in the FOM, derived from the RawBinaryRadioSignal interaction class.

virtual DtU8 DtLink16Signal::timeIdEpochNumber ( ) const [virtual]

Set/Get the Time Slot ID Epoch Number.

virtual DtU32 DtLink16Signal::timeIdSlotNumber ( ) const [virtual]

Set/Get the Time Slot ID Slot Number.

virtual DtU8 DtLink16Signal::tsecCvll ( ) const [virtual]

Set/Get the TSEC CVLL.


Member Data Documentation

const char* DtLink16Signal::theInteractionClasses[8] [static, protected]

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

Document ID: Generated on Mon May 14 08:06:18 EDT 2012 from SVN revision 114750
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)