Package edu.nps.moves.dis7
Class CommentPdu
java.lang.Object
edu.nps.moves.dis7.Pdu
edu.nps.moves.dis7.PduBase
edu.nps.moves.dis7.SimulationManagementFamilyPdu
edu.nps.moves.dis7.CommentPdu
- All Implemented Interfaces:
edu.nps.moves.dis7.Marshaller,java.io.Serializable
public class CommentPdu extends SimulationManagementFamilyPdu implements java.io.Serializable
7.5.13 Used to enter arbitrary messages (character strings, for example). See 5.6.5.13
IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation—Application Protocols
- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description protected intnumberOfFixedDatumRecordsNumber of fixed datum records, not used in this Pduprotected intnumberOfVariableDatumRecordsNumber of variable datum records, handled automatically by marshaller at run time (and not modifiable by end-user programmers)protected java.util.List<edu.nps.moves.dis7.VariableDatum>variableDatumsvariable length list of variable length datumsFields inherited from class edu.nps.moves.dis7.SimulationManagementFamilyPdu
originatingID, receivingIDFields inherited from class edu.nps.moves.dis7.Pdu
exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp -
Constructor Summary
Constructors Constructor Description CommentPdu()Constructor -
Method Summary
Modifier and Type Method Description booleanequals(java.lang.Object obj)booleanequalsImpl(java.lang.Object obj)Compare all fields that contribute to the state, ignoring transient and static fields, forthisand the supplied objectintgetMarshalledSize()Returns the size of this serialized object in bytesjava.util.List<edu.nps.moves.dis7.VariableDatum>getVariableDatums()Getter forvariableDatumsvoidmarshal(java.io.DataOutputStream dos)Serializes an object to a DataOutputStream.voidmarshal(java.nio.ByteBuffer buff)Packs an object into the ByteBuffer.CommentPdusetVariableDatums(java.util.List<edu.nps.moves.dis7.VariableDatum> pVariableDatums)Setter forvariableDatumsjava.lang.StringtoString()intunmarshal(java.io.DataInputStream dis)Unserializes an object from a DataInputStream.intunmarshal(java.nio.ByteBuffer buff)Unpacks a Pdu from the underlying data.Methods inherited from class edu.nps.moves.dis7.SimulationManagementFamilyPdu
getOriginatingID, getReceivingID, setOriginatingID, setReceivingIDMethods inherited from class edu.nps.moves.dis7.PduBase
getPadding, getPduStatus, setPadding, setPduStatusMethods inherited from class edu.nps.moves.dis7.Pdu
getExerciseID, getLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, marshal, setExerciseID, setLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp
-
Field Details
-
numberOfFixedDatumRecords
protected int numberOfFixedDatumRecordsNumber of fixed datum records, not used in this Pdu -
numberOfVariableDatumRecords
protected int numberOfVariableDatumRecordsNumber of variable datum records, handled automatically by marshaller at run time (and not modifiable by end-user programmers) -
variableDatums
protected java.util.List<edu.nps.moves.dis7.VariableDatum> variableDatumsvariable length list of variable length datums
-
-
Constructor Details
-
CommentPdu
public CommentPdu()Constructor
-
-
Method Details
-
getMarshalledSize
public int getMarshalledSize()Returns the size of this serialized object in bytes- Specified by:
getMarshalledSizein interfaceedu.nps.moves.dis7.Marshaller- Overrides:
getMarshalledSizein classSimulationManagementFamilyPdu
-
setVariableDatums
public CommentPdu setVariableDatums(java.util.List<edu.nps.moves.dis7.VariableDatum> pVariableDatums)Setter forvariableDatums -
getVariableDatums
public java.util.List<edu.nps.moves.dis7.VariableDatum> getVariableDatums()Getter forvariableDatums -
marshal
public void marshal(java.io.DataOutputStream dos) throws java.lang.ExceptionSerializes an object to a DataOutputStream.- Specified by:
marshalin interfaceedu.nps.moves.dis7.Marshaller- Overrides:
marshalin classSimulationManagementFamilyPdu- Parameters:
dos- the OutputStream- Throws:
java.lang.Exception- if something goes wrong- See Also:
DataOutputStream
-
unmarshal
public int unmarshal(java.io.DataInputStream dis) throws java.lang.ExceptionUnserializes an object from a DataInputStream.- Specified by:
unmarshalin interfaceedu.nps.moves.dis7.Marshaller- Overrides:
unmarshalin classSimulationManagementFamilyPdu- Parameters:
dis- the InputStream- Returns:
- unmarshalled size
- Throws:
java.lang.Exception- if something goes wrong- See Also:
DataInputStream
-
marshal
public void marshal(java.nio.ByteBuffer buff) throws java.lang.ExceptionPacks an object into the ByteBuffer.- Specified by:
marshalin interfaceedu.nps.moves.dis7.Marshaller- Overrides:
marshalin classSimulationManagementFamilyPdu- Parameters:
buff- The ByteBuffer at the position to begin writing- Throws:
java.nio.BufferOverflowException- if buff is too smalljava.nio.ReadOnlyBufferException- if buff is read onlyjava.lang.Exception- ByteBuffer-generated exception- See Also:
ByteBuffer
-
unmarshal
public int unmarshal(java.nio.ByteBuffer buff) throws java.lang.ExceptionUnpacks a Pdu from the underlying data.- Specified by:
unmarshalin interfaceedu.nps.moves.dis7.Marshaller- Overrides:
unmarshalin classSimulationManagementFamilyPdu- Parameters:
buff- The ByteBuffer at the position to begin reading- Returns:
- marshalled size
- Throws:
java.nio.BufferUnderflowException- if buff is too smalljava.lang.Exception- ByteBuffer-generated exception- See Also:
ByteBuffer
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equalsin classSimulationManagementFamilyPdu
-
equalsImpl
public boolean equalsImpl(java.lang.Object obj)Description copied from class:PduCompare all fields that contribute to the state, ignoring transient and static fields, forthisand the supplied object- Overrides:
equalsImplin classSimulationManagementFamilyPdu- Parameters:
obj- the object to compare to- Returns:
- true if the objects are equal, false otherwise.
-
toString
public java.lang.String toString()- Overrides:
toStringin classSimulationManagementFamilyPdu
-