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

public class EnvironmentalProcessPdu
extends SyntheticEnvironmentFamilyPdu
implements Serializable

7.10.2 Used to communicate information about environmental effects and processes.

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 ObjectIdentifier	environementalProcessID	Environmental process ID provides a unique identifier
protected List<Environment>	environmentRecords	environmemt records
protected EnvironmentalProcessEnvironmentStatus	environmentStatus	Environment status uid 249
protected EntityType	environmentType	Environment type
protected EnvironmentalProcessModelType	modelType	model type uid 248
static final String	NAME	The name of this PDU type
protected short	numberOfEnvironmentRecords	number of environment records
protected short	sequenceNumber	PDU sequence number for the environmental process if pdu sequencing required

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

FAMILY_NAME

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

Method Summary

Modifier and Type	Method	Description
EnvironmentalProcessPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
EnvironmentalProcessPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
EnvironmentalProcessPdu	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
ObjectIdentifier	getEnvironementalProcessID()	Getter for environementalProcessID
List<Environment>	getEnvironmentRecords()	Getter for environmentRecords
EnvironmentalProcessEnvironmentStatus	getEnvironmentStatus()	Getter for environmentStatus
EntityType	getEnvironmentType()	Getter for environmentType
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
EnvironmentalProcessModelType	getModelType()	Getter for modelType
short	getSequenceNumber()	Getter for sequenceNumber
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
EnvironmentalProcessPdu	setEnvironementalProcessID(ObjectIdentifier pEnvironementalProcessID)	Setter for environementalProcessID
EnvironmentalProcessPdu	setEnvironmentRecords(List<Environment> pEnvironmentRecords)	Setter for environmentRecords
EnvironmentalProcessPdu	setEnvironmentStatus(EnvironmentalProcessEnvironmentStatus pEnvironmentStatus)	Setter for environmentStatus
EnvironmentalProcessPdu	setEnvironmentType(EntityType pEnvironmentType)	Setter for environmentType
EnvironmentalProcessPdu	setModelType(EnvironmentalProcessModelType pModelType)	Setter for modelType
EnvironmentalProcessPdu	setSequenceNumber(int pSequenceNumber)	Utility setter for sequenceNumber
EnvironmentalProcessPdu	setSequenceNumber(short pSequenceNumber)	Setter for sequenceNumber
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

NAME

public static final String NAME

The name of this PDU type

See Also:

• Constant Field Values

environementalProcessID

protected ObjectIdentifier environementalProcessID

Environmental process ID provides a unique identifier

environmentType

protected EntityType environmentType

Environment type

modelType

protected EnvironmentalProcessModelType modelType

model type uid 248

environmentStatus

protected EnvironmentalProcessEnvironmentStatus environmentStatus

Environment status uid 249

numberOfEnvironmentRecords

protected short numberOfEnvironmentRecords

number of environment records

sequenceNumber

protected short sequenceNumber

PDU sequence number for the environmental process if pdu sequencing required

environmentRecords

protected List<Environment> environmentRecords

environmemt records

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

EnvironmentalProcessPdu

public EnvironmentalProcessPdu()

Constructor creates and configures a new instance object

Method Details

copy

public EnvironmentalProcessPdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public EnvironmentalProcessPdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public EnvironmentalProcessPdu 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 SyntheticEnvironmentFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setEnvironementalProcessID

public EnvironmentalProcessPdu setEnvironementalProcessID(ObjectIdentifier pEnvironementalProcessID)

Setter for environementalProcessID

Parameters:

pEnvironementalProcessID - new value of interest

Returns:

same object to permit progressive setters

getEnvironementalProcessID

public ObjectIdentifier getEnvironementalProcessID()

Getter for environementalProcessID

Returns:

value of interest

setEnvironmentType

public EnvironmentalProcessPdu setEnvironmentType(EntityType pEnvironmentType)

Setter for environmentType

Parameters:

pEnvironmentType - new value of interest

Returns:

same object to permit progressive setters

getEnvironmentType

public EntityType getEnvironmentType()

Getter for environmentType

Returns:

value of interest

setModelType

public EnvironmentalProcessPdu setModelType(EnvironmentalProcessModelType pModelType)

Setter for modelType

Parameters:

pModelType - new value of interest

Returns:

same object to permit progressive setters

getModelType

public EnvironmentalProcessModelType getModelType()

Getter for modelType

Returns:

value of interest

setEnvironmentStatus

public EnvironmentalProcessPdu setEnvironmentStatus(EnvironmentalProcessEnvironmentStatus pEnvironmentStatus)

Setter for environmentStatus

Parameters:

pEnvironmentStatus - new value of interest

Returns:

same object to permit progressive setters

getEnvironmentStatus

public EnvironmentalProcessEnvironmentStatus getEnvironmentStatus()

Getter for environmentStatus

Returns:

value of interest

setSequenceNumber

public EnvironmentalProcessPdu setSequenceNumber(short pSequenceNumber)

Setter for sequenceNumber

Parameters:

pSequenceNumber - new value of interest

Returns:

same object to permit progressive setters

setSequenceNumber

public EnvironmentalProcessPdu setSequenceNumber(int pSequenceNumber)

Utility setter for sequenceNumber

Parameters:

pSequenceNumber - new value of interest

Returns:

same object to permit progressive setters

getSequenceNumber

public short getSequenceNumber()

Getter for sequenceNumber

Returns:

value of interest

setEnvironmentRecords

public EnvironmentalProcessPdu setEnvironmentRecords(List<Environment> pEnvironmentRecords)

Setter for environmentRecords

Parameters:

pEnvironmentRecords - new value of interest

Returns:

same object to permit progressive setters

getEnvironmentRecords

public List<Environment> getEnvironmentRecords()

Getter for environmentRecords

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 SyntheticEnvironmentFamilyPdu

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 SyntheticEnvironmentFamilyPdu

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 SyntheticEnvironmentFamilyPdu

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 SyntheticEnvironmentFamilyPdu

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 SyntheticEnvironmentFamilyPdu

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 SyntheticEnvironmentFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class SyntheticEnvironmentFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase