Package edu.nps.moves.dis7
Class StopFreezePdu
java.lang.Object
edu.nps.moves.dis7.Pdu
edu.nps.moves.dis7.PduBase
edu.nps.moves.dis7.SimulationManagementFamilyPdu
edu.nps.moves.dis7.StopFreezePdu
- All Implemented Interfaces:
edu.nps.moves.dis7.Marshaller,java.io.Serializable
public class StopFreezePdu extends SimulationManagementFamilyPdu implements java.io.Serializable
Section 7.5.5. Stop or freeze an enity or exercise. See 5.6.5.5
IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation—Application Protocols
- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description protected StopFreezeFrozenBehaviorfrozenBehaviorInternal behavior of the entity(or simulation) and its appearance while frozen to the other participants uid 68protected shortpadding1paddingprotected ClockTimerealWorldTimereal-world(UTC) time at which the entity shall stop or freeze in the exerciseprotected StopFreezeReasonreasonReason the simulation was stopped or frozen (see section 7 of SISO-REF-010) represented by an 8-bit enumeration uid 67protected intrequestIDRequest ID that is uniqueFields inherited from class edu.nps.moves.dis7.SimulationManagementFamilyPdu
originatingID, receivingIDFields inherited from class edu.nps.moves.dis7.Pdu
exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp -
Constructor Summary
Constructors Constructor Description StopFreezePdu()Constructor -
Method Summary
Modifier and Type Method Description booleanequals(java.lang.Object obj)booleanequalsImpl(java.lang.Object obj)Compare all fields that contribute to the state, ignoring transient and static fields, forthisand the supplied objectStopFreezeFrozenBehaviorgetFrozenBehavior()Setter forfrozenBehaviorintgetMarshalledSize()Returns the size of this serialized object in bytesshortgetPadding1()Getter forpadding1ClockTimegetRealWorldTime()Getter forrealWorldTimeStopFreezeReasongetReason()Getter forreasonintgetRequestID()Getter forrequestIDvoidmarshal(java.io.DataOutputStream dos)Serializes an object to a DataOutputStream.voidmarshal(java.nio.ByteBuffer buff)Packs an object into the ByteBuffer.StopFreezePdusetFrozenBehavior(StopFreezeFrozenBehavior pFrozenBehavior)Setter forfrozenBehaviorStopFreezePdusetPadding1(short pPadding1)Setter forpadding1StopFreezePdusetRealWorldTime(ClockTime pRealWorldTime)Setter forrealWorldTimeStopFreezePdusetReason(StopFreezeReason pReason)Setter forreasonStopFreezePdusetRequestID(int pRequestID)Setter forrequestIDjava.lang.StringtoString()intunmarshal(java.io.DataInputStream dis)Unserializes an object from a DataInputStream.intunmarshal(java.nio.ByteBuffer buff)Unpacks a Pdu from the underlying data.Methods inherited from class edu.nps.moves.dis7.SimulationManagementFamilyPdu
getOriginatingID, getReceivingID, setOriginatingID, setReceivingIDMethods inherited from class edu.nps.moves.dis7.PduBase
getPadding, getPduStatus, setPadding, setPduStatusMethods inherited from class edu.nps.moves.dis7.Pdu
getExerciseID, getLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, marshal, setExerciseID, setLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp
-
Field Details
-
realWorldTime
real-world(UTC) time at which the entity shall stop or freeze in the exercise -
reason
Reason the simulation was stopped or frozen (see section 7 of SISO-REF-010) represented by an 8-bit enumeration uid 67 -
frozenBehavior
Internal behavior of the entity(or simulation) and its appearance while frozen to the other participants uid 68 -
padding1
protected short padding1padding -
requestID
protected int requestIDRequest ID that is unique
-
-
Constructor Details
-
StopFreezePdu
public StopFreezePdu()Constructor
-
-
Method Details
-
getMarshalledSize
public int getMarshalledSize()Returns the size of this serialized object in bytes- Specified by:
getMarshalledSizein interfaceedu.nps.moves.dis7.Marshaller- Overrides:
getMarshalledSizein classSimulationManagementFamilyPdu
-
setRealWorldTime
Setter forrealWorldTime -
getRealWorldTime
Getter forrealWorldTime -
setReason
Setter forreason -
getReason
Getter forreason -
setFrozenBehavior
Setter forfrozenBehavior -
getFrozenBehavior
Setter forfrozenBehavior -
setPadding1
Setter forpadding1 -
getPadding1
public short getPadding1()Getter forpadding1 -
setRequestID
Setter forrequestID -
getRequestID
public int getRequestID()Getter forrequestID -
marshal
public void marshal(java.io.DataOutputStream dos) throws java.lang.ExceptionSerializes an object to a DataOutputStream.- Specified by:
marshalin interfaceedu.nps.moves.dis7.Marshaller- Overrides:
marshalin classSimulationManagementFamilyPdu- Parameters:
dos- the OutputStream- Throws:
java.lang.Exception- if something goes wrong- See Also:
DataOutputStream
-
unmarshal
public int unmarshal(java.io.DataInputStream dis) throws java.lang.ExceptionUnserializes an object from a DataInputStream.- Specified by:
unmarshalin interfaceedu.nps.moves.dis7.Marshaller- Overrides:
unmarshalin classSimulationManagementFamilyPdu- Parameters:
dis- the InputStream- Returns:
- unmarshalled size
- Throws:
java.lang.Exception- if something goes wrong- See Also:
DataInputStream
-
marshal
public void marshal(java.nio.ByteBuffer buff) throws java.lang.ExceptionPacks an object into the ByteBuffer.- Specified by:
marshalin interfaceedu.nps.moves.dis7.Marshaller- Overrides:
marshalin classSimulationManagementFamilyPdu- Parameters:
buff- The ByteBuffer at the position to begin writing- Throws:
java.nio.BufferOverflowException- if buff is too smalljava.nio.ReadOnlyBufferException- if buff is read onlyjava.lang.Exception- ByteBuffer-generated exception- See Also:
ByteBuffer
-
unmarshal
public int unmarshal(java.nio.ByteBuffer buff) throws java.lang.ExceptionUnpacks a Pdu from the underlying data.- Specified by:
unmarshalin interfaceedu.nps.moves.dis7.Marshaller- Overrides:
unmarshalin classSimulationManagementFamilyPdu- Parameters:
buff- The ByteBuffer at the position to begin reading- Returns:
- marshalled size
- Throws:
java.nio.BufferUnderflowException- if buff is too smalljava.lang.Exception- ByteBuffer-generated exception- See Also:
ByteBuffer
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equalsin classSimulationManagementFamilyPdu
-
equalsImpl
public boolean equalsImpl(java.lang.Object obj)Description copied from class:PduCompare all fields that contribute to the state, ignoring transient and static fields, forthisand the supplied object- Overrides:
equalsImplin classSimulationManagementFamilyPdu- Parameters:
obj- the object to compare to- Returns:
- true if the objects are equal, false otherwise.
-
toString
public java.lang.String toString()- Overrides:
toStringin classSimulationManagementFamilyPdu
-