Class SimulationManagementFamilyPdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.SimulationManagementFamilyPdu

All Implemented Interfaces:

Marshaller, Serializable

Direct Known Subclasses:

AcknowledgePdu, ActionRequestPdu, ActionResponsePdu, CommentPdu, CreateEntityPdu, DataPdu, DataQueryPdu, EventReportPdu, RemoveEntityPdu, SetDataPdu, StartResumePdu, StopFreezePdu

public abstract class SimulationManagementFamilyPdu
extends PduBase
implements Serializable

First part of a simulation management (SIMAN) PDU and SIMAN-Reliability (SIMAN-R) PDU. Sectionn 6.2.81

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
static final String	FAMILY_NAME	The name of this PDU family type
protected SimulationIdentifier	originatingID	IDs the simulation or entity, either a simulation or an entity.
protected SimulationIdentifier	receivingID	simulation, all simulations, a special ID, or an entity.

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

padding, pduStatus

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

exerciseID, length, NAME, pduType, protocolFamily, protocolVersion, timestamp

Constructor Summary

Constructors

Constructor	Description
SimulationManagementFamilyPdu()	Constructor creates and configures a new instance object

Method Summary

Modifier and Type	Method	Description
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
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
SimulationIdentifier	getOriginatingID()	Getter for originatingID
SimulationIdentifier	getReceivingID()	Getter for receivingID
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
SimulationManagementFamilyPdu	setOriginatingID(SimulationIdentifier pOriginatingID)	Setter for originatingID
SimulationManagementFamilyPdu	setReceivingID(SimulationIdentifier pReceivingID)	Setter for receivingID
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.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

FAMILY_NAME

public static final String FAMILY_NAME

The name of this PDU family type

See Also:

• Constant Field Values

originatingID

protected SimulationIdentifier originatingID

IDs the simulation or entity, either a simulation or an entity. Either 6.2.80 or 6.2.28

receivingID

protected SimulationIdentifier receivingID

simulation, all simulations, a special ID, or an entity. See 5.6.5 and 5.12.4

Constructor Details

SimulationManagementFamilyPdu

public SimulationManagementFamilyPdu()

Constructor creates and configures a new instance object

Method Details

getMarshalledSize

public int getMarshalledSize()

Returns size of this serialized (marshalled) object in bytes

Specified by:

getMarshalledSize in interface Marshaller

Overrides:

getMarshalledSize in class PduBase

Returns:

serialized size in bytes

See Also:

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

setOriginatingID

public SimulationManagementFamilyPdu setOriginatingID(SimulationIdentifier pOriginatingID)

Setter for originatingID

Parameters:

pOriginatingID - new value of interest

Returns:

same object to permit progressive setters

getOriginatingID

public SimulationIdentifier getOriginatingID()

Getter for originatingID

Returns:

value of interest

setReceivingID

public SimulationManagementFamilyPdu setReceivingID(SimulationIdentifier pReceivingID)

Setter for receivingID

Parameters:

pReceivingID - new value of interest

Returns:

same object to permit progressive setters

getReceivingID

public SimulationIdentifier getReceivingID()

Getter for receivingID

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 PduBase

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 PduBase

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 PduBase

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 PduBase

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 PduBase

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 PduBase

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class PduBase

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase