VR-Link API Documentation for DIS
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtElectromagneticEmissionPdu Class Reference
+ Inheritance diagram for DtElectromagneticEmissionPdu:
+ Collaboration diagram for DtElectromagneticEmissionPdu:

Public Types

enum  { PduStaticSize = 28, DtEmitterSystemStaticSize = 20, DtEmitterBeamStaticSize = 52 }

Public Member Functions

 DtElectromagneticEmissionPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtElectromagneticEmissionPdu (const DtNetElectromagneticEmissionPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
const DtEntityIdentifieremittingEntityId () const
void setEmittingEntityId (const DtEntityIdentifier &id)
const DtEventIDeventId () const
void setEventId (const DtEventID &id)
DtEmissionPduType stateUpdateIndicator () const
void setStateUpdateIndicator (DtEmissionPduType indicator)
int numSystems () const
void setNumSystems (int num)
int systemDataWords (int sysNum, int *retcode=0) const
int numBeams (int sysNum, int *retcode=0) const
void setNumBeams (int sysNum, int numBeams, int *retcode=0)
DtEmitterSysName systemName (int sysNum, int *retcode=0) const
void setSystemName (int sysNum, DtEmitterSysName name, int *retcode=0)
DtEmissionFunc systemFunction (int sysNum, int *retcode=0) const
void setSystemFunction (int sysNum, DtEmissionFunc func, int *retcode=0)
int emitterId (int sysNum, int *retcode=0) const
void setEmitterId (int sysNum, int id, int *retcode=0)
const DtVectorlocation (int sysNum, int *retcode=0) const
void setLocation (int sysNum, const DtVector &loc, int *retcode=0)
int beamDataWords (int sysNum, int beamNum, int *retcode=0) const
int beamId (int sysNum, int beamNum, int *retcode=0) const
void setBeamId (int sysNum, int beamNum, int id, int *retcode=0)
int beamParameterIndex (int sysNum, int beamNum, int *retcode=0) const
void setBeamParameterIndex (int sysNum, int beamNum, int bpIndex, int *retcode=0)
const DtFundamentalParameterDataparameterData (int sysNum, int beamNum, int *retcode=0) const
void setParameterData (int sysNum, int beamNum, const DtFundamentalParameterData &data, int *retcode=0)
int beamFunction (int sysNum, int beamNum, int *retcode=0) const
void setBeamFunction (int sysNum, int beamNum, int func, int *retcode=0)
int numTargetsInBeam (int sysNum, int beamNum, int *retcode=0) const
void setNumTargetsInBeam (int sysNum, int beamNum, int num, int *retcode=0)
DtTrackingJamming trackingAllTargets (int sysNum, int beamNum, int *retcode=0) const
void setTrackingAllTargets (int sysNum, int beamNum, DtTrackingJamming trackJamAll, int *retcode=0)
DtU8 beamStatus (int sysNum, int beamNum, int *retcode=0) const
void setBeamStatus (int sysNum, int beamNum, DtU8 seq, int *retcode=0)
unsigned long jammingModeSequence (int sysNum, int beamNum, int *retcode=0) const
void setJammingModeSequence (int sysNum, int beamNum, unsigned long seq, int *retcode=0)
const DtTrackJamTargettrackJamTarget (int sysNum, int beamNum, int targetNum, int *retcode=0) const
void setTrackJamTarget (int sysNum, int beamNum, int targetNum, const DtTrackJamTarget &targ, int *retcode=0)
virtual void printData () const
 Print the PDU's data (not including header).
virtual void printDataToStream (std::ostream &stream) const
- Public Member Functions inherited from DtStateMsg
 DtStateMsg ()
 default constructor
virtual ~DtStateMsg ()
 destructor
 DtStateMsg (const DtStateMsg &orig)
 copy constructor
DtStateMsgoperator= (const DtStateMsg &orig)
 assignment operator
- Public Member Functions inherited from DtPduWithAttributeRecordSets
 DtPduWithAttributeRecordSets ()
 Constructor.
 DtPduWithAttributeRecordSets (const DtPduWithAttributeRecordSets &orig)
 Constructor.
DtPduWithAttributeRecordSetsoperator= (const DtPduWithAttributeRecordSets &other)
 Assignment operator.
virtual ~DtPduWithAttributeRecordSets ()
 Destructor.
virtual void printToStream (std::ostream &stream) const
 Print the contents of the PDU. This will call DtPdu's printToStream and also call printRecordSets()
virtual void printRecordSets (bool printEntityObjectId=false) const
 Prints the Record Sets to DtInfo.
virtual void printRecordSetsToStream (std::ostream &stream, bool printEntityObjectId=false) const
 Prints the Record Sets to the specified stream.
virtual void addRecord (std::auto_ptr< DtStandardVariableRecord > record, const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
 Adds a Record.
virtual void removeRecord (unsigned int index, const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
 Removes a Record.
virtual void clearRecordSet (const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
 Removes all Records and deletes the recordSet for the given Entity/Object Identifier.
virtual void clearAllRecordSets ()
 Removes all RecordSets.
virtual std::vector
< DtEntityIdentifier
recordSetIdentifiers () const
 Returns a vector of Entity/Object Identifiers. These are the Identifiers for the Record Sets.
virtual void getRecordSetIdentifiers (std::vector< DtEntityIdentifier > &entityIdVector) const
 Returns by reference the vector of Entity/Object Identifiers.
virtual const std::vector
< DtStandardVariableRecord * > & 
records (const DtEntityIdentifier &id=DtEntityIdentifier::nullId()) const
 This will return the Records for a given Entity/Object Identifier.
virtual const
DtAttributeRecordSet
recordSet (const DtEntityIdentifier &id) const
 This will return the Record Set for a given Entity/Object Identifier.
virtual const std::vector
< DtStandardVariableRecord * > 
allRecords () const
 This will return the Records of all Record Sets.
virtual unsigned int numberOfRecords () const
 Returns the number of records for all Record Sets.
virtual unsigned int numberOfRecords (const DtEntityIdentifier &id) const
 Returns the number of records in the Record Set for the given Entity/Object Identifier.
virtual bool containsStandardRecordSets () const
 Returns if this PDU contains Standard Record Sets. (This is only applicable to DIS 7 and higher).
virtual const DtSimulationAddressattributePduSimulationAddress () const
 Returns the Simulation address if an attribute PDU was coupled. Used internally in VR-Link in Reflected Lists.
virtual void setAttributePduSimulationAddress (const DtSimulationAddress &addr)
 Sets the Simulation address if an attribute PDU was coupled. Used internally in VR-Link in Reflected Lists.
virtual void encode ()
 Encode method.
virtual void decode (DtPduFactory *pduFactory=0)
 Decode method.
virtual unsigned int attributeRecordSetsNetSize () const
 Network Size of the all Attribute Record Sets.
virtual unsigned int recordSetsNetSize () const
 Network Size of the all Record Sets.
virtual void setStandardVariableRecordFactory (DtStandardVariableRecordFactory *factory)
 Sets/gets the Standard Variable Record Factory used for decoding.
virtual
DtStandardVariableRecordFactory
standardVariableRecordFactory () const
virtual unsigned int numberOfRecordSets () const
 Gets the number of Attribute Record Sets.
virtual const
DtAttributeRecordSetMap
attributeRecordSetMap () const
 Get the AttributeRecordSet Map.
virtual int computeMasterAttributeRecordType () const
 Get the Master Attribute Record Type (if applicable, this will return MULTIPLES_PRESENT if not)
- Public Member Functions inherited from DtPdu
virtual ~DtPdu ()
 Destructor.
 DtPdu (const DtPdu &pdu, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Copy constructor.
DtPduoperator= (const DtPdu &pdu)
 Assignment operator.
virtual void * packet () const
 Older function that returns a pointer to the network representation.
virtual int status () const
 Get PDU status.
virtual void setVersion (int vers)
 Set/Get protocol version from PDU header.
virtual int protocolVersion () const
virtual void setExerciseId (int id)
 Set/Get exerciseID in PDU header.
virtual int exerciseId () const
virtual DtPduKind kind () const
 Returns PDU kind from PDU header.
virtual DtProtocolFamily protocolFamily () const
 Returns protocol family from PDU header.
virtual void setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
 Set the PDU header's time stamp to reflect time and type.
virtual DtTime timeStamp () const
 Return the time (in seconds past an hour) encoded in the PDU header's time stamp.
virtual DtTimeStampType timeStampType () const
 Return the type of the time stamp, as indicated in PDU header.
virtual void setPduLength (unsigned int length)
 Set the PDU header's length.
virtual unsigned int pduLength () const
 Return the length of the PDU, as indicated in the PDU header.
virtual void setPduStatus (int)
 Set the PDU Status in the PDU header.
virtual int pduStatus () const
 Returns the PDU Status from the PDU header.
virtual void setTransferredEntityIndicator (bool difference)
 Set the Transferred Entity Indicator in the PDU header False is No Difference True is Difference.
virtual bool transferredEntityIndicator () const
 Returns the Transferred Entity Indicator from the PDU header False is No Difference True is Difference.
virtual void setLvcIndicator (DtPduStatusLVCIndicator lvcIndicator)
 Set the LVC Indicator in the PDU header.
virtual DtPduStatusLVCIndicator lvcIndicator () const
 Returns the LVC Indicator from the PDU header.
virtual void setCoupledExtensionIndicator (bool coupled)
 Set the Coupled Extension Indicator in the PDU Header False is Not Coupled True is Coupled.
virtual bool coupledExtensionIndicator () const
 Returns the Coupled Extension Indicator from the PDU Header False is Not Coupled True is Coupled.
virtual void setFireTypeIndicator (DtPduStatusFireTypeIndicator fireTypeIndicator)
 Set the Fire Type Indicator in the PDU header.
virtual
DtPduStatusFireTypeIndicator 
fireTypeIndicator () const
 Returns the Fire Type Indicator from the PDU header.
virtual void setDetonationTypeIndicator (DtPduStatusDetonationTypeIndicator detonationTypeIndicator)
 Set the Detonation Type Indicator in the PDU header.
virtual
DtPduStatusDetonationTypeIndicator 
detonationTypeIndicator () const
 Returns the Detonation Type Indicator from the PDU header.
virtual void setRadioAttachedIndicator (DtPduStatusRadioAttachedIndicator radioAttachedIndicator)
 Set the Radio Attached Indicator in the PDU header.
virtual
DtPduStatusRadioAttachedIndicator 
radioAttachedIndicator () const
 Returns the Radio Attached Indicator from the PDU header.
virtual void setIntercomAttachedIndicator (DtPduStatusIntercomAttachedIndicator intercomAttachedIndicator)
 Set the Intercom Attached Indicator in the PDU header.
virtual
DtPduStatusIntercomAttachedIndicator 
intercomAttachedIndicator () const
 Returns the Intercom Attached Indicator from the PDU header.
virtual void setIffSimulationMode (bool interactive)
 Set the IFF Simulation Mode in the PDU header.
virtual bool iffSimulationMode () const
 Returns the IFF Simulation Mode from the PDU header.
virtual void setActiveInterrogationIndicator (bool active)
 Set the Active Interrogation Indicator in the PDU header.
virtual bool activeInterrogationIndicator () const
 Returns the Active Interrogation Indicator from the PDU header.
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.
virtual DtNetPduHeadernetHeader () const
 Returns a pointer to the PDU's header.
virtual void print () const
 Print the contents of the PDU by calling printToStream(DtInfo).
virtual void printHeader () const
 Print the PDU's header. This calls printHeaderToStream(DtInfo).
virtual void printHeaderToStream (std::ostream &stream) const
 Print the PDU's header to a stream.
virtual void printDataToString (DtString &str) const
virtual void printPduInHexToStream (std::ostream &stream, unsigned int numberOfColumns) const
 Prints the entire PDU's internal buffer to the stream in Hex.
virtual bool isTransientPdu () const
 This method returns true if transient, false if state.
- Public Member Functions inherited from DtBaseMsg
virtual ~DtBaseMsg ()
 Destructor.
 DtBaseMsg (const DtBaseMsg &msg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Copy constructor.
DtBaseMsgoperator= (const DtBaseMsg &msg)
 Assignment.
virtual const char * netRep () const
 Get network representation.
virtual int length () const
 Get size of message.
 DtBaseMsg ()
 Constructor Object is not fully constructed until initMsg is called.
void initMsg (int size, DtBufferPtr bufferPtr)
void initMsg (const void *initial, int size, DtBufferPtr bufferPtr)
virtual void changeSize (int size, bool skipSizeChanged=false)
 Changes the size of the message.
virtual void insertBytes (int offset, int numBytes, bool skipSizeChanged=false)
 Inserts numBytes zeroed-out bytes at the indicated offset into the net rep.
virtual void insertBytes (void *address, int numBytes, bool skipSizeChanged=false)
 Inserts numBytes zeroed-out bytes at the indicated address.
virtual void deleteBytes (int offset, int numBytes, bool skipSizeChanged=false)
 Deletes numBytes bytes at the indicated offset in the net rep.
virtual void deleteBytes (void *address, int numBytes, bool skipSizeChanged=false)
 Deletes numBytes bytes starting at the indicated address.
virtual void clearAll ()
 Zeros out all bytes in the network representation.
virtual void * newInternalBuffer (int size)
 Sets myInternalBuff to point to a malloc'ed buffer of size bytes.

Static Public Member Functions

static DtPducreate (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
static void addCallback (DtExerciseConn *conn, DtElectromagneticEmissionPduCb cb, void *usr)
static void removeCallback (DtExerciseConn *conn, DtElectromagneticEmissionPduCb cb, void *usr)

Protected Member Functions

DtPduKind internalGetPduKind () const
 Returns the PDU kind associated with the derived PDU class.
DtNetSystemDataemitterSystemAddr (int sysNum, int *retcode=0) const
DtNetBeamDataemitterBeamAddr (int sysNum, int beamNum, int *retcode=0) const
DtNetEmitterTrackJamtargetAddr (int sysNum, int beamNum, int targetNum, int *retcode=0) const
int computedSystemDataLength (int sysNum) const
int computedBeamDataLength (int sysNum, int beamNum) const
void printSystem (std::ostream &stream, int i) const
void printBeam (std::ostream &stream, int i, int j) const
int addressInPacket (void *addr) const
int computeStatus () const

Protected Attributes

DtEntityIdentifier myEittingEntityId
DtEventID myEventId
DtVector myLocation
DtFundamentalParameterData myParameterData
DtTrackJamTarget myTrackJamTarget

Member Enumeration Documentation

anonymous enum
Enumerator:
PduStaticSize 
DtEmitterSystemStaticSize 
DtEmitterBeamStaticSize 

Constructor & Destructor Documentation

DtElectromagneticEmissionPdu::DtElectromagneticEmissionPdu ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
DtElectromagneticEmissionPdu::DtElectromagneticEmissionPdu ( const DtNetElectromagneticEmissionPdu initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER,
DtPduFactory pduFactory = 0 
)

Member Function Documentation

static void DtElectromagneticEmissionPdu::addCallback ( DtExerciseConn conn,
DtElectromagneticEmissionPduCb  cb,
void *  usr 
)
static
int DtElectromagneticEmissionPdu::addressInPacket ( void *  addr) const
protected
int DtElectromagneticEmissionPdu::beamDataWords ( int  sysNum,
int  beamNum,
int *  retcode = 0 
) const
int DtElectromagneticEmissionPdu::beamFunction ( int  sysNum,
int  beamNum,
int *  retcode = 0 
) const
int DtElectromagneticEmissionPdu::beamId ( int  sysNum,
int  beamNum,
int *  retcode = 0 
) const
int DtElectromagneticEmissionPdu::beamParameterIndex ( int  sysNum,
int  beamNum,
int *  retcode = 0 
) const
DtU8 DtElectromagneticEmissionPdu::beamStatus ( int  sysNum,
int  beamNum,
int *  retcode = 0 
) const
int DtElectromagneticEmissionPdu::computedBeamDataLength ( int  sysNum,
int  beamNum 
) const
protected
int DtElectromagneticEmissionPdu::computedSystemDataLength ( int  sysNum) const
protected
int DtElectromagneticEmissionPdu::computeStatus ( ) const
protected
static DtPdu* DtElectromagneticEmissionPdu::create ( const DtNetPacket initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER,
DtPduFactory pduFactory = 0 
)
static
DtNetBeamData* DtElectromagneticEmissionPdu::emitterBeamAddr ( int  sysNum,
int  beamNum,
int *  retcode = 0 
) const
protected
int DtElectromagneticEmissionPdu::emitterId ( int  sysNum,
int *  retcode = 0 
) const
DtNetSystemData* DtElectromagneticEmissionPdu::emitterSystemAddr ( int  sysNum,
int *  retcode = 0 
) const
protected
const DtEntityIdentifier& DtElectromagneticEmissionPdu::emittingEntityId ( ) const
const DtEventID& DtElectromagneticEmissionPdu::eventId ( ) const
DtPduKind DtElectromagneticEmissionPdu::internalGetPduKind ( ) const
inlineprotectedvirtual

Returns the PDU kind associated with the derived PDU class.

Implements DtPdu.

References DtElectromagneticEmissionPduKind.

unsigned long DtElectromagneticEmissionPdu::jammingModeSequence ( int  sysNum,
int  beamNum,
int *  retcode = 0 
) const
const DtVector& DtElectromagneticEmissionPdu::location ( int  sysNum,
int *  retcode = 0 
) const
int DtElectromagneticEmissionPdu::numBeams ( int  sysNum,
int *  retcode = 0 
) const
int DtElectromagneticEmissionPdu::numSystems ( ) const
int DtElectromagneticEmissionPdu::numTargetsInBeam ( int  sysNum,
int  beamNum,
int *  retcode = 0 
) const
const DtFundamentalParameterData& DtElectromagneticEmissionPdu::parameterData ( int  sysNum,
int  beamNum,
int *  retcode = 0 
) const
void DtElectromagneticEmissionPdu::printBeam ( std::ostream &  stream,
int  i,
int  j 
) const
protected
virtual void DtElectromagneticEmissionPdu::printData ( ) const
virtual

Print the PDU's data (not including header).

Base DtPdu version just prints hex. Use the printDataToString to put the data into a DtString instead of simply sending the output to stdout. printData() calls printDataToStream(DtInfo).

Reimplemented from DtPdu.

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

Reimplemented from DtPdu.

void DtElectromagneticEmissionPdu::printSystem ( std::ostream &  stream,
int  i 
) const
protected
static void DtElectromagneticEmissionPdu::removeCallback ( DtExerciseConn conn,
DtElectromagneticEmissionPduCb  cb,
void *  usr 
)
static
void DtElectromagneticEmissionPdu::setBeamFunction ( int  sysNum,
int  beamNum,
int  func,
int *  retcode = 0 
)
void DtElectromagneticEmissionPdu::setBeamId ( int  sysNum,
int  beamNum,
int  id,
int *  retcode = 0 
)
void DtElectromagneticEmissionPdu::setBeamParameterIndex ( int  sysNum,
int  beamNum,
int  bpIndex,
int *  retcode = 0 
)
void DtElectromagneticEmissionPdu::setBeamStatus ( int  sysNum,
int  beamNum,
DtU8  seq,
int *  retcode = 0 
)
void DtElectromagneticEmissionPdu::setEmitterId ( int  sysNum,
int  id,
int *  retcode = 0 
)
void DtElectromagneticEmissionPdu::setEmittingEntityId ( const DtEntityIdentifier id)
void DtElectromagneticEmissionPdu::setEventId ( const DtEventID id)
void DtElectromagneticEmissionPdu::setJammingModeSequence ( int  sysNum,
int  beamNum,
unsigned long  seq,
int *  retcode = 0 
)
void DtElectromagneticEmissionPdu::setLocation ( int  sysNum,
const DtVector loc,
int *  retcode = 0 
)
void DtElectromagneticEmissionPdu::setNumBeams ( int  sysNum,
int  numBeams,
int *  retcode = 0 
)
void DtElectromagneticEmissionPdu::setNumSystems ( int  num)
void DtElectromagneticEmissionPdu::setNumTargetsInBeam ( int  sysNum,
int  beamNum,
int  num,
int *  retcode = 0 
)
void DtElectromagneticEmissionPdu::setParameterData ( int  sysNum,
int  beamNum,
const DtFundamentalParameterData data,
int *  retcode = 0 
)
void DtElectromagneticEmissionPdu::setStateUpdateIndicator ( DtEmissionPduType  indicator)
void DtElectromagneticEmissionPdu::setSystemFunction ( int  sysNum,
DtEmissionFunc  func,
int *  retcode = 0 
)
void DtElectromagneticEmissionPdu::setSystemName ( int  sysNum,
DtEmitterSysName  name,
int *  retcode = 0 
)
void DtElectromagneticEmissionPdu::setTrackingAllTargets ( int  sysNum,
int  beamNum,
DtTrackingJamming  trackJamAll,
int *  retcode = 0 
)
void DtElectromagneticEmissionPdu::setTrackJamTarget ( int  sysNum,
int  beamNum,
int  targetNum,
const DtTrackJamTarget targ,
int *  retcode = 0 
)
DtEmissionPduType DtElectromagneticEmissionPdu::stateUpdateIndicator ( ) const
int DtElectromagneticEmissionPdu::systemDataWords ( int  sysNum,
int *  retcode = 0 
) const
DtEmissionFunc DtElectromagneticEmissionPdu::systemFunction ( int  sysNum,
int *  retcode = 0 
) const
DtEmitterSysName DtElectromagneticEmissionPdu::systemName ( int  sysNum,
int *  retcode = 0 
) const
DtNetEmitterTrackJam* DtElectromagneticEmissionPdu::targetAddr ( int  sysNum,
int  beamNum,
int  targetNum,
int *  retcode = 0 
) const
protected
DtTrackingJamming DtElectromagneticEmissionPdu::trackingAllTargets ( int  sysNum,
int  beamNum,
int *  retcode = 0 
) const
const DtTrackJamTarget& DtElectromagneticEmissionPdu::trackJamTarget ( int  sysNum,
int  beamNum,
int  targetNum,
int *  retcode = 0 
) const

Member Data Documentation

DtEntityIdentifier DtElectromagneticEmissionPdu::myEittingEntityId
mutableprotected
DtEventID DtElectromagneticEmissionPdu::myEventId
mutableprotected
DtVector DtElectromagneticEmissionPdu::myLocation
mutableprotected
DtFundamentalParameterData DtElectromagneticEmissionPdu::myParameterData
mutableprotected
DtTrackJamTarget DtElectromagneticEmissionPdu::myTrackJamTarget
mutableprotected

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

Document ID: Generated on Wed Oct 23 22:25:48 EDT 2013 from SVN revision 132765
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)