Class MinefieldStatePdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.MinefieldFamilyPdu

edu.nps.moves.dis7.pdus.MinefieldStatePdu

All Implemented Interfaces:

Marshaller, Serializable

public class MinefieldStatePdu
extends MinefieldFamilyPdu
implements Serializable

5.10.2 Communicate information about the minefield, including the location, perimeter, and types of mines contained within it.

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 MinefieldStateAppearanceBitMap	appearance	appearance bitflags information needed for displaying the symbology of the minefield as a doctrinal minefield graphic uid 190
protected ByteArrayOutputStream	byteArrayOutputStream	byteArrayOutputStream (baos) is used for marshal/unmarshal serialization
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected ForceID	forceID	force ID provides a unique identifier uid 6
protected MinefieldIdentifier	minefieldID	Minefield ID provides a unique identifier
protected Vector3Double	minefieldLocation	location of center of minefield in world coordinates
protected EulerAngles	minefieldOrientation	orientation of minefield
protected short	minefieldSequence	Minefield sequence number shall specify a change in state of a minefield as a result of a change in minefield information or a change in the state, in accordance with the rules specified in 5.10.2.3, of any of the mines contained therein
protected EntityType	minefieldType	type of minefield
protected List<EntityType>	mineType	type of each mine contained within the minefield
static final String	NAME	The name of this PDU type
protected short	numberOfMineTypes	the number of different mine types employed in the minefield
protected byte	numberOfPerimeterPoints	Number of permieter points
protected List<Vector2Float>	perimeterPoints	location of each perimeter point, relative to the Minefield Location field.
protected ProtocolMode	protocolMode	protocolMode.

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

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
MinefieldStatePdu()	Constructor creates and configures a new instance object

Method Summary

Modifier and Type	Method	Description
MinefieldStatePdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
MinefieldStatePdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
MinefieldStatePdu	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
MinefieldStateAppearanceBitMap	getAppearance()	Getter for appearance
ForceID	getForceID()	Getter for forceID
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
MinefieldIdentifier	getMinefieldID()	Getter for minefieldID
Vector3Double	getMinefieldLocation()	Getter for minefieldLocation
EulerAngles	getMinefieldOrientation()	Getter for minefieldOrientation
short	getMinefieldSequence()	Getter for minefieldSequence
EntityType	getMinefieldType()	Getter for minefieldType
List<EntityType>	getMineType()	Getter for mineType
List<Vector2Float>	getPerimeterPoints()	Getter for perimeterPoints
ProtocolMode	getProtocolMode()	Getter for protocolMode
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
MinefieldStatePdu	setAppearance(MinefieldStateAppearanceBitMap pAppearance)	Setter for appearance
MinefieldStatePdu	setForceID(ForceID pForceID)	Setter for forceID
MinefieldStatePdu	setMinefieldID(MinefieldIdentifier pMinefieldID)	Setter for minefieldID
MinefieldStatePdu	setMinefieldLocation(Vector3Double pMinefieldLocation)	Setter for minefieldLocation
MinefieldStatePdu	setMinefieldOrientation(EulerAngles pMinefieldOrientation)	Setter for minefieldOrientation
MinefieldStatePdu	setMinefieldSequence(int pMinefieldSequence)	Utility setter for minefieldSequence
MinefieldStatePdu	setMinefieldSequence(short pMinefieldSequence)	Setter for minefieldSequence
MinefieldStatePdu	setMinefieldType(EntityType pMinefieldType)	Setter for minefieldType
MinefieldStatePdu	setMineType(List<EntityType> pMineType)	Setter for mineType
MinefieldStatePdu	setPerimeterPoints(List<Vector2Float> pPerimeterPoints)	Setter for perimeterPoints
MinefieldStatePdu	setProtocolMode(ProtocolMode pProtocolMode)	Setter for protocolMode
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

minefieldID

protected MinefieldIdentifier minefieldID

Minefield ID provides a unique identifier

minefieldSequence

protected short minefieldSequence

Minefield sequence number shall specify a change in state of a minefield as a result of a change in minefield information or a change in the state, in accordance with the rules specified in 5.10.2.3, of any of the mines contained therein

forceID

protected ForceID forceID

force ID provides a unique identifier uid 6

numberOfPerimeterPoints

protected byte numberOfPerimeterPoints

Number of permieter points

minefieldType

protected EntityType minefieldType

type of minefield

numberOfMineTypes

protected short numberOfMineTypes

the number of different mine types employed in the minefield

minefieldLocation

protected Vector3Double minefieldLocation

location of center of minefield in world coordinates

minefieldOrientation

protected EulerAngles minefieldOrientation

orientation of minefield

appearance

protected MinefieldStateAppearanceBitMap appearance

appearance bitflags information needed for displaying the symbology of the minefield as a doctrinal minefield graphic uid 190

protocolMode

protected ProtocolMode protocolMode

protocolMode. First two bits are the protocol mode, 14 bits reserved.

perimeterPoints

protected List<Vector2Float> perimeterPoints

location of each perimeter point, relative to the Minefield Location field. Only the x and y coordinates of each perimeter point shall be specified.

mineType

protected List<EntityType> mineType

type of each mine contained within the minefield

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

MinefieldStatePdu

public MinefieldStatePdu()

Constructor creates and configures a new instance object

Method Details

copy

public MinefieldStatePdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public MinefieldStatePdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public MinefieldStatePdu 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 MinefieldFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setMinefieldID

public MinefieldStatePdu setMinefieldID(MinefieldIdentifier pMinefieldID)

Setter for minefieldID

Parameters:

pMinefieldID - new value of interest

Returns:

same object to permit progressive setters

getMinefieldID

public MinefieldIdentifier getMinefieldID()

Getter for minefieldID

Returns:

value of interest

setMinefieldSequence

public MinefieldStatePdu setMinefieldSequence(short pMinefieldSequence)

Setter for minefieldSequence

Parameters:

pMinefieldSequence - new value of interest

Returns:

same object to permit progressive setters

setMinefieldSequence

public MinefieldStatePdu setMinefieldSequence(int pMinefieldSequence)

Utility setter for minefieldSequence

Parameters:

pMinefieldSequence - new value of interest

Returns:

same object to permit progressive setters

getMinefieldSequence

public short getMinefieldSequence()

Getter for minefieldSequence

Returns:

value of interest

setForceID

public MinefieldStatePdu setForceID(ForceID pForceID)

Setter for forceID

Parameters:

pForceID - new value of interest

Returns:

same object to permit progressive setters

getForceID

public ForceID getForceID()

Getter for forceID

Returns:

value of interest

setMinefieldType

public MinefieldStatePdu setMinefieldType(EntityType pMinefieldType)

Setter for minefieldType

Parameters:

pMinefieldType - new value of interest

Returns:

same object to permit progressive setters

getMinefieldType

public EntityType getMinefieldType()

Getter for minefieldType

Returns:

value of interest

setMinefieldLocation

public MinefieldStatePdu setMinefieldLocation(Vector3Double pMinefieldLocation)

Setter for minefieldLocation

Parameters:

pMinefieldLocation - new value of interest

Returns:

same object to permit progressive setters

getMinefieldLocation

public Vector3Double getMinefieldLocation()

Getter for minefieldLocation

Returns:

value of interest

setMinefieldOrientation

public MinefieldStatePdu setMinefieldOrientation(EulerAngles pMinefieldOrientation)

Setter for minefieldOrientation

Parameters:

pMinefieldOrientation - new value of interest

Returns:

same object to permit progressive setters

getMinefieldOrientation

public EulerAngles getMinefieldOrientation()

Getter for minefieldOrientation

Returns:

value of interest

setAppearance

public MinefieldStatePdu setAppearance(MinefieldStateAppearanceBitMap pAppearance)

Setter for appearance

Parameters:

pAppearance - new value of interest

Returns:

same object to permit progressive setters

getAppearance

public MinefieldStateAppearanceBitMap getAppearance()

Getter for appearance

Returns:

value of interest

setProtocolMode

public MinefieldStatePdu setProtocolMode(ProtocolMode pProtocolMode)

Setter for protocolMode

Parameters:

pProtocolMode - new value of interest

Returns:

same object to permit progressive setters

getProtocolMode

public ProtocolMode getProtocolMode()

Getter for protocolMode

Returns:

value of interest

setPerimeterPoints

public MinefieldStatePdu setPerimeterPoints(List<Vector2Float> pPerimeterPoints)

Setter for perimeterPoints

Parameters:

pPerimeterPoints - new value of interest

Returns:

same object to permit progressive setters

getPerimeterPoints

public List<Vector2Float> getPerimeterPoints()

Getter for perimeterPoints

Returns:

value of interest

setMineType

public MinefieldStatePdu setMineType(List<EntityType> pMineType)

Setter for mineType

Parameters:

pMineType - new value of interest

Returns:

same object to permit progressive setters

getMineType

public List<EntityType> getMineType()

Getter for mineType

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 MinefieldFamilyPdu

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 MinefieldFamilyPdu

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 MinefieldFamilyPdu

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 MinefieldFamilyPdu

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 MinefieldFamilyPdu

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 MinefieldFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class MinefieldFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase