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)
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
unsigned long	frequency (int upperLower=DtFREQ_LOWER) const
void	setFrequency (unsigned long freq)
void	setFrequency (unsigned long upper, unsigned long lower)
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
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 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 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	printToStream (std::ostream &stream) const
	Print the contents of the PDU by calling printHeaderToStream and printDataToStream.
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
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.

Static Public Member Functions
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
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`
	)

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`
	)

static

int DtTransmitterPdu::cryptoKeyId ( ) const

DtRadioCryptoSystem DtTransmitterPdu::cryptoSystem ( ) const

const DtEntityIdentifier& DtTransmitterPdu::entityId ( ) const

unsigned long DtTransmitterPdu::frequency ( int upperLower = DtFREQ_LOWER ) const

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 freq )

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

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:

transmitPdu.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation