DtTransmitterPdu Class Reference

The transmitter pdu. More...

Inheritance diagram for DtTransmitterPdu:

Collaboration diagram for DtTransmitterPdu:

Public Types
enum	{ PduStaticSize = 104 }

Public Member Functions
	DtTransmitterPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtTransmitterPdu (const DtNetTransmitterPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
virtual	~DtTransmitterPdu ()
	destructor
const DtEntityIdentifier &	entityId () const
void	setEntityId (const DtEntityIdentifier &id)
unsigned int	radioId () const
void	setRadioId (unsigned int id)
const DtRadioEntityType &	radioEntityType () const
void	setRadioEntityType (const DtRadioEntityType &type)
void	setRadioEntityType (const DtEntityType &type)
DtRadioTransmitState	transmitState () const
void	setTransmitState (DtRadioTransmitState state)
DtRadioInputSource	inputSource () const
void	setInputSource (DtRadioInputSource source)
const DtVector &	worldAntennaLoc () const
void	setWorldAntennaLoc (const DtVector &loc)
const DtVector &	relativeAntennaLoc () const
void	setRelativeAntennaLoc (const DtVector &loc)
DtAntennaPatternType	antennaPatternType () const
void	setAntennaPatternType (DtAntennaPatternType type)
int	antennaParamsLength () const
float	bandwidth () const
void	setBandwidth (float bw)
float	power () const
void	setPower (float power)
const DtModulationType &	modulationType () const
void	setModulationType (const DtModulationType &type)
DtRadioCryptoSystem	cryptoSystem () const
void	setCryptoSystem (DtRadioCryptoSystem sys)
int	cryptoKeyId () const
void	setCryptoKeyId (int key)
int	modulationParamsLength () const
void	setModulationParams (void *networkRepresentation, int size)
void	getNetModulationParams (void *destination) const
void	getNetAntennaParams (void *destination) const
const DtBeamAntennaPatternRecord &	antennaParams () const
void	setAntennaPatternParams (void *networkRepresentation, int size)
void	setAntennaPatternParams (const DtBeamAntennaPatternRecord &rec)
virtual void	printData () const
	Print the PDU's data (not including header).
virtual void	printDataToStream (std::ostream &stream) const
unsigned long	frequency (int upperLower) const
	Deprecated Set/Get the frequency as upper and lower word.
void	setFrequency (unsigned long upper, unsigned long lower)
	Deprecated Set/Get the frequency as upper and lower word.
void	setFrequency (DtU64 freq)
	Get/Set the frequency.
DtU64	frequency () const
	Get/Set the frequency.
Public Member Functions inherited from DtStateMsg
	DtStateMsg ()
	default constructor
virtual	~DtStateMsg ()
	destructor
	DtStateMsg (const DtStateMsg &orig)
	copy constructor
DtStateMsg &	operator= (const DtStateMsg &orig)
	assignment operator
Public Member Functions inherited from DtPduWithAttributeRecordSets
	DtPduWithAttributeRecordSets ()
	Constructor.
	DtPduWithAttributeRecordSets (const DtPduWithAttributeRecordSets &orig)
	Constructor.
DtPduWithAttributeRecordSets &	operator= (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 DtSimulationAddress &	attributePduSimulationAddress () 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.
DtPdu &	operator= (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 DtNetPduHeader *	netHeader () 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.
DtBaseMsg &	operator= (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 DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
static void	addCallback (DtExerciseConn *conn, DtTransmitterPduCb cb, void *usr)
static void	removeCallback (DtExerciseConn *conn, DtTransmitterPduCb cb, void *usr)

Protected Member Functions
DtPduKind	internalGetPduKind () const
	Returns the PDU kind associated with the derived PDU class.
void	setModulationParamsLength (int length)
void	setAntennaParamsLength (int length)
void *	antennaParamsAddr () const
void *	modulationParamsAddr () const
virtual void	printModulationParams (std::ostream &stream) const
virtual void	printAntennaParams (std::ostream &stream) const

Protected Attributes
DtEntityIdentifier	theId
DtRadioEntityType	theType
DtVector	wLoc
DtVector	rLoc
DtModulationType	modType
DtBeamAntennaPatternRecord	pat

Private Member Functions
virtual void	printModulationParams () const
	Since these functions will not be called any more it's better if the intent was to extend their functionality that it now fails.
virtual void	printAntennaParams () const

Detailed Description

The transmitter pdu.

Member Enumeration Documentation

anonymous enum

Enumerator:

PduStaticSize

Constructor & Destructor Documentation

DtTransmitterPdu::DtTransmitterPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

DtTransmitterPdu::DtTransmitterPdu	(	const DtNetTransmitterPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER,
		DtPduFactory *	pduFactory = 0
	)

virtual DtTransmitterPdu::~DtTransmitterPdu ( )

virtual

destructor

Member Function Documentation

static void DtTransmitterPdu::addCallback ( DtExerciseConn *  conn, DtTransmitterPduCb  cb, void *  usr  )

static

const DtBeamAntennaPatternRecord& DtTransmitterPdu::antennaParams

(

)

const

void* DtTransmitterPdu::antennaParamsAddr ( ) const

protected

int DtTransmitterPdu::antennaParamsLength

(

)

const

DtAntennaPatternType DtTransmitterPdu::antennaPatternType

(

)

const

float DtTransmitterPdu::bandwidth

(

)

const

static DtPdu* DtTransmitterPdu::create ( const DtNetPacket *  initial, DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory *  pduFactory = 0  )

static

int DtTransmitterPdu::cryptoKeyId

(

)

const

DtRadioCryptoSystem DtTransmitterPdu::cryptoSystem

(

)

const

const DtEntityIdentifier& DtTransmitterPdu::entityId

(

)

const

unsigned long DtTransmitterPdu::frequency

(

int

upperLower

)

const

Deprecated Set/Get the frequency as upper and lower word.

DtU64 DtTransmitterPdu::frequency

(

)

const

Get/Set the frequency.

void DtTransmitterPdu::getNetAntennaParams

(

void *

destination

)

const

void DtTransmitterPdu::getNetModulationParams

(

void *

destination

)

const

DtRadioInputSource DtTransmitterPdu::inputSource

(

)

const

DtPduKind DtTransmitterPdu::internalGetPduKind ( ) const

inlineprotectedvirtual

Returns the PDU kind associated with the derived PDU class.

Implements DtPdu.

References DtTransmitterPduKind.

void* DtTransmitterPdu::modulationParamsAddr ( ) const

protected

int DtTransmitterPdu::modulationParamsLength

(

)

const

const DtModulationType& DtTransmitterPdu::modulationType

(

)

const

float DtTransmitterPdu::power

(

)

const

virtual void DtTransmitterPdu::printAntennaParams ( std::ostream &  stream ) const

protectedvirtual

virtual void DtTransmitterPdu::printAntennaParams ( ) const

privatevirtual

virtual void DtTransmitterPdu::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 DtTransmitterPdu::printDataToStream ( std::ostream &  stream ) const

virtual

Reimplemented from DtPdu.

virtual void DtTransmitterPdu::printModulationParams ( std::ostream &  stream ) const

protectedvirtual

virtual void DtTransmitterPdu::printModulationParams ( ) const

privatevirtual

Since these functions will not be called any more it's better if the intent was to extend their functionality that it now fails.

const DtRadioEntityType& DtTransmitterPdu::radioEntityType

(

)

const

unsigned int DtTransmitterPdu::radioId

(

)

const

const DtVector& DtTransmitterPdu::relativeAntennaLoc

(

)

const

static void DtTransmitterPdu::removeCallback ( DtExerciseConn *  conn, DtTransmitterPduCb  cb, void *  usr  )

static

void DtTransmitterPdu::setAntennaParamsLength ( int  length )

protected

void DtTransmitterPdu::setAntennaPatternParams	(	void *	networkRepresentation,
		int	size
	)

void DtTransmitterPdu::setAntennaPatternParams

(

const DtBeamAntennaPatternRecord &

rec

)

void DtTransmitterPdu::setAntennaPatternType

(

DtAntennaPatternType

type

)

void DtTransmitterPdu::setBandwidth

(

float

bw

)

void DtTransmitterPdu::setCryptoKeyId

(

int

key

)

void DtTransmitterPdu::setCryptoSystem

(

DtRadioCryptoSystem

sys

)

void DtTransmitterPdu::setEntityId

(

const DtEntityIdentifier &

id

)

void DtTransmitterPdu::setFrequency	(	unsigned long	upper,
		unsigned long	lower
	)

Deprecated Set/Get the frequency as upper and lower word.

void DtTransmitterPdu::setFrequency

(

DtU64

freq

)

Get/Set the frequency.

void DtTransmitterPdu::setInputSource

(

DtRadioInputSource

source

)

void DtTransmitterPdu::setModulationParams	(	void *	networkRepresentation,
		int	size
	)

void DtTransmitterPdu::setModulationParamsLength ( int  length )

protected

void DtTransmitterPdu::setModulationType

(

const DtModulationType &

type

)

void DtTransmitterPdu::setPower

(

float

power

)

void DtTransmitterPdu::setRadioEntityType

(

const DtRadioEntityType &

type

)

void DtTransmitterPdu::setRadioEntityType

(

const DtEntityType &

type

)

void DtTransmitterPdu::setRadioId

(

unsigned int

id

)

void DtTransmitterPdu::setRelativeAntennaLoc

(

const DtVector &

loc

)

void DtTransmitterPdu::setTransmitState

(

DtRadioTransmitState

state

)

void DtTransmitterPdu::setWorldAntennaLoc

(

const DtVector &

loc

)

DtRadioTransmitState DtTransmitterPdu::transmitState

(

)

const

const DtVector& DtTransmitterPdu::worldAntennaLoc

(

)

const

Member Data Documentation

DtModulationType DtTransmitterPdu::modType

protected

DtBeamAntennaPatternRecord DtTransmitterPdu::pat

protected

DtVector DtTransmitterPdu::rLoc

protected

DtEntityIdentifier DtTransmitterPdu::theId

protected

DtRadioEntityType DtTransmitterPdu::theType

protected

DtVector DtTransmitterPdu::wLoc

protected

---

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

• transmitterPdu.h