Class StopFreezePdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.SimulationManagementFamilyPdu

edu.nps.moves.dis7.pdus.StopFreezePdu

All Implemented Interfaces:

Marshaller, Serializable

public class StopFreezePdu
extends SimulationManagementFamilyPdu
implements Serializable

Section 7.5.5. The stopping or freezing of an entity/exercise shall be communicated using a Stop/Freeze PDU. See 5.6.5.5

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 ByteArrayOutputStream	byteArrayOutputStream	byteArrayOutputStream (baos) is used for marshal/unmarshal serialization
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected StopFreezeFrozenBehavior	frozenBehavior	Internal behavior of the entity (or simulation) and its appearance while frozen to the other participants uid 68
static final String	NAME	The name of this PDU type
protected short	padding1	padding
protected ClockTime	realWorldTime	real-world(UTC) time at which the entity shall stop or freeze in the exercise
protected StopFreezeReason	reason	Reason the simulation was stopped or frozen (see section 7 of SISO-REF-010) represented by an 8-bit enumeration uid 67
protected int	requestID	Request ID that is unique

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

FAMILY_NAME, originatingID, receivingID

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

Method Summary

Modifier and Type	Method	Description
StopFreezePdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
StopFreezePdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
StopFreezePdu	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
StopFreezeFrozenBehavior	getFrozenBehavior()	Getter for frozenBehavior
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
short	getPadding1()	Getter for padding1
ClockTime	getRealWorldTime()	Getter for realWorldTime
StopFreezeReason	getReason()	Getter for reason
int	getRequestID()	Getter for requestID
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
StopFreezePdu	setFrozenBehavior(StopFreezeFrozenBehavior pFrozenBehavior)	Setter for frozenBehavior
StopFreezePdu	setPadding1(int pPadding1)	Utility setter for padding1
StopFreezePdu	setPadding1(short pPadding1)	Setter for padding1
StopFreezePdu	setRealWorldTime(ClockTime pRealWorldTime)	Setter for realWorldTime
StopFreezePdu	setReason(StopFreezeReason pReason)	Setter for reason
StopFreezePdu	setRequestID(int pRequestID)	Setter for requestID
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.SimulationManagementFamilyPdu

getOriginatingID, getReceivingID, setOriginatingID, setReceivingID

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

realWorldTime

protected ClockTime realWorldTime

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

reason

protected StopFreezeReason reason

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

frozenBehavior

protected StopFreezeFrozenBehavior frozenBehavior

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

padding1

protected short padding1

padding

requestID

protected int requestID

Request ID that is unique

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

StopFreezePdu

public StopFreezePdu()

Constructor creates and configures a new instance object

Method Details

copy

public StopFreezePdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public StopFreezePdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public StopFreezePdu 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 SimulationManagementFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setRealWorldTime

public StopFreezePdu setRealWorldTime(ClockTime pRealWorldTime)

Setter for realWorldTime

Parameters:

pRealWorldTime - new value of interest

Returns:

same object to permit progressive setters

getRealWorldTime

public ClockTime getRealWorldTime()

Getter for realWorldTime

Returns:

value of interest

setReason

public StopFreezePdu setReason(StopFreezeReason pReason)

Setter for reason

Parameters:

pReason - new value of interest

Returns:

same object to permit progressive setters

getReason

public StopFreezeReason getReason()

Getter for reason

Returns:

value of interest

setFrozenBehavior

public StopFreezePdu setFrozenBehavior(StopFreezeFrozenBehavior pFrozenBehavior)

Setter for frozenBehavior

Parameters:

pFrozenBehavior - new value of interest

Returns:

same object to permit progressive setters

getFrozenBehavior

public StopFreezeFrozenBehavior getFrozenBehavior()

Getter for frozenBehavior

Returns:

value of interest

setPadding1

public StopFreezePdu setPadding1(short pPadding1)

Setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

setPadding1

public StopFreezePdu setPadding1(int pPadding1)

Utility setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

getPadding1

public short getPadding1()

Getter for padding1

Returns:

value of interest

setRequestID

public StopFreezePdu setRequestID(int pRequestID)

Setter for requestID

Parameters:

pRequestID - new value of interest

Returns:

same object to permit progressive setters

getRequestID

public int getRequestID()

Getter for requestID

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 SimulationManagementFamilyPdu

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 SimulationManagementFamilyPdu

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 SimulationManagementFamilyPdu

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 SimulationManagementFamilyPdu

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 SimulationManagementFamilyPdu

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 SimulationManagementFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class SimulationManagementFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class SimulationManagementFamilyPdu