edu.nps.moves.dis7mobile
Class StopFreezePdu

java.lang.Object
  edu.nps.moves.dis7mobile.PduSuperclass
      edu.nps.moves.dis7mobile.Pdu
          edu.nps.moves.dis7mobile.SimulationManagementFamilyPdu
              edu.nps.moves.dis7mobile.StopFreezePdu

All Implemented Interfaces:

java.io.Serializable

public class StopFreezePdu
extends SimulationManagementFamilyPdu
implements java.io.Serializable

Section 7.5.5. Stop or freeze an enity (or 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

protected short	frozenBehavior Internal behavior of the entity(or simulation) and its appearance while frozen to the other participants
protected EntityID	originatingID Identifier for originating entity(or simulation)
protected short	padding1 padding
protected ClockTime	realWorldTime real-world(UTC) time at which the entity shall stop or freeze in the exercise
protected short	reason Reason the simulation was stopped or frozen (see section 7 of SISO-REF-010) represented by an 8-bit enumeration
protected EntityID	receivingID Identifier for the receiving entity(or simulation)
protected long	requestID Request ID that is unique

Fields inherited from class edu.nps.moves.dis7mobile.SimulationManagementFamilyPdu

originatingEntityID, receivingEntityID

Fields inherited from class edu.nps.moves.dis7mobile.Pdu

padding, pduStatus

Fields inherited from class edu.nps.moves.dis7mobile.PduSuperclass

exerciseID, length, 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()
EntityID	getOriginatingID()
short	getPadding1()
ClockTime	getRealWorldTime()
short	getReason()
EntityID	getReceivingID()
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	setOriginatingID(EntityID pOriginatingID)
void	setPadding1(short pPadding1)
void	setRealWorldTime(ClockTime pRealWorldTime)
void	setReason(short pReason)
void	setReceivingID(EntityID pReceivingID)
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.dis7mobile.SimulationManagementFamilyPdu

getOriginatingEntityID, getReceivingEntityID, setOriginatingEntityID, setReceivingEntityID

Methods inherited from class edu.nps.moves.dis7mobile.Pdu

getPadding, getPduStatus, marshal, setPadding, setPduStatus

Methods inherited from class edu.nps.moves.dis7mobile.PduSuperclass

getExerciseID, getLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, setExerciseID, setLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

originatingID

protected EntityID originatingID

Identifier for originating entity(or simulation)

receivingID

protected EntityID receivingID

Identifier for the receiving entity(or simulation)

realWorldTime

protected ClockTime realWorldTime

real-world(UTC) time at which the entity shall stop or freeze in the exercise

reason

protected short reason

Reason the simulation was stopped or frozen (see section 7 of SISO-REF-010) represented by an 8-bit enumeration

frozenBehavior

protected short frozenBehavior

Internal behavior of the entity(or simulation) and its appearance while frozen to the other participants

padding1

protected short padding1

padding

requestID

protected long requestID

Request ID that is unique

Constructor Detail

StopFreezePdu

public StopFreezePdu()

Constructor

Method Detail

getMarshalledSize

public int getMarshalledSize()

Overrides:

getMarshalledSize in class SimulationManagementFamilyPdu

setOriginatingID

public void setOriginatingID(EntityID pOriginatingID)

getOriginatingID

public EntityID getOriginatingID()

setReceivingID

public void setReceivingID(EntityID pReceivingID)

getReceivingID

public EntityID getReceivingID()

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: PduSuperclass

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.