Class StopFreezeRPdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.SimulationManagementWithReliabilityFamilyPdu

edu.nps.moves.dis7.pdus.StopFreezeRPdu

All Implemented Interfaces:

Marshaller, Serializable

Direct Known Subclasses:

StopFreezeReliablePdu

public class StopFreezeRPdu
extends SimulationManagementWithReliabilityFamilyPdu
implements Serializable

5.12.4.5 Serves the same function as the Stop/Freeze PDU (see 5.6.5.5.1) but with the addition of reliability service levels.

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 behvior of the simulation while frozen uid 68
static final String	NAME	The name of this PDU type
protected byte	pad1	padding
protected ClockTime	realWorldTime	time in real world for this operation to happen
protected StopFreezeReason	reason	Reason for stopping/freezing simulation uid 67
protected int	requestID	Request ID provides a unique identifier
protected RequiredReliabilityService	requiredReliabilityService	reliability level uid 74

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

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

Method Summary

Modifier and Type	Method	Description
StopFreezeRPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
StopFreezeRPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
StopFreezeRPdu	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
byte	getPad1()	Getter for pad1
ClockTime	getRealWorldTime()	Getter for realWorldTime
StopFreezeReason	getReason()	Getter for reason
int	getRequestID()	Getter for requestID
RequiredReliabilityService	getRequiredReliabilityService()	Getter for requiredReliabilityService
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
StopFreezeRPdu	setFrozenBehavior(StopFreezeFrozenBehavior pFrozenBehavior)	Setter for frozenBehavior
StopFreezeRPdu	setPad1(byte pPad1)	Setter for pad1
StopFreezeRPdu	setPad1(int pPad1)	Utility setter for pad1
StopFreezeRPdu	setRealWorldTime(ClockTime pRealWorldTime)	Setter for realWorldTime
StopFreezeRPdu	setReason(StopFreezeReason pReason)	Setter for reason
StopFreezeRPdu	setRequestID(int pRequestID)	Setter for requestID
StopFreezeRPdu	setRequiredReliabilityService(RequiredReliabilityService pRequiredReliabilityService)	Setter for requiredReliabilityService
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.SimulationManagementWithReliabilityFamilyPdu

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

time in real world for this operation to happen

reason

protected StopFreezeReason reason

Reason for stopping/freezing simulation uid 67

frozenBehavior

protected StopFreezeFrozenBehavior frozenBehavior

internal behvior of the simulation while frozen uid 68

requiredReliabilityService

protected RequiredReliabilityService requiredReliabilityService

reliability level uid 74

pad1

protected byte pad1

padding

requestID

protected int requestID

Request ID provides a unique identifier

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

StopFreezeRPdu

public StopFreezeRPdu()

Constructor creates and configures a new instance object

Method Details

copy

public StopFreezeRPdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public StopFreezeRPdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public StopFreezeRPdu 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 SimulationManagementWithReliabilityFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setRealWorldTime

public StopFreezeRPdu 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 StopFreezeRPdu 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 StopFreezeRPdu 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

setRequiredReliabilityService

public StopFreezeRPdu setRequiredReliabilityService(RequiredReliabilityService pRequiredReliabilityService)

Setter for requiredReliabilityService

Parameters:

pRequiredReliabilityService - new value of interest

Returns:

same object to permit progressive setters

getRequiredReliabilityService

public RequiredReliabilityService getRequiredReliabilityService()

Getter for requiredReliabilityService

Returns:

value of interest

setPad1

public StopFreezeRPdu setPad1(byte pPad1)

Setter for pad1

Parameters:

pPad1 - new value of interest

Returns:

same object to permit progressive setters

setPad1

public StopFreezeRPdu setPad1(int pPad1)

Utility setter for pad1

Parameters:

pPad1 - new value of interest

Returns:

same object to permit progressive setters

getPad1

public byte getPad1()

Getter for pad1

Returns:

value of interest

setRequestID

public StopFreezeRPdu 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 SimulationManagementWithReliabilityFamilyPdu

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 SimulationManagementWithReliabilityFamilyPdu

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 SimulationManagementWithReliabilityFamilyPdu

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 SimulationManagementWithReliabilityFamilyPdu

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 SimulationManagementWithReliabilityFamilyPdu

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 SimulationManagementWithReliabilityFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class SimulationManagementWithReliabilityFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class SimulationManagementWithReliabilityFamilyPdu