Class LEFirePdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.LiveEntityFamilyPdu

edu.nps.moves.dis7.pdus.LEFirePdu

All Implemented Interfaces:

Marshaller, Serializable

Direct Known Subclasses:

LiveEntityFirePdu

public class LEFirePdu
extends LiveEntityFamilyPdu
implements Serializable

9.4.5 Representation of weapons fire in a DIS exercise involving LEs.

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 ByteArrayOutputStream	byteArrayOutputStream	byteArrayOutputStream (baos) is used for marshal/unmarshal serialization
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected EventIdentifier	eventId	eventId is an undescribed parameter...
protected EntityID	firingLiveEntityId	firingLiveEntityId is an undescribed parameter...
protected byte	flags	Bits defined in IEEE Standard
protected LiveEntityRelativeWorldCoordinates	location	location is an undescribed parameter...
protected MunitionDescriptor	munitionDescriptor	munitionDescriptor is an undescribed parameter...
protected EntityID	munitionLiveEntityId	munitionLiveEntityId is an undescribed parameter...
static final String	NAME	The name of this PDU type
protected short	range	range is an undescribed parameter...
protected EntityID	targetLiveEntityId	targetLiveEntityId is an undescribed parameter...
protected LiveEntityLinearVelocity	velocity	velocity is an undescribed parameter...

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

FAMILY_NAME

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

exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
LEFirePdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
LEFirePdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
LEFirePdu	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
EventIdentifier	getEventId()	Getter for eventId
EntityID	getFiringLiveEntityId()	Getter for firingLiveEntityId
byte	getFlags()	Getter for flags
LiveEntityRelativeWorldCoordinates	getLocation()	Getter for location
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
MunitionDescriptor	getMunitionDescriptor()	Getter for munitionDescriptor
EntityID	getMunitionLiveEntityId()	Getter for munitionLiveEntityId
short	getRange()	Getter for range
EntityID	getTargetLiveEntityId()	Getter for targetLiveEntityId
LiveEntityLinearVelocity	getVelocity()	Getter for velocity
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
LEFirePdu	setEventId(EventIdentifier pEventId)	Setter for eventId
LEFirePdu	setFiringLiveEntityId(EntityID pFiringLiveEntityId)	Setter for firingLiveEntityId
LEFirePdu	setFlags(byte pFlags)	Setter for flags
LEFirePdu	setFlags(int pFlags)	Utility setter for flags
LEFirePdu	setLocation(LiveEntityRelativeWorldCoordinates pLocation)	Setter for location
LEFirePdu	setMunitionDescriptor(MunitionDescriptor pMunitionDescriptor)	Setter for munitionDescriptor
LEFirePdu	setMunitionLiveEntityId(EntityID pMunitionLiveEntityId)	Setter for munitionLiveEntityId
LEFirePdu	setRange(int pRange)	Utility setter for range
LEFirePdu	setRange(short pRange)	Setter for range
LEFirePdu	setTargetLiveEntityId(EntityID pTargetLiveEntityId)	Setter for targetLiveEntityId
LEFirePdu	setVelocity(LiveEntityLinearVelocity pVelocity)	Setter for velocity
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.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

firingLiveEntityId

protected EntityID firingLiveEntityId

firingLiveEntityId is an undescribed parameter...

flags

protected byte flags

Bits defined in IEEE Standard

targetLiveEntityId

protected EntityID targetLiveEntityId

targetLiveEntityId is an undescribed parameter...

munitionLiveEntityId

protected EntityID munitionLiveEntityId

munitionLiveEntityId is an undescribed parameter...

eventId

protected EventIdentifier eventId

eventId is an undescribed parameter...

location

protected LiveEntityRelativeWorldCoordinates location

location is an undescribed parameter...

munitionDescriptor

protected MunitionDescriptor munitionDescriptor

munitionDescriptor is an undescribed parameter...

velocity

protected LiveEntityLinearVelocity velocity

velocity is an undescribed parameter...

range

protected short range

range is an undescribed parameter...

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

LEFirePdu

public LEFirePdu()

Constructor creates and configures a new instance object

Method Details

copy

public LEFirePdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public LEFirePdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public LEFirePdu 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 LiveEntityFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setFiringLiveEntityId

public LEFirePdu setFiringLiveEntityId(EntityID pFiringLiveEntityId)

Setter for firingLiveEntityId

Parameters:

pFiringLiveEntityId - new value of interest

Returns:

same object to permit progressive setters

getFiringLiveEntityId

public EntityID getFiringLiveEntityId()

Getter for firingLiveEntityId

Returns:

value of interest

setFlags

public LEFirePdu setFlags(byte pFlags)

Setter for flags

Parameters:

pFlags - new value of interest

Returns:

same object to permit progressive setters

setFlags

public LEFirePdu setFlags(int pFlags)

Utility setter for flags

Parameters:

pFlags - new value of interest

Returns:

same object to permit progressive setters

getFlags

public byte getFlags()

Getter for flags

Returns:

value of interest

setTargetLiveEntityId

public LEFirePdu setTargetLiveEntityId(EntityID pTargetLiveEntityId)

Setter for targetLiveEntityId

Parameters:

pTargetLiveEntityId - new value of interest

Returns:

same object to permit progressive setters

getTargetLiveEntityId

public EntityID getTargetLiveEntityId()

Getter for targetLiveEntityId

Returns:

value of interest

setMunitionLiveEntityId

public LEFirePdu setMunitionLiveEntityId(EntityID pMunitionLiveEntityId)

Setter for munitionLiveEntityId

Parameters:

pMunitionLiveEntityId - new value of interest

Returns:

same object to permit progressive setters

getMunitionLiveEntityId

public EntityID getMunitionLiveEntityId()

Getter for munitionLiveEntityId

Returns:

value of interest

setEventId

public LEFirePdu 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

setLocation

public LEFirePdu setLocation(LiveEntityRelativeWorldCoordinates pLocation)

Setter for location

Parameters:

pLocation - new value of interest

Returns:

same object to permit progressive setters

getLocation

public LiveEntityRelativeWorldCoordinates getLocation()

Getter for location

Returns:

value of interest

setMunitionDescriptor

public LEFirePdu setMunitionDescriptor(MunitionDescriptor pMunitionDescriptor)

Setter for munitionDescriptor

Parameters:

pMunitionDescriptor - new value of interest

Returns:

same object to permit progressive setters

getMunitionDescriptor

public MunitionDescriptor getMunitionDescriptor()

Getter for munitionDescriptor

Returns:

value of interest

setVelocity

public LEFirePdu setVelocity(LiveEntityLinearVelocity pVelocity)

Setter for velocity

Parameters:

pVelocity - new value of interest

Returns:

same object to permit progressive setters

getVelocity

public LiveEntityLinearVelocity getVelocity()

Getter for velocity

Returns:

value of interest

setRange

public LEFirePdu setRange(short pRange)

Setter for range

Parameters:

pRange - new value of interest

Returns:

same object to permit progressive setters

setRange

public LEFirePdu setRange(int pRange)

Utility setter for range

Parameters:

pRange - new value of interest

Returns:

same object to permit progressive setters

getRange

public short getRange()

Getter for range

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 LiveEntityFamilyPdu

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 LiveEntityFamilyPdu

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 LiveEntityFamilyPdu

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 LiveEntityFamilyPdu

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 LiveEntityFamilyPdu

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 LiveEntityFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class LiveEntityFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class Pdu