DtUnderwaterAcousticPdu Class Reference

Instances of DtUnderwaterAcousticPdu are used to send information about simulated underwater acoustic emissions. More...

Inheritance diagram for DtUnderwaterAcousticPdu:

Collaboration diagram for DtUnderwaterAcousticPdu:

Public Member Functions
	DtUnderwaterAcousticPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtUnderwaterAcousticPdu (const DtNetUnderwaterAcousticPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
	DtUnderwaterAcousticPdu (const DtUnderwaterAcousticPdu &orig)
virtual	~DtUnderwaterAcousticPdu ()
	destructor
DtUnderwaterAcousticPdu &	operator= (const DtUnderwaterAcousticPdu &orig)
	Assignment operator.
virtual void	setEmittingEntityID (const DtEntityIdentifier &entity)
	Set/Get emitting entity identifier.
virtual const DtEntityIdentifier &	emittingEntityID () const
virtual void	setEventID (const DtEventID &event)
	Set/Get event identifier.
virtual const DtEventID &	eventID () const
virtual void	setStateChangeUpdate (DtUnderwaterAcousticUpdate upd)
	Set/Get state/change update indicator.
virtual DtUnderwaterAcousticUpdate	stateChangeUpdate () const
virtual void	setPassiveParameterIndex (DtUnderwaterAcousticPassiveParmIndex ind)
	Set/Get passive parameter index.
virtual DtUnderwaterAcousticPassiveParmIndex	passiveParameterIndex () const
virtual void	setPropulsionPlantConfig (DtUnderwaterAcousticPropulsionPlantConfig config)
	Set/Get propulsion plant configuration.
virtual DtUnderwaterAcousticPropulsionPlantConfig	propulsionPlantConfig () const
virtual bool	setNumShafts (DtU8 num)
	Set/Get number of shafts.
virtual DtU8	numShafts () const
virtual bool	setNumAdditionalPassiveAct (DtU8 num)
	Set/Get number of additional passive activities.
virtual DtU8	numAdditionalPassiveAct () const
virtual bool	setNumEmitterSystems (DtU8 num)
	Set/Get number of emitter systems.
virtual DtU8	numEmitterSystems () const
virtual bool	setNumBeams (int emitterSystemIndex, DtU8 num)
	Set/Get number of beam data records for a particular emitter system.
virtual DtU8	numBeams (int emitterSystemIndex) const
virtual bool	setShaftSpeed (int index, const DtUnderwaterAcousticShaftSpeed &record)
	Set/Get a shaft speed data record.
virtual bool	getShaftSpeed (int index, DtUnderwaterAcousticShaftSpeed &record) const
virtual bool	setAddtnlPassiveAct (int index, const DtUnderwaterAcousticAddtnlPassiveAct &record)
	Set/Get an additional passive activity data record.
virtual bool	getAddtnlPassiveAct (int index, DtUnderwaterAcousticAddtnlPassiveAct &record) const
virtual bool	setEmitterSystem (int index, const DtUnderwaterAcousticEmitterSystem &record)
	Set/Get an underwater acoustic emitter system.
virtual bool	getEmitterSystem (int index, DtUnderwaterAcousticEmitterSystem &record) const
virtual bool	setBeam (int emitterSystemIndex, int beamIndex, const DtUnderwaterAcousticBeam &record)
	Set/Get beam fundamental data parameters for a beam.
virtual bool	getBeam (int emitterSystemIndex, int beamIndex, DtUnderwaterAcousticBeam &record) const
virtual void	printData () const
	Print the data contained by this PDU.
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 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)
	Create a DtUnderwaterAcousticPdu.
static void	addCallback (DtExerciseConn *conn, DtUnderwaterAcousticPduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtUnderwaterAcousticPduCb cb, void *usr)

Protected Member Functions
DtUnderwaterAcousticPdu *	self () const
	Casts the 'this' pointer for changing elements in a const function.
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetUnderwaterAcousticPdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
virtual char *	var () const
	Returns a pointer to the first byte of variable length data.
virtual int	shaftSpeedRecordOffset (int recordIndex) const
	Returns a buffer offset to the given shaft speed record.
virtual int	passiveActRecordOffset (int recordIndex) const
	Returns a buffer offset to the given additional passive activity record.
virtual int	emitterSystemRecordOffset (int recordIndex) const
	Returns a buffer offset to the given acoustic emitter system.
virtual int	beamDataRecordOffset (int emitterSystemIndex, int beamIndex) const
	Returns a buffer offset to the given beam fundamental data parameter of a particular emitter system.
int	computeStatus () const

Protected Attributes
DtEntityIdentifier	myEntityID
	Temporary objects for reference returns.
DtEventID	myEventID

Static Protected Attributes
static const int	theNetUaPduSize
static const int	theNetShaftSize
static const int	theNetApaSize
static const int	theNetSystemSize
static const int	theNetBeamSize

Detailed Description

Instances of DtUnderwaterAcousticPdu are used to send information about simulated underwater acoustic emissions.

Constructor & Destructor Documentation

DtUnderwaterAcousticPdu::DtUnderwaterAcousticPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtUnderwaterAcousticPdu::DtUnderwaterAcousticPdu	(	const DtNetUnderwaterAcousticPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER,
		DtPduFactory *	pduFactory = 0
	)

DtUnderwaterAcousticPdu::DtUnderwaterAcousticPdu

(

const DtUnderwaterAcousticPdu &

orig

)

virtual DtUnderwaterAcousticPdu::~DtUnderwaterAcousticPdu ( )

virtual

destructor

Member Function Documentation

static void DtUnderwaterAcousticPdu::addCallback ( DtExerciseConn *  conn, DtUnderwaterAcousticPduCb  cb, void *  usr  )

static

Add (register)/Remove (deregister) function to be called when pdu is received.

virtual int DtUnderwaterAcousticPdu::beamDataRecordOffset ( int  emitterSystemIndex, int  beamIndex  ) const

protectedvirtual

Returns a buffer offset to the given beam fundamental data parameter of a particular emitter system.

int DtUnderwaterAcousticPdu::computeStatus ( ) const

protected

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

static

Create a DtUnderwaterAcousticPdu.

Caller is responsible for deletion.

virtual int DtUnderwaterAcousticPdu::emitterSystemRecordOffset ( int  recordIndex ) const

protectedvirtual

Returns a buffer offset to the given acoustic emitter system.

virtual const DtEntityIdentifier& DtUnderwaterAcousticPdu::emittingEntityID ( ) const

virtual

virtual const DtEventID& DtUnderwaterAcousticPdu::eventID ( ) const

virtual

virtual bool DtUnderwaterAcousticPdu::getAddtnlPassiveAct ( int  index, DtUnderwaterAcousticAddtnlPassiveAct &  record  ) const

virtual

virtual bool DtUnderwaterAcousticPdu::getBeam ( int  emitterSystemIndex, int  beamIndex, DtUnderwaterAcousticBeam &  record  ) const

virtual

virtual bool DtUnderwaterAcousticPdu::getEmitterSystem ( int  index, DtUnderwaterAcousticEmitterSystem &  record  ) const

virtual

virtual bool DtUnderwaterAcousticPdu::getShaftSpeed ( int  index, DtUnderwaterAcousticShaftSpeed &  record  ) const

virtual

virtual DtPduKind DtUnderwaterAcousticPdu::internalGetPduKind ( ) const

inlineprotectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

References DtUnderwaterAcousticPduKind.

virtual DtNetUnderwaterAcousticPdu* DtUnderwaterAcousticPdu::netPduStruct ( ) const

protectedvirtual

Casts the netPdu element to our network struct.

virtual DtU8 DtUnderwaterAcousticPdu::numAdditionalPassiveAct ( ) const

virtual

virtual DtU8 DtUnderwaterAcousticPdu::numBeams ( int  emitterSystemIndex ) const

virtual

virtual DtU8 DtUnderwaterAcousticPdu::numEmitterSystems ( ) const

virtual

virtual DtU8 DtUnderwaterAcousticPdu::numShafts ( ) const

virtual

DtUnderwaterAcousticPdu& DtUnderwaterAcousticPdu::operator=

(

const DtUnderwaterAcousticPdu &

orig

)

Assignment operator.

virtual int DtUnderwaterAcousticPdu::passiveActRecordOffset ( int  recordIndex ) const

protectedvirtual

Returns a buffer offset to the given additional passive activity record.

virtual DtUnderwaterAcousticPassiveParmIndex DtUnderwaterAcousticPdu::passiveParameterIndex ( ) const

virtual

virtual void DtUnderwaterAcousticPdu::printData ( ) const

virtual

Print the data contained by this PDU.

Reimplemented from DtPdu.

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

virtual

Reimplemented from DtPdu.

virtual DtUnderwaterAcousticPropulsionPlantConfig DtUnderwaterAcousticPdu::propulsionPlantConfig ( ) const

virtual

static void DtUnderwaterAcousticPdu::removeCallback ( DtExerciseConn *  conn, DtUnderwaterAcousticPduCb  cb, void *  usr  )

static

DtUnderwaterAcousticPdu* DtUnderwaterAcousticPdu::self ( ) const

protected

Casts the 'this' pointer for changing elements in a const function.

Non-virtual, since you can't override based on return type.

virtual bool DtUnderwaterAcousticPdu::setAddtnlPassiveAct ( int  index, const DtUnderwaterAcousticAddtnlPassiveAct &  record  )

virtual

Set/Get an additional passive activity data record.

Returns false if the record does not exist.

virtual bool DtUnderwaterAcousticPdu::setBeam ( int  emitterSystemIndex, int  beamIndex, const DtUnderwaterAcousticBeam &  record  )

virtual

Set/Get beam fundamental data parameters for a beam.

Returns false if the record does not exist. Data length field is automatically set by the PDU class.

virtual bool DtUnderwaterAcousticPdu::setEmitterSystem ( int  index, const DtUnderwaterAcousticEmitterSystem &  record  )

virtual

Set/Get an underwater acoustic emitter system.

Returns false if the record does not exist. Data length field is automatically set by the PDU class.

virtual void DtUnderwaterAcousticPdu::setEmittingEntityID ( const DtEntityIdentifier &  entity )

virtual

Set/Get emitting entity identifier.

virtual void DtUnderwaterAcousticPdu::setEventID ( const DtEventID &  event )

virtual

Set/Get event identifier.

virtual bool DtUnderwaterAcousticPdu::setNumAdditionalPassiveAct ( DtU8  num )

virtual

Set/Get number of additional passive activities.

May return false if PDU size would exceed the maximum PDU size.

virtual bool DtUnderwaterAcousticPdu::setNumBeams ( int  emitterSystemIndex, DtU8  num  )

virtual

Set/Get number of beam data records for a particular emitter system.

May return false if PDU size would exceed the maximum PDU size or if the emitter system number is invalid.

virtual bool DtUnderwaterAcousticPdu::setNumEmitterSystems ( DtU8  num )

virtual

Set/Get number of emitter systems.

May return false if PDU size would exceed the maximum PDU size.

virtual bool DtUnderwaterAcousticPdu::setNumShafts ( DtU8  num )

virtual

Set/Get number of shafts.

May return false if PDU size would exceed the maximum PDU size.

virtual void DtUnderwaterAcousticPdu::setPassiveParameterIndex ( DtUnderwaterAcousticPassiveParmIndex  ind )

virtual

Set/Get passive parameter index.

virtual void DtUnderwaterAcousticPdu::setPropulsionPlantConfig ( DtUnderwaterAcousticPropulsionPlantConfig  config )

virtual

Set/Get propulsion plant configuration.

virtual bool DtUnderwaterAcousticPdu::setShaftSpeed ( int  index, const DtUnderwaterAcousticShaftSpeed &  record  )

virtual

Set/Get a shaft speed data record.

Returns false if the record does not exist.

virtual void DtUnderwaterAcousticPdu::setStateChangeUpdate ( DtUnderwaterAcousticUpdate  upd )

virtual

Set/Get state/change update indicator.

virtual int DtUnderwaterAcousticPdu::shaftSpeedRecordOffset ( int  recordIndex ) const

protectedvirtual

Returns a buffer offset to the given shaft speed record.

virtual DtUnderwaterAcousticUpdate DtUnderwaterAcousticPdu::stateChangeUpdate ( ) const

virtual

virtual char* DtUnderwaterAcousticPdu::var ( ) const

protectedvirtual

Returns a pointer to the first byte of variable length data.

Member Data Documentation

DtEntityIdentifier DtUnderwaterAcousticPdu::myEntityID

protected

Temporary objects for reference returns.

DtEventID DtUnderwaterAcousticPdu::myEventID

protected

const int DtUnderwaterAcousticPdu::theNetApaSize

staticprotected

const int DtUnderwaterAcousticPdu::theNetBeamSize

staticprotected

const int DtUnderwaterAcousticPdu::theNetShaftSize

staticprotected

const int DtUnderwaterAcousticPdu::theNetSystemSize

staticprotected

const int DtUnderwaterAcousticPdu::theNetUaPduSize

staticprotected

---

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

• underwaterAcousticPdu.h