Package edu.nps.moves.dis7.pdus
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
5.10.2 Communicate information about the minefield, including the location, perimeter, and types of mines contained within it.
IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation - Application Protocols
- See Also:
- Serialized Form
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected MinefieldStateAppearanceBitMap
appearance bitflags uid 190protected ForceID
force ID uid 6protected MinefieldIdentifier
Minefield IDprotected Vector3Double
location of center of minefield in world coordsprotected EulerAngles
orientation of minefieldprotected short
Minefield sequenceprotected EntityType
type of minefieldprotected List<EntityType>
Type of minesprotected short
how many mine typesprotected byte
Number of permieter pointsprotected List<Vector2Float>
perimeter points for the minefieldprotected ProtocolMode
protocolMode.Fields inherited from class edu.nps.moves.dis7.pdus.Pdu
exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor creates and configures a new instance object -
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
equalsImpl(Object obj)
Compare all fields that contribute to the state, ignoring transient and static fields, forthis
and the supplied objectGetter forappearance
Getter forforceID
int
Returns size of this serialized (marshalled) object in bytesGetter forminefieldID
Getter forminefieldLocation
Getter forminefieldOrientation
short
Getter forminefieldSequence
Getter forminefieldType
Getter formineType
Getter forperimeterPoints
Getter forprotocolMode
void
marshal(DataOutputStream dos)
Serializes an object to a DataOutputStream.void
marshal(ByteBuffer byteBuffer)
Packs an object into the ByteBuffer.setAppearance(MinefieldStateAppearanceBitMap pAppearance)
Setter forappearance
setForceID(ForceID pForceID)
Setter forforceID
setMinefieldID(MinefieldIdentifier pMinefieldID)
Setter forminefieldID
setMinefieldLocation(Vector3Double pMinefieldLocation)
Setter forminefieldLocation
setMinefieldOrientation(EulerAngles pMinefieldOrientation)
Setter forminefieldOrientation
setMinefieldSequence(int pMinefieldSequence)
Utility setter forminefieldSequence
setMinefieldSequence(short pMinefieldSequence)
Setter forminefieldSequence
setMinefieldType(EntityType pMinefieldType)
Setter forminefieldType
setMineType(List<EntityType> pMineType)
Setter formineType
setPerimeterPoints(List<Vector2Float> pPerimeterPoints)
Setter forperimeterPoints
setProtocolMode(ProtocolMode pProtocolMode)
Setter forprotocolMode
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
getExerciseID, getLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, marshal, setExerciseID, setExerciseID, setLength, setLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp
-
Field Details
-
minefieldID
Minefield ID -
minefieldSequence
protected short minefieldSequenceMinefield sequence -
forceID
force ID uid 6 -
numberOfPerimeterPoints
protected byte numberOfPerimeterPointsNumber of permieter points -
minefieldType
type of minefield -
numberOfMineTypes
protected short numberOfMineTypeshow many mine types -
minefieldLocation
location of center of minefield in world coords -
minefieldOrientation
orientation of minefield -
appearance
appearance bitflags uid 190 -
protocolMode
protocolMode. First two bits are the protocol mode, 14 bits reserved. -
perimeterPoints
perimeter points for the minefield -
mineType
Type of mines
-
-
Constructor Details
-
MinefieldStatePdu
public MinefieldStatePdu()Constructor creates and configures a new instance object
-
-
Method Details
-
getMarshalledSize
public int getMarshalledSize()Returns size of this serialized (marshalled) object in bytes- Specified by:
getMarshalledSize
in interfaceMarshaller
- Overrides:
getMarshalledSize
in classMinefieldFamilyPdu
- Returns:
- serialized size in bytes
- See Also:
- https://en.wikipedia.org/wiki/Marshalling_(computer_science)
-
setMinefieldID
Setter forminefieldID
- Parameters:
pMinefieldID
- new value of interest- Returns:
- same object to permit progressive setters
-
getMinefieldID
Getter forminefieldID
- Returns:
- value of interest
-
setMinefieldSequence
Setter forminefieldSequence
- Parameters:
pMinefieldSequence
- new value of interest- Returns:
- same object to permit progressive setters
-
setMinefieldSequence
Utility setter forminefieldSequence
- Parameters:
pMinefieldSequence
- new value of interest- Returns:
- same object to permit progressive setters
-
getMinefieldSequence
public short getMinefieldSequence()Getter forminefieldSequence
- Returns:
- value of interest
-
setForceID
Setter forforceID
- Parameters:
pForceID
- new value of interest- Returns:
- same object to permit progressive setters
-
getForceID
Getter forforceID
- Returns:
- value of interest
-
setMinefieldType
Setter forminefieldType
- Parameters:
pMinefieldType
- new value of interest- Returns:
- same object to permit progressive setters
-
getMinefieldType
Getter forminefieldType
- Returns:
- value of interest
-
setMinefieldLocation
Setter forminefieldLocation
- Parameters:
pMinefieldLocation
- new value of interest- Returns:
- same object to permit progressive setters
-
getMinefieldLocation
Getter forminefieldLocation
- Returns:
- value of interest
-
setMinefieldOrientation
Setter forminefieldOrientation
- Parameters:
pMinefieldOrientation
- new value of interest- Returns:
- same object to permit progressive setters
-
getMinefieldOrientation
Getter forminefieldOrientation
- Returns:
- value of interest
-
setAppearance
Setter forappearance
- Parameters:
pAppearance
- new value of interest- Returns:
- same object to permit progressive setters
-
getAppearance
Getter forappearance
- Returns:
- value of interest
-
setProtocolMode
Setter forprotocolMode
- Parameters:
pProtocolMode
- new value of interest- Returns:
- same object to permit progressive setters
-
getProtocolMode
Getter forprotocolMode
- Returns:
- value of interest
-
setPerimeterPoints
Setter forperimeterPoints
- Parameters:
pPerimeterPoints
- new value of interest- Returns:
- same object to permit progressive setters
-
getPerimeterPoints
Getter forperimeterPoints
- Returns:
- value of interest
-
setMineType
Setter formineType
- Parameters:
pMineType
- new value of interest- Returns:
- same object to permit progressive setters
-
getMineType
Getter formineType
- Returns:
- value of interest
-
marshal
Serializes an object to a DataOutputStream.- Specified by:
marshal
in interfaceMarshaller
- Overrides:
marshal
in classMinefieldFamilyPdu
- Parameters:
dos
- the OutputStream- Throws:
Exception
- if something goes wrong- See Also:
DataOutputStream
-
unmarshal
Deserializes an object from a DataInputStream.- Specified by:
unmarshal
in interfaceMarshaller
- Overrides:
unmarshal
in classMinefieldFamilyPdu
- 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
Packs an object into the ByteBuffer.- Specified by:
marshal
in interfaceMarshaller
- Overrides:
marshal
in classMinefieldFamilyPdu
- Parameters:
byteBuffer
- The ByteBuffer at the position to begin writing- Throws:
BufferOverflowException
- if byteBuffer is too smallReadOnlyBufferException
- if byteBuffer is read onlyException
- ByteBuffer-generated exception- See Also:
ByteBuffer
-
unmarshal
Unpacks a Pdu from the underlying data.- Specified by:
unmarshal
in interfaceMarshaller
- Overrides:
unmarshal
in classMinefieldFamilyPdu
- Parameters:
byteBuffer
- The ByteBuffer at the position to begin reading- Returns:
- marshalled serialized size in bytes
- Throws:
BufferUnderflowException
- if byteBuffer is too smallException
- ByteBuffer-generated exception- See Also:
ByteBuffer
, https://en.wikipedia.org/wiki/Marshalling_(computer_science)
-
equals
- Overrides:
equals
in classMinefieldFamilyPdu
-
equalsImpl
Description copied from class:Pdu
Compare all fields that contribute to the state, ignoring transient and static fields, forthis
and the supplied object- Overrides:
equalsImpl
in classMinefieldFamilyPdu
- Parameters:
obj
- the object to compare to- Returns:
- true if the objects are equal, false otherwise.
-
toString
- Overrides:
toString
in classMinefieldFamilyPdu
-