edu.nps.moves.dis
Class StopFreezePdu

java.lang.Object
  extended by edu.nps.moves.dis.Pdu
      extended by edu.nps.moves.dis.SimulationManagementFamilyPdu
          extended by edu.nps.moves.dis.StopFreezePdu
All Implemented Interfaces:
java.io.Serializable

@Entity
public class StopFreezePdu
extends SimulationManagementFamilyPdu
implements java.io.Serializable

Section 5.2.3.4. Stop or freeze an exercise. COMPLETE Copyright (c) 2008-2010, MOVES Institute, Naval Postgraduate School. All rights reserved. This work is licensed under the BSD open source license, available at https://www.movesinstitute.org/licenses/bsd.html

Author:
DMcG
See Also:
Serialized Form

Field Summary
 long fk_realWorldTime
           
protected  short frozenBehavior
          Internal behavior of the simulation and its appearance while frozento the other participants
protected  short padding1
          padding
protected  ClockTime realWorldTime
          UTC time at which the simulation shall stop or freeze
protected  short reason
          Reason the simulation was stopped or frozen
protected  long requestID
          Request ID that is unique
 
Fields inherited from class edu.nps.moves.dis.SimulationManagementFamilyPdu
fk_originatingEntityID, fk_receivingEntityID, originatingEntityID, receivingEntityID
 
Fields inherited from class edu.nps.moves.dis.Pdu
exerciseID, padding, pduLength, pduType, protocolFamily, protocolVersion, timestamp
 
Constructor Summary
StopFreezePdu()
          Constructor
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 boolean equalsImpl(java.lang.Object obj)
          Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object
 short getFrozenBehavior()
           
 int getMarshalledSize()
           
 short getPadding1()
           
 ClockTime getRealWorldTime()
           
 short getReason()
           
 long getRequestID()
           
 void marshal(java.nio.ByteBuffer buff)
          Packs a Pdu into the ByteBuffer.
 void marshal(java.io.DataOutputStream dos)
           
 void setFrozenBehavior(short pFrozenBehavior)
           
 void setPadding1(short pPadding1)
           
 void setRealWorldTime(ClockTime pRealWorldTime)
           
 void setReason(short pReason)
           
 void setRequestID(long pRequestID)
           
 void unmarshal(java.nio.ByteBuffer buff)
          Unpacks a Pdu from the underlying data.
 void unmarshal(java.io.DataInputStream dis)
           
 
Methods inherited from class edu.nps.moves.dis.SimulationManagementFamilyPdu
getOriginatingEntityID, getReceivingEntityID, setOriginatingEntityID, setReceivingEntityID
 
Methods inherited from class edu.nps.moves.dis.Pdu
getExerciseID, getLength, getPadding, getPduLength, getPduType, getPduTypeEnum, getPk_Pdu, getProtocolFamily, getProtocolVersion, getTimestamp, marshal, marshalWithDisAbsoluteTimestamp, marshalWithDisAbsoluteTimestamp, marshalWithDisRelativeTimestamp, marshalWithDisRelativeTimestamp, marshalWithNpsTimestamp, marshalWithNpsTimestamp, marshalWithUnixTimestamp, marshalWithUnixTimestamp, readUnsignedInt, readUnsignedInt, setExerciseID, setPadding, setPduLength, setPduType, setPk_Pdu, setProtocolFamily, setProtocolVersion, setTimestamp
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

realWorldTime

protected ClockTime realWorldTime
UTC time at which the simulation shall stop or freeze


reason

protected short reason
Reason the simulation was stopped or frozen


frozenBehavior

protected short frozenBehavior
Internal behavior of the simulation and its appearance while frozento the other participants


padding1

protected short padding1
padding


requestID

protected long requestID
Request ID that is unique


fk_realWorldTime

public long fk_realWorldTime
Constructor Detail

StopFreezePdu

public StopFreezePdu()
Constructor

Method Detail

getMarshalledSize

public int getMarshalledSize()
Overrides:
getMarshalledSize in class SimulationManagementFamilyPdu

setRealWorldTime

public void setRealWorldTime(ClockTime pRealWorldTime)

getRealWorldTime

public ClockTime getRealWorldTime()

setReason

public void setReason(short pReason)

getReason

public short getReason()

setFrozenBehavior

public void setFrozenBehavior(short pFrozenBehavior)

getFrozenBehavior

public short getFrozenBehavior()

setPadding1

public void setPadding1(short pPadding1)

getPadding1

public short getPadding1()

setRequestID

public void setRequestID(long pRequestID)

getRequestID

public long getRequestID()

marshal

public void marshal(java.io.DataOutputStream dos)
Overrides:
marshal in class SimulationManagementFamilyPdu

unmarshal

public void unmarshal(java.io.DataInputStream dis)
Overrides:
unmarshal in class SimulationManagementFamilyPdu

marshal

public void marshal(java.nio.ByteBuffer buff)
Packs a Pdu into the ByteBuffer.

Overrides:
marshal in class SimulationManagementFamilyPdu
Parameters:
buff - The ByteBuffer at the position to begin writing
Throws:
java.nio.BufferOverflowException - if buff is too small
java.nio.ReadOnlyBufferException - if buff is read only
Since:
??
See Also:
ByteBuffer

unmarshal

public void unmarshal(java.nio.ByteBuffer buff)
Unpacks a Pdu from the underlying data.

Overrides:
unmarshal in class SimulationManagementFamilyPdu
Parameters:
buff - The ByteBuffer at the position to begin reading
Throws:
java.nio.BufferUnderflowException - if buff is too small
Since:
??
See Also:
ByteBuffer

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class SimulationManagementFamilyPdu

equalsImpl

public boolean equalsImpl(java.lang.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 SimulationManagementFamilyPdu
Parameters:
obj - the object to compare to
Returns:
true if the objects are equal, false otherwise.