Package edu.nps.moves.dis7.pdus
Class EnvironmentalProcessPdu
java.lang.Object
edu.nps.moves.dis7.pdus.Pdu
edu.nps.moves.dis7.pdus.PduBase
edu.nps.moves.dis7.pdus.SyntheticEnvironmentFamilyPdu
edu.nps.moves.dis7.pdus.EnvironmentalProcessPdu
- All Implemented Interfaces:
Marshaller,Serializable
7.10.2 Used to communicate information about environmental effects and processes.
IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation - Application Protocols
- See Also:
- Serialized Form
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ObjectIdentifierEnvironmental process IDprotected List<Environment>environmemt recordsprotected EnvironmentalProcessEnvironmentStatusEnvironment status uid 249protected EntityTypeEnvironment typeprotected EnvironmentalProcessModelTypemodel type uid 248protected shortnumber of environment recordsprotected shortPDU sequence number for the environmental process if pdu sequencing requiredFields inherited from class edu.nps.moves.dis7.pdus.Pdu
exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleanequalsImpl(Object obj)Compare all fields that contribute to the state, ignoring transient and static fields, forthisand the supplied objectGetter forenvironementalProcessIDGetter forenvironmentRecordsGetter forenvironmentStatusGetter forenvironmentTypeintReturns size of this serialized (marshalled) object in bytesGetter formodelTypeshortGetter forsequenceNumbervoidmarshal(DataOutputStream dos)Serializes an object to a DataOutputStream.voidmarshal(ByteBuffer byteBuffer)Packs an object into the ByteBuffer.setEnvironementalProcessID(ObjectIdentifier pEnvironementalProcessID)Setter forenvironementalProcessIDsetEnvironmentRecords(List<Environment> pEnvironmentRecords)Setter forenvironmentRecordssetEnvironmentStatus(EnvironmentalProcessEnvironmentStatus pEnvironmentStatus)Setter forenvironmentStatussetEnvironmentType(EntityType pEnvironmentType)Setter forenvironmentTypesetModelType(EnvironmentalProcessModelType pModelType)Setter formodelTypesetSequenceNumber(int pSequenceNumber)Utility setter forsequenceNumbersetSequenceNumber(short pSequenceNumber)Setter forsequenceNumbertoString()intunmarshal(DataInputStream dis)Deserializes an object from a DataInputStream.intunmarshal(ByteBuffer byteBuffer)Unpacks a Pdu from the underlying data.Methods inherited from class edu.nps.moves.dis7.pdus.PduBase
getPadding, getPduStatus, setPadding, setPadding, setPduStatusMethods inherited from class edu.nps.moves.dis7.pdus.Pdu
getExerciseID, getLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, marshal, setExerciseID, setExerciseID, setLength, setLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp
-
Field Details
-
environementalProcessID
Environmental process ID -
environmentType
Environment type -
modelType
model type uid 248 -
environmentStatus
Environment status uid 249 -
numberOfEnvironmentRecords
protected short numberOfEnvironmentRecordsnumber of environment records -
sequenceNumber
protected short sequenceNumberPDU sequence number for the environmental process if pdu sequencing required -
environmentRecords
environmemt records
-
-
Constructor Details
-
EnvironmentalProcessPdu
public EnvironmentalProcessPdu()Constructor
-
-
Method Details
-
getMarshalledSize
public int getMarshalledSize()Returns size of this serialized (marshalled) object in bytes- Specified by:
getMarshalledSizein interfaceMarshaller- Overrides:
getMarshalledSizein classSyntheticEnvironmentFamilyPdu- Returns:
- serialized size in bytes
- See Also:
- https://en.wikipedia.org/wiki/Marshalling_(computer_science)
-
setEnvironementalProcessID
public EnvironmentalProcessPdu setEnvironementalProcessID(ObjectIdentifier pEnvironementalProcessID)Setter forenvironementalProcessID- Parameters:
pEnvironementalProcessID- new value of interest- Returns:
- same object to permit progressive setters
-
getEnvironementalProcessID
Getter forenvironementalProcessID- Returns:
- value of interest
-
setEnvironmentType
Setter forenvironmentType- Parameters:
pEnvironmentType- new value of interest- Returns:
- same object to permit progressive setters
-
getEnvironmentType
Getter forenvironmentType- Returns:
- value of interest
-
setModelType
Setter formodelType- Parameters:
pModelType- new value of interest- Returns:
- same object to permit progressive setters
-
getModelType
Getter formodelType- Returns:
- value of interest
-
setEnvironmentStatus
public EnvironmentalProcessPdu setEnvironmentStatus(EnvironmentalProcessEnvironmentStatus pEnvironmentStatus)Setter forenvironmentStatus- Parameters:
pEnvironmentStatus- new value of interest- Returns:
- same object to permit progressive setters
-
getEnvironmentStatus
Getter forenvironmentStatus- Returns:
- value of interest
-
setSequenceNumber
Setter forsequenceNumber- Parameters:
pSequenceNumber- new value of interest- Returns:
- same object to permit progressive setters
-
setSequenceNumber
Utility setter forsequenceNumber- Parameters:
pSequenceNumber- new value of interest- Returns:
- same object to permit progressive setters
-
getSequenceNumber
public short getSequenceNumber()Getter forsequenceNumber- Returns:
- value of interest
-
setEnvironmentRecords
Setter forenvironmentRecords- Parameters:
pEnvironmentRecords- new value of interest- Returns:
- same object to permit progressive setters
-
getEnvironmentRecords
Getter forenvironmentRecords- Returns:
- value of interest
-
marshal
Serializes an object to a DataOutputStream.- Specified by:
marshalin interfaceMarshaller- Overrides:
marshalin classSyntheticEnvironmentFamilyPdu- Parameters:
dos- the OutputStream- Throws:
Exception- if something goes wrong- See Also:
DataOutputStream
-
unmarshal
Deserializes an object from a DataInputStream.- Specified by:
unmarshalin interfaceMarshaller- Overrides:
unmarshalin classSyntheticEnvironmentFamilyPdu- 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
Packs an object into the ByteBuffer.- Specified by:
marshalin interfaceMarshaller- Overrides:
marshalin classSyntheticEnvironmentFamilyPdu- Parameters:
byteBuffer- The ByteBuffer at the position to begin writing- Throws:
BufferOverflowException- if byteBuffer is too smallReadOnlyBufferException- if byteBuffer is read onlyException- ByteBuffer-generated exception- See Also:
ByteBuffer
-
unmarshal
Unpacks a Pdu from the underlying data.- Specified by:
unmarshalin interfaceMarshaller- Overrides:
unmarshalin classSyntheticEnvironmentFamilyPdu- Parameters:
byteBuffer- The ByteBuffer at the position to begin reading- Returns:
- marshalled serialized size in bytes
- Throws:
BufferUnderflowException- if byteBuffer is too smallException- ByteBuffer-generated exception- See Also:
ByteBuffer, https://en.wikipedia.org/wiki/Marshalling_(computer_science)
-
equals
- Overrides:
equalsin classSyntheticEnvironmentFamilyPdu
-
equalsImpl
Description copied from class:PduCompare all fields that contribute to the state, ignoring transient and static fields, forthisand the supplied object- Overrides:
equalsImplin classSyntheticEnvironmentFamilyPdu- Parameters:
obj- the object to compare to- Returns:
- true if the objects are equal, false otherwise.
-
toString
- Overrides:
toStringin classSyntheticEnvironmentFamilyPdu
-