Class DirectedEnergyFirePdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.WarfareFamilyPdu

edu.nps.moves.dis7.pdus.DirectedEnergyFirePdu

All Implemented Interfaces:

Marshaller, Serializable

public class DirectedEnergyFirePdu
extends WarfareFamilyPdu
implements Serializable

7.3.4 Used to communicate the firing of a directed energy weapon.

See Also:

• IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation - Application Protocols
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected float	apertureDiameter	Field shall identify the beam diameter at the aperture/emitter, Section 7.3.4
protected Vector3Float	apertureEmitterLocation	Field shall identify the location of the DE weapon aperture/emitter, Section 7.3.4
protected ByteArrayOutputStream	byteArrayOutputStream	byteArrayOutputStream (baos) is used for marshal/unmarshal serialization
protected float	commulativeShotTime	Field shall indicate the current cumulative duration of the shot, Section 7.3.4
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected List<StandardVariableSpecification>	dERecords	Fields shall contain one or more DE records, records shall conform to the variable record format (Section6.2.82), Section 7.3.4
protected EventIdentifier	eventID	eventID is an undescribed parameter...
protected EntityID	firingEntityID	ID of the entity that shot
protected DEFireFlags	flags	16bit Boolean field shall contain various flags to indicate status information needed to process a DE, Section 7.3.4 uid 313
protected EntityType	munitionType	Field shall identify the munition type enumeration for the DE weapon beam, Section 7.3.4
static final String	NAME	The name of this PDU type
protected short	numberOfDERecords	Field shall specify the number of DE records, Section 7.3.4
protected int	pad1	pad1 is an undescribed parameter...
protected byte	pad2	pad2 is an undescribed parameter...
protected int	pad3	pad3 is an undescribed parameter...
protected short	pad4	pad4 is an undescribed parameter...
protected float	pulseRepititionFrequency	pulseRepititionFrequency is an undescribed parameter...
protected DEFirePulseShape	pulseShape	Field shall identify the pulse shape and shall be represented as an 8-bit enumeration, Section 7.3.4 uid 312
protected float	pulseWidth	field shall identify the pulse width emissions in units of seconds, Section 7.3.4
protected ClockTime	shotStartTime	Field shall indicate the simulation time at start of the shot, Section 7.3.4
protected float	wavelength	Field shall identify the emissions wavelength in units of meters, Section 7.3.4

Fields inherited from class edu.nps.moves.dis7.pdus.WarfareFamilyPdu

FAMILY_NAME

Fields inherited from class edu.nps.moves.dis7.pdus.PduBase

padding, pduStatus

Fields inherited from class edu.nps.moves.dis7.pdus.Pdu

exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp

Constructor Summary

Constructors

Constructor	Description
DirectedEnergyFirePdu()	Constructor creates and configures a new instance object

Method Summary

Modifier and Type	Method	Description
DirectedEnergyFirePdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
DirectedEnergyFirePdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
DirectedEnergyFirePdu	copyDataOutputStream()	copy method creates a deep copy of current object using DataOutputStream methods.
boolean	equals(Object obj)
boolean	equalsImpl(Object obj)	Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object
float	getApertureDiameter()	Getter for apertureDiameter
Vector3Float	getApertureEmitterLocation()	Getter for apertureEmitterLocation
float	getCommulativeShotTime()	Getter for commulativeShotTime
List<StandardVariableSpecification>	getDERecords()	Getter for dERecords
EventIdentifier	getEventID()	Getter for eventID
EntityID	getFiringEntityID()	Getter for firingEntityID
DEFireFlags	getFlags()	Getter for flags
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
EntityType	getMunitionType()	Getter for munitionType
int	getPad1()	Getter for pad1
byte	getPad2()	Getter for pad2
int	getPad3()	Getter for pad3
short	getPad4()	Getter for pad4
float	getPulseRepititionFrequency()	Getter for pulseRepititionFrequency
DEFirePulseShape	getPulseShape()	Getter for pulseShape
float	getPulseWidth()	Getter for pulseWidth
ClockTime	getShotStartTime()	Getter for shotStartTime
float	getWavelength()	Getter for wavelength
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
DirectedEnergyFirePdu	setApertureDiameter(float pApertureDiameter)	Setter for apertureDiameter
DirectedEnergyFirePdu	setApertureEmitterLocation(Vector3Float pApertureEmitterLocation)	Setter for apertureEmitterLocation
DirectedEnergyFirePdu	setCommulativeShotTime(float pCommulativeShotTime)	Setter for commulativeShotTime
DirectedEnergyFirePdu	setDERecords(List<StandardVariableSpecification> pDERecords)	Setter for dERecords
DirectedEnergyFirePdu	setEventID(EventIdentifier pEventID)	Setter for eventID
DirectedEnergyFirePdu	setFiringEntityID(EntityID pFiringEntityID)	Setter for firingEntityID
DirectedEnergyFirePdu	setFlags(DEFireFlags pFlags)	Setter for flags
DirectedEnergyFirePdu	setMunitionType(EntityType pMunitionType)	Setter for munitionType
DirectedEnergyFirePdu	setPad1(int pPad1)	Setter for pad1
DirectedEnergyFirePdu	setPad2(byte pPad2)	Setter for pad2
DirectedEnergyFirePdu	setPad2(int pPad2)	Utility setter for pad2
DirectedEnergyFirePdu	setPad3(int pPad3)	Setter for pad3
DirectedEnergyFirePdu	setPad4(int pPad4)	Utility setter for pad4
DirectedEnergyFirePdu	setPad4(short pPad4)	Setter for pad4
DirectedEnergyFirePdu	setPulseRepititionFrequency(float pPulseRepititionFrequency)	Setter for pulseRepititionFrequency
DirectedEnergyFirePdu	setPulseShape(DEFirePulseShape pPulseShape)	Setter for pulseShape
DirectedEnergyFirePdu	setPulseWidth(float pPulseWidth)	Setter for pulseWidth
DirectedEnergyFirePdu	setShotStartTime(ClockTime pShotStartTime)	Setter for shotStartTime
DirectedEnergyFirePdu	setWavelength(float pWavelength)	Setter for wavelength
String	toString()
int	unmarshal(DataInputStream dis)	Deserializes an object from a DataInputStream.
int	unmarshal(ByteBuffer byteBuffer)	Unpacks a Pdu from the underlying data.

Methods inherited from class edu.nps.moves.dis7.pdus.PduBase

getPadding, getPduStatus, setPadding, setPadding, setPduStatus

Methods inherited from class edu.nps.moves.dis7.pdus.Pdu

copyByPduFactory, getExerciseID, getLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, getTimestampSeconds, isAcknowledgeRPdu, isActionRequestPdu, isActionRequestRPdu, isActionResponsePdu, isActionResponseRPdu, isAggregateStatePdu, isAppearancePdu, isArealObjectStatePdu, isArticulatedPartsPdu, isAttributePdu, isCollisionElasticPdu, isCollisionPdu, isCommentPdu, isCommentRPdu, isCreateEntityPdu, isCreateEntityRPdu, isDataPdu, isDataQueryPdu, isDataQueryRPdu, isDataRPdu, isDesignatorPdu, isDetonationPdu, isDirectedEnergyFirePdu, isDistributedEmissionsRegenerationFamilyPdu, isElectromagneticEmissionPdu, isEntityDamageStatusPdu, isEntityInformationInteractionFamilyPdu, isEntityManagementFamilyPdu, isEntityStatePdu, isEntityStateUpdatePdu, isEnvironmentalProcessPdu, isEventReportPdu, isEventReportRPdu, isFirePdu, isGriddedDataPdu, isIFFPdu, isInformationOperationsActionPdu, isInformationOperationsFamilyPdu, isInformationOperationsReportPdu, isIntercomControlPdu, isIntercomSignalPdu, isIsGroupOfPdu, isIsPartOfPdu, isLEDetonationPdu, isLEFirePdu, isLinearObjectStatePdu, isLiveEntityDetonationPdu, isLiveEntityFirePdu, isLogisticsFamilyPdu, isMinefieldDataPdu, isMinefieldFamilyPdu, isMinefieldQueryPdu, isMinefieldResponseNACKPdu, isMinefieldStatePdu, isPointObjectStatePdu, isRadioCommunicationsFamilyPdu, isReceiverPdu, isRecordQueryRPdu, isRecordRPdu, isReliablePdu, isRemoveEntityPdu, isRemoveEntityRPdu, isRepairCompletePdu, isRepairResponsePdu, isResupplyCancelPdu, isResupplyOfferPdu, isResupplyReceivedPdu, isSEESPdu, isSetDataPdu, isSetDataRPdu, isSetRecordRPdu, isSignalPdu, isSimulationManagementFamilyPdu, isSimulationManagementWithReliabilityFamilyPdu, isStartResumePdu, isStartResumeRPdu, isStopFreezePdu, isStopFreezeRPdu, isSupplementalEmissionEntityStatePdu, isSyntheticEnvironmentFamilyPdu, isTransferOwnershipPdu, isTransmitterPdu, isTSPIPdu, isUnderwaterAcousticPdu, isWarfareFamilyPdu, marshal, occursAfter, occursBefore, occursSameTime, setExerciseID, setExerciseID, setLength, setLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp, setTimestampSeconds

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NAME

public static final String NAME

The name of this PDU type

See Also:

• Constant Field Values

firingEntityID

protected EntityID firingEntityID

ID of the entity that shot

eventID

protected EventIdentifier eventID

eventID is an undescribed parameter...

munitionType

protected EntityType munitionType

Field shall identify the munition type enumeration for the DE weapon beam, Section 7.3.4

shotStartTime

protected ClockTime shotStartTime

Field shall indicate the simulation time at start of the shot, Section 7.3.4

commulativeShotTime

protected float commulativeShotTime

Field shall indicate the current cumulative duration of the shot, Section 7.3.4

apertureEmitterLocation

protected Vector3Float apertureEmitterLocation

Field shall identify the location of the DE weapon aperture/emitter, Section 7.3.4

apertureDiameter

protected float apertureDiameter

Field shall identify the beam diameter at the aperture/emitter, Section 7.3.4

wavelength

protected float wavelength

Field shall identify the emissions wavelength in units of meters, Section 7.3.4

pad1

protected int pad1

pad1 is an undescribed parameter...

pulseRepititionFrequency

protected float pulseRepititionFrequency

pulseRepititionFrequency is an undescribed parameter...

pulseWidth

protected float pulseWidth

field shall identify the pulse width emissions in units of seconds, Section 7.3.4

flags

protected DEFireFlags flags

16bit Boolean field shall contain various flags to indicate status information needed to process a DE, Section 7.3.4 uid 313

pulseShape

protected DEFirePulseShape pulseShape

Field shall identify the pulse shape and shall be represented as an 8-bit enumeration, Section 7.3.4 uid 312

pad2

protected byte pad2

pad2 is an undescribed parameter...

pad3

protected int pad3

pad3 is an undescribed parameter...

pad4

protected short pad4

pad4 is an undescribed parameter...

numberOfDERecords

protected short numberOfDERecords

Field shall specify the number of DE records, Section 7.3.4

dERecords

protected List<StandardVariableSpecification> dERecords

Fields shall contain one or more DE records, records shall conform to the variable record format (Section6.2.82), Section 7.3.4

byteArrayOutputStream

protected ByteArrayOutputStream byteArrayOutputStream

byteArrayOutputStream (baos) is used for marshal/unmarshal serialization

See Also:

• copyDataOutputStream()

dataOutputStream

protected DataOutputStream dataOutputStream

dataOutputStream (dos) is used for marshal/unmarshal serialization

See Also:

• copyDataOutputStream()

Constructor Details

DirectedEnergyFirePdu

public DirectedEnergyFirePdu()

Constructor creates and configures a new instance object

Method Details

copy

public DirectedEnergyFirePdu copy()

copy method creates a deep copy of current object using preferred marshalling method

Returns:

deep copy of PDU

copyByteBuffer

public DirectedEnergyFirePdu copyByteBuffer()

Creates a "deep copy" of current object using ByteBuffer methods.

Returns:

deep copy of PDU

copyDataOutputStream

public DirectedEnergyFirePdu copyDataOutputStream()

copy method creates a deep copy of current object using DataOutputStream methods.

Returns:

deep copy of PDU

getMarshalledSize

public int getMarshalledSize()

Returns size of this serialized (marshalled) object in bytes

Specified by:

getMarshalledSize in interface Marshaller

Overrides:

getMarshalledSize in class WarfareFamilyPdu

Returns:

serialized size in bytes

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

setFiringEntityID

public DirectedEnergyFirePdu setFiringEntityID(EntityID pFiringEntityID)

Setter for firingEntityID

Parameters:

pFiringEntityID - new value of interest

Returns:

same object to permit progressive setters

getFiringEntityID

public EntityID getFiringEntityID()

Getter for firingEntityID

Returns:

value of interest

setEventID

public DirectedEnergyFirePdu setEventID(EventIdentifier pEventID)

Setter for eventID

Parameters:

pEventID - new value of interest

Returns:

same object to permit progressive setters

getEventID

public EventIdentifier getEventID()

Getter for eventID

Returns:

value of interest

setMunitionType

public DirectedEnergyFirePdu setMunitionType(EntityType pMunitionType)

Setter for munitionType

Parameters:

pMunitionType - new value of interest

Returns:

same object to permit progressive setters

getMunitionType

public EntityType getMunitionType()

Getter for munitionType

Returns:

value of interest

setShotStartTime

public DirectedEnergyFirePdu setShotStartTime(ClockTime pShotStartTime)

Setter for shotStartTime

Parameters:

pShotStartTime - new value of interest

Returns:

same object to permit progressive setters

getShotStartTime

public ClockTime getShotStartTime()

Getter for shotStartTime

Returns:

value of interest

setCommulativeShotTime

public DirectedEnergyFirePdu setCommulativeShotTime(float pCommulativeShotTime)

Setter for commulativeShotTime

Parameters:

pCommulativeShotTime - new value of interest

Returns:

same object to permit progressive setters

getCommulativeShotTime

public float getCommulativeShotTime()

Getter for commulativeShotTime

Returns:

value of interest

setApertureEmitterLocation

public DirectedEnergyFirePdu setApertureEmitterLocation(Vector3Float pApertureEmitterLocation)

Setter for apertureEmitterLocation

Parameters:

pApertureEmitterLocation - new value of interest

Returns:

same object to permit progressive setters

getApertureEmitterLocation

public Vector3Float getApertureEmitterLocation()

Getter for apertureEmitterLocation

Returns:

value of interest

setApertureDiameter

public DirectedEnergyFirePdu setApertureDiameter(float pApertureDiameter)

Setter for apertureDiameter

Parameters:

pApertureDiameter - new value of interest

Returns:

same object to permit progressive setters

getApertureDiameter

public float getApertureDiameter()

Getter for apertureDiameter

Returns:

value of interest

setWavelength

public DirectedEnergyFirePdu setWavelength(float pWavelength)

Setter for wavelength

Parameters:

pWavelength - new value of interest

Returns:

same object to permit progressive setters

getWavelength

public float getWavelength()

Getter for wavelength

Returns:

value of interest

setPad1

public DirectedEnergyFirePdu setPad1(int pPad1)

Setter for pad1

Parameters:

pPad1 - new value of interest

Returns:

same object to permit progressive setters

getPad1

public int getPad1()

Getter for pad1

Returns:

value of interest

setPulseRepititionFrequency

public DirectedEnergyFirePdu setPulseRepititionFrequency(float pPulseRepititionFrequency)

Setter for pulseRepititionFrequency

Parameters:

pPulseRepititionFrequency - new value of interest

Returns:

same object to permit progressive setters

getPulseRepititionFrequency

public float getPulseRepititionFrequency()

Getter for pulseRepititionFrequency

Returns:

value of interest

setPulseWidth

public DirectedEnergyFirePdu setPulseWidth(float pPulseWidth)

Setter for pulseWidth

Parameters:

pPulseWidth - new value of interest

Returns:

same object to permit progressive setters

getPulseWidth

public float getPulseWidth()

Getter for pulseWidth

Returns:

value of interest

setFlags

public DirectedEnergyFirePdu setFlags(DEFireFlags pFlags)

Setter for flags

Parameters:

pFlags - new value of interest

Returns:

same object to permit progressive setters

getFlags

public DEFireFlags getFlags()

Getter for flags

Returns:

value of interest

setPulseShape

public DirectedEnergyFirePdu setPulseShape(DEFirePulseShape pPulseShape)

Setter for pulseShape

Parameters:

pPulseShape - new value of interest

Returns:

same object to permit progressive setters

getPulseShape

public DEFirePulseShape getPulseShape()

Getter for pulseShape

Returns:

value of interest

setPad2

public DirectedEnergyFirePdu setPad2(byte pPad2)

Setter for pad2

Parameters:

pPad2 - new value of interest

Returns:

same object to permit progressive setters

setPad2

public DirectedEnergyFirePdu setPad2(int pPad2)

Utility setter for pad2

Parameters:

pPad2 - new value of interest

Returns:

same object to permit progressive setters

getPad2

public byte getPad2()

Getter for pad2

Returns:

value of interest

setPad3

public DirectedEnergyFirePdu setPad3(int pPad3)

Setter for pad3

Parameters:

pPad3 - new value of interest

Returns:

same object to permit progressive setters

getPad3

public int getPad3()

Getter for pad3

Returns:

value of interest

setPad4

public DirectedEnergyFirePdu setPad4(short pPad4)

Setter for pad4

Parameters:

pPad4 - new value of interest

Returns:

same object to permit progressive setters

setPad4

public DirectedEnergyFirePdu setPad4(int pPad4)

Utility setter for pad4

Parameters:

pPad4 - new value of interest

Returns:

same object to permit progressive setters

getPad4

public short getPad4()

Getter for pad4

Returns:

value of interest

setDERecords

public DirectedEnergyFirePdu setDERecords(List<StandardVariableSpecification> pDERecords)

Setter for dERecords

Parameters:

pDERecords - new value of interest

Returns:

same object to permit progressive setters

getDERecords

public List<StandardVariableSpecification> getDERecords()

Getter for dERecords

Returns:

value of interest

marshal

public void marshal(DataOutputStream dos)
             throws Exception

Serializes an object to a DataOutputStream.

Specified by:

marshal in interface Marshaller

Overrides:

marshal in class WarfareFamilyPdu

Parameters:

dos - the OutputStream

Throws:

Exception - if something goes wrong

See Also:

• DataOutputStream

unmarshal

public int unmarshal(DataInputStream dis)
              throws Exception

Deserializes an object from a DataInputStream.

Specified by:

unmarshal in interface Marshaller

Overrides:

unmarshal in class WarfareFamilyPdu

Parameters:

dis - the InputStream

Returns:

marshalled serialized size in bytes

Throws:

Exception - if something goes wrong

See Also:

• DataInputStream
• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

marshal

public void marshal(ByteBuffer byteBuffer)
             throws Exception

Packs an object into the ByteBuffer.

Specified by:

marshal in interface Marshaller

Overrides:

marshal in class WarfareFamilyPdu

Parameters:

byteBuffer - The ByteBuffer at the position to begin writing

Throws:

BufferOverflowException - if byteBuffer is too small

ReadOnlyBufferException - if byteBuffer is read only

Exception - ByteBuffer-generated exception

See Also:

• ByteBuffer

unmarshal

public int unmarshal(ByteBuffer byteBuffer)
              throws Exception

Unpacks a Pdu from the underlying data.

Specified by:

unmarshal in interface Marshaller

Overrides:

unmarshal in class WarfareFamilyPdu

Parameters:

byteBuffer - The ByteBuffer at the position to begin reading

Returns:

marshalled serialized size in bytes

Throws:

BufferUnderflowException - if byteBuffer is too small

Exception - ByteBuffer-generated exception

See Also:

• ByteBuffer
• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

equals

public boolean equals(Object obj)

Overrides:

equals in class WarfareFamilyPdu

equalsImpl

public boolean equalsImpl(Object obj)

Description copied from class: Pdu

Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object

Overrides:

equalsImpl in class WarfareFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class WarfareFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase