edu.nps.moves.dismobile
Class EnvironmentalProcessPdu

java.lang.Object
  edu.nps.moves.dismobile.Pdu
      edu.nps.moves.dismobile.SyntheticEnvironmentFamilyPdu
          edu.nps.moves.dismobile.EnvironmentalProcessPdu

All Implemented Interfaces:

java.io.Serializable

public class EnvironmentalProcessPdu
extends SyntheticEnvironmentFamilyPdu
implements java.io.Serializable

Section 5.3.11.1: Information about environmental effects and processes. This requires manual cleanup. the environmental record is variable, as is the padding. UNFINISHED Copyright (c) 2008-2010, MOVES Institute, Naval Postgraduate School. All rights reserved. This work is licensed under the BSD open source license, available at https://www.movesinstitute.org/licenses/bsd.html

Author:

DMcG

See Also:

Serialized Form

Field Summary

protected EntityID	environementalProcessID Environmental process ID
protected java.util.List<Environment>	environmentRecords environemt records
protected short	environmentStatus Environment status
protected EntityType	environmentType Environment type
protected short	modelType model type
protected short	numberOfEnvironmentRecords number of environment records
protected int	sequenceNumber PDU sequence number for the environmentla process if pdu sequencing required

Fields inherited from class edu.nps.moves.dismobile.Pdu

exerciseID, padding, pduLength, pduType, protocolFamily, protocolVersion, timestamp

Constructor Summary

EnvironmentalProcessPdu()
Constructor

Method Summary

boolean	equals(java.lang.Object obj)
boolean	equalsImpl(java.lang.Object obj) Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object
EntityID	getEnvironementalProcessID()
java.util.List<Environment>	getEnvironmentRecords()
short	getEnvironmentStatus()
EntityType	getEnvironmentType()
int	getMarshalledSize()
short	getModelType()
short	getNumberOfEnvironmentRecords()
int	getSequenceNumber()
void	marshal(java.nio.ByteBuffer buff) Packs a Pdu into the ByteBuffer.
void	marshal(java.io.DataOutputStream dos)
void	setEnvironementalProcessID(EntityID pEnvironementalProcessID)
void	setEnvironmentRecords(java.util.List<Environment> pEnvironmentRecords)
void	setEnvironmentStatus(short pEnvironmentStatus)
void	setEnvironmentType(EntityType pEnvironmentType)
void	setModelType(short pModelType)
void	setNumberOfEnvironmentRecords(short pNumberOfEnvironmentRecords) Note that setting this value will not change the marshalled value.
void	setSequenceNumber(int pSequenceNumber)
void	unmarshal(java.nio.ByteBuffer buff) Unpacks a Pdu from the underlying data.
void	unmarshal(java.io.DataInputStream dis)

Methods inherited from class edu.nps.moves.dismobile.Pdu

getExerciseID, getLength, getPadding, getPduLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, marshal, marshalWithDisAbsoluteTimestamp, marshalWithDisAbsoluteTimestamp, marshalWithDisRelativeTimestamp, marshalWithDisRelativeTimestamp, marshalWithNpsTimestamp, marshalWithNpsTimestamp, marshalWithUnixTimestamp, marshalWithUnixTimestamp, readUnsignedInt, readUnsignedInt, setExerciseID, setPadding, setPduLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

environementalProcessID

protected EntityID environementalProcessID

Environmental process ID

environmentType

protected EntityType environmentType

Environment type

modelType

protected short modelType

model type

environmentStatus

protected short environmentStatus

Environment status

numberOfEnvironmentRecords

protected short numberOfEnvironmentRecords

number of environment records

sequenceNumber

protected int sequenceNumber

PDU sequence number for the environmentla process if pdu sequencing required

environmentRecords

protected java.util.List<Environment> environmentRecords

environemt records

Constructor Detail

EnvironmentalProcessPdu

public EnvironmentalProcessPdu()

Constructor

Method Detail

getMarshalledSize

public int getMarshalledSize()

Overrides:

getMarshalledSize in class SyntheticEnvironmentFamilyPdu

setEnvironementalProcessID

public void setEnvironementalProcessID(EntityID pEnvironementalProcessID)

getEnvironementalProcessID

public EntityID getEnvironementalProcessID()

setEnvironmentType

public void setEnvironmentType(EntityType pEnvironmentType)

getEnvironmentType

public EntityType getEnvironmentType()

setModelType

public void setModelType(short pModelType)

getModelType

public short getModelType()

setEnvironmentStatus

public void setEnvironmentStatus(short pEnvironmentStatus)

getEnvironmentStatus

public short getEnvironmentStatus()

getNumberOfEnvironmentRecords

public short getNumberOfEnvironmentRecords()

setNumberOfEnvironmentRecords

public void setNumberOfEnvironmentRecords(short pNumberOfEnvironmentRecords)

Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose. The getnumberOfEnvironmentRecords method will also be based on the actual list length rather than this value. The method is simply here for java bean completeness.

setSequenceNumber

public void setSequenceNumber(int pSequenceNumber)

getSequenceNumber

public int getSequenceNumber()

setEnvironmentRecords

public void setEnvironmentRecords(java.util.List<Environment> pEnvironmentRecords)

getEnvironmentRecords

public java.util.List<Environment> getEnvironmentRecords()

marshal

public void marshal(java.io.DataOutputStream dos)

Overrides:

marshal in class SyntheticEnvironmentFamilyPdu

unmarshal

public void unmarshal(java.io.DataInputStream dis)

Overrides:

unmarshal in class SyntheticEnvironmentFamilyPdu

marshal

public void marshal(java.nio.ByteBuffer buff)

Packs a Pdu into the ByteBuffer.

Overrides:

marshal in class SyntheticEnvironmentFamilyPdu

Parameters:

buff - The ByteBuffer at the position to begin writing

Throws:

java.nio.BufferOverflowException - if buff is too small

java.nio.ReadOnlyBufferException - if buff is read only

Since:

??

See Also:

ByteBuffer

unmarshal

public void unmarshal(java.nio.ByteBuffer buff)

Unpacks a Pdu from the underlying data.

Overrides:

unmarshal in class SyntheticEnvironmentFamilyPdu

Parameters:

buff - The ByteBuffer at the position to begin reading

Throws:

java.nio.BufferUnderflowException - if buff is too small

Since:

??

See Also:

ByteBuffer

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SyntheticEnvironmentFamilyPdu

equalsImpl

public boolean equalsImpl(java.lang.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.