DtDirectedEnergyFirePdu Class Reference

Instances of DtEnergyFireInteraction are used to represent the firing of an Energy Weapon. More...

Inheritance diagram for DtDirectedEnergyFirePdu:

Collaboration diagram for DtDirectedEnergyFirePdu:

Public Member Functions
	DtDirectedEnergyFirePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtDirectedEnergyFirePdu (const DtNetDirectedEnergyFirePdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
virtual	~DtDirectedEnergyFirePdu ()
	destructor
virtual const DtEntityIdentifier &	firingEntityId () const
virtual void	setFiringEntityId (const DtEntityIdentifier &firingEntityId)
virtual const DtEventID &	eventId () const
virtual void	setEventId (const DtEventID &id)
virtual const DtEntityType &	munitionType () const
virtual void	setMunitionType (const DtEntityType &munitionType)
virtual const DtTime	shotStartTime () const
virtual void	setShotStartTime (DtTime shotStartTime)
virtual float	cumulativeShotTime () const
virtual void	setCumulativeShotTime (float cumulativeShotTime)
virtual const DtVector &	location () const
virtual void	setLocation (const DtVector &location)
virtual float	apertureDiameter () const
virtual void	setApertureDiameter (float apertureDiameter)
virtual float	waveLength () const
virtual void	setWaveLength (float waveLength)
virtual float	pulseRepetitionFrequency () const
virtual void	setPulseRepetitionFrequency (float pulseRepetitionFrequency)
virtual float	pulseWidth () const
virtual void	setPulseWidth (float pulseWidth)
virtual unsigned int	flags () const
virtual void	setFlags (unsigned int flags)
virtual bool	isFlagsWeaponsOn () const
virtual void	setFlagsWeaponsOn ()
virtual bool	isFlagsWeaponsOff () const
virtual void	setFlagsWeaponsOff ()
virtual bool	flagsUpdateDueToHeartbeatTimer () const
virtual void	setFlagsUpdateDueToHeartbeatTimer ()
virtual bool	flagsStateChange () const
virtual void	setFlagsStateChange ()
virtual DtPulseShape	pulseShape () const
virtual void	setPulseShape (DtPulseShape pulseShape)
virtual void	addPrecisionAimpointRecord (const DtDirectedEnergyPrecisionAimpointRecord &record)
	Add Directed Energy Precision Aimpoint Record (adds to the end of the Record Set)
virtual void	addAreaAimpointRecord (const DtDirectedEnergyAreaAimpointRecord &record)
	Add Directed Energy Area Aimpoint Record (adds to the end of the Record Set)
virtual void	addPrecisionAimpointRecords (const std::vector< DtDirectedEnergyPrecisionAimpointRecord > &records)
	Adds Directed Energy Precision Aimpoint Records (adds to the end of the Record Set)
virtual void	addAreaAimpointRecords (const std::vector< DtDirectedEnergyAreaAimpointRecord > &records)
	Adds Directed Energy Area Aimpoint Records (adds to the end of the Record Set)
virtual void	getPrecisionAimpointRecords (std::vector< DtDirectedEnergyPrecisionAimpointRecord > &records) const
	Gets the Directed Energy Precision Aimpoint Records.
virtual void	getAreaAimpointRecords (std::vector< DtDirectedEnergyAreaAimpointRecord > &records) const
	Gets the Directed Energy Area Aimpoint Records.
virtual void	printData () const
	Calculates the NetSize.
virtual void	printDataToStream (std::ostream &stream) const
virtual void	printDataToString (DtString &str) const
virtual unsigned int	numberOfRecords () const
	Returns number of records.
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 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	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, DtDirectedEnergyFireCb cb, void *usr)
static void	removeCallback (DtExerciseConn *conn, DtDirectedEnergyFireCb cb, void *usr)

Protected Member Functions
virtual void	printRecordsToStream (std::ostream &stream) const
	Prints the data to the specified stream.
DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.

Protected Attributes
DtEntityIdentifier	myFiringEntityId
DtEventID	myEvent
DtEntityType	myMunitionType
DtTime	myShotStartTime
float	myCumulativeShotTime
DtVector	myApertureEmitterLocationInFiringEntityCoordinates
float	myApertureDiameter
float	myWaveLength
float	myPulseRepetitionFrequency
float	myPulseWidth
DtPulseShape	myPulseShape
DtNetU16	myFlags

Static Protected Attributes
static const int	theStaticSize
	Size of PDU with zero DE records.

Detailed Description

Instances of DtEnergyFireInteraction are used to represent the firing of an Energy Weapon.

Constructor & Destructor Documentation

DtDirectedEnergyFirePdu::DtDirectedEnergyFirePdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

DtDirectedEnergyFirePdu::DtDirectedEnergyFirePdu	(	const DtNetDirectedEnergyFirePdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER,
		DtPduFactory *	pduFactory = 0
	)

virtual DtDirectedEnergyFirePdu::~DtDirectedEnergyFirePdu ( )

virtual

destructor

Member Function Documentation

virtual void DtDirectedEnergyFirePdu::addAreaAimpointRecord ( const DtDirectedEnergyAreaAimpointRecord &  record )

virtual

Add Directed Energy Area Aimpoint Record (adds to the end of the Record Set)

virtual void DtDirectedEnergyFirePdu::addAreaAimpointRecords ( const std::vector< DtDirectedEnergyAreaAimpointRecord > &  records )

virtual

Adds Directed Energy Area Aimpoint Records (adds to the end of the Record Set)

static void DtDirectedEnergyFirePdu::addCallback ( DtExerciseConn *  conn, DtDirectedEnergyFireCb  cb, void *  usr  )

static

virtual void DtDirectedEnergyFirePdu::addPrecisionAimpointRecord ( const DtDirectedEnergyPrecisionAimpointRecord &  record )

virtual

Add Directed Energy Precision Aimpoint Record (adds to the end of the Record Set)

virtual void DtDirectedEnergyFirePdu::addPrecisionAimpointRecords ( const std::vector< DtDirectedEnergyPrecisionAimpointRecord > &  records )

virtual

Adds Directed Energy Precision Aimpoint Records (adds to the end of the Record Set)

virtual float DtDirectedEnergyFirePdu::apertureDiameter ( ) const

virtual

Returns

Aperture Diameter

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

static

virtual float DtDirectedEnergyFirePdu::cumulativeShotTime ( ) const

virtual

Returns

Cumulative Shot Time

virtual const DtEventID& DtDirectedEnergyFirePdu::eventId ( ) const

virtual

Returns

Event ID

virtual const DtEntityIdentifier& DtDirectedEnergyFirePdu::firingEntityId ( ) const

virtual

Returns

Firing Entity ID

virtual unsigned int DtDirectedEnergyFirePdu::flags ( ) const

virtual

Returns

Flags

virtual bool DtDirectedEnergyFirePdu::flagsStateChange ( ) const

virtual

Returns

Flags State Change

virtual bool DtDirectedEnergyFirePdu::flagsUpdateDueToHeartbeatTimer ( ) const

virtual

Returns

Flags Update Due To Heartbeat Timer

virtual void DtDirectedEnergyFirePdu::getAreaAimpointRecords ( std::vector< DtDirectedEnergyAreaAimpointRecord > &  records ) const

virtual

Gets the Directed Energy Area Aimpoint Records.

virtual void DtDirectedEnergyFirePdu::getPrecisionAimpointRecords ( std::vector< DtDirectedEnergyPrecisionAimpointRecord > &  records ) const

virtual

Gets the Directed Energy Precision Aimpoint Records.

DtPduKind DtDirectedEnergyFirePdu::internalGetPduKind ( ) const

inlineprotectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

References DtDirectedEnergyFirePduKind.

virtual bool DtDirectedEnergyFirePdu::isFlagsWeaponsOff ( ) const

virtual

Returns

Flags WeaponsOff

virtual bool DtDirectedEnergyFirePdu::isFlagsWeaponsOn ( ) const

virtual

Returns

Flags WeaponsOn

virtual const DtVector& DtDirectedEnergyFirePdu::location ( ) const

virtual

Returns

Location

virtual const DtEntityType& DtDirectedEnergyFirePdu::munitionType ( ) const

virtual

Returns

Munition Type

virtual unsigned int DtDirectedEnergyFirePdu::numberOfRecords ( ) const

virtual

Returns number of records.

Reimplemented from DtPduWithAttributeRecordSets.

virtual void DtDirectedEnergyFirePdu::printData ( ) const

virtual

Calculates the NetSize.

This is different from the length due to the special nature of DIS 7 PDUs have Standard Variable Records in the PDU rather than attached in the Attribute PDU, so size is not set unless This was read from the network or inside the encoder

Reimplemented from DtPdu.

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

virtual

Reimplemented from DtPdu.

virtual void DtDirectedEnergyFirePdu::printDataToString ( DtString &  str ) const

virtual

Reimplemented from DtPdu.

virtual void DtDirectedEnergyFirePdu::printRecordsToStream ( std::ostream &  stream ) const

protectedvirtual

Prints the data to the specified stream.

virtual float DtDirectedEnergyFirePdu::pulseRepetitionFrequency ( ) const

virtual

Returns

Pulse Repetition Frequency

virtual DtPulseShape DtDirectedEnergyFirePdu::pulseShape ( ) const

virtual

Returns

Pulse Shape

virtual float DtDirectedEnergyFirePdu::pulseWidth ( ) const

virtual

Returns

Pulse Width

static void DtDirectedEnergyFirePdu::removeCallback ( DtExerciseConn *  conn, DtDirectedEnergyFireCb  cb, void *  usr  )

static

virtual void DtDirectedEnergyFirePdu::setApertureDiameter ( float  apertureDiameter )

virtual

Parameters

Aperture

Diameter

virtual void DtDirectedEnergyFirePdu::setCumulativeShotTime ( float  cumulativeShotTime )

virtual

Parameters

Cumulative

Shot Time

virtual void DtDirectedEnergyFirePdu::setEventId ( const DtEventID &  id )

virtual

Parameters

Event

ID

virtual void DtDirectedEnergyFirePdu::setFiringEntityId ( const DtEntityIdentifier &  firingEntityId )

virtual

Parameters

Firing

Entity ID

virtual void DtDirectedEnergyFirePdu::setFlags ( unsigned int  flags )

virtual

Parameters

Flags

virtual void DtDirectedEnergyFirePdu::setFlagsStateChange ( )

virtual

Parameters

Flags

State Change

virtual void DtDirectedEnergyFirePdu::setFlagsUpdateDueToHeartbeatTimer ( )

virtual

Parameters

Flags

Update Due To Heartbeat Timer

virtual void DtDirectedEnergyFirePdu::setFlagsWeaponsOff ( )

virtual

Parameters

Flags

WeaponsOff

virtual void DtDirectedEnergyFirePdu::setFlagsWeaponsOn ( )

virtual

Parameters

Flags

WeaponsOn

virtual void DtDirectedEnergyFirePdu::setLocation ( const DtVector &  location )

virtual

Parameters

Location

virtual void DtDirectedEnergyFirePdu::setMunitionType ( const DtEntityType &  munitionType )

virtual

Parameters

Munition

Type

virtual void DtDirectedEnergyFirePdu::setPulseRepetitionFrequency ( float  pulseRepetitionFrequency )

virtual

Parameters

Pulse

Repetition Frequency

virtual void DtDirectedEnergyFirePdu::setPulseShape ( DtPulseShape  pulseShape )

virtual

Parameters

Pulse

Shape

virtual void DtDirectedEnergyFirePdu::setPulseWidth ( float  pulseWidth )

virtual

Parameters

Pulse

Width

virtual void DtDirectedEnergyFirePdu::setShotStartTime ( DtTime  shotStartTime )

virtual

Parameters

Shot	Start Time

virtual void DtDirectedEnergyFirePdu::setWaveLength ( float  waveLength )

virtual

Parameters

Wave

Length

virtual const DtTime DtDirectedEnergyFirePdu::shotStartTime ( ) const

virtual

Returns

Shot Start Time

virtual float DtDirectedEnergyFirePdu::waveLength ( ) const

virtual

Returns

Wave Length

Member Data Documentation

float DtDirectedEnergyFirePdu::myApertureDiameter

protected

DtVector DtDirectedEnergyFirePdu::myApertureEmitterLocationInFiringEntityCoordinates

protected

float DtDirectedEnergyFirePdu::myCumulativeShotTime

protected

DtEventID DtDirectedEnergyFirePdu::myEvent

protected

DtEntityIdentifier DtDirectedEnergyFirePdu::myFiringEntityId

protected

DtNetU16 DtDirectedEnergyFirePdu::myFlags

protected

DtEntityType DtDirectedEnergyFirePdu::myMunitionType

protected

float DtDirectedEnergyFirePdu::myPulseRepetitionFrequency

protected

DtPulseShape DtDirectedEnergyFirePdu::myPulseShape

protected

float DtDirectedEnergyFirePdu::myPulseWidth

protected

DtTime DtDirectedEnergyFirePdu::myShotStartTime

protected

float DtDirectedEnergyFirePdu::myWaveLength

protected

const int DtDirectedEnergyFirePdu::theStaticSize

staticprotected

Size of PDU with zero DE records.

---

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

• directedEnergyFirePdu.h