edu.nps.moves.dismobile
Class GriddedDataPdu

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

All Implemented Interfaces:

java.io.Serializable

public class GriddedDataPdu
extends SyntheticEnvironmentFamilyPdu
implements java.io.Serializable

Section 5.3.11.2: Information about globat, spatially varying enviornmental effects. This requires manual cleanup; the grid axis records are variable sized. 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 short	constantGrid are domain grid axes identidal to those of the priveious domain update?
protected int	coordinateSystem coordinate system of the grid
protected EntityID	environmentalSimulationApplicationID environmental simulation application ID
protected EntityType	environmentType type of environment
protected int	fieldNumber unique identifier for each piece of enviornmental data
protected java.util.List<GridAxisRecord>	gridDataList Grid data ^^^This is wrong
protected short	numberOfGridAxes number of grid axes for the environmental data
protected Orientation	orientation orientation of the data grid
protected int	padding1 padding
protected short	padding2 padding
protected int	pduNumber sequence number for the total set of PDUS used to transmit the data
protected int	pduTotal Total number of PDUS used to transmit the data
protected long	sampleTime valid time of the enviormental data sample, 64 bit unsigned int
protected long	totalValues total number of all data values for all pdus for an environmental sample
protected short	vectorDimension total number of data values at each grid point.

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

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

Constructor Summary

GriddedDataPdu()
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
short	getConstantGrid()
int	getCoordinateSystem()
EntityID	getEnvironmentalSimulationApplicationID()
EntityType	getEnvironmentType()
int	getFieldNumber()
java.util.List<GridAxisRecord>	getGridDataList()
int	getMarshalledSize()
short	getNumberOfGridAxes()
Orientation	getOrientation()
int	getPadding1()
short	getPadding2()
int	getPduNumber()
int	getPduTotal()
long	getSampleTime()
long	getTotalValues()
short	getVectorDimension()
void	marshal(java.nio.ByteBuffer buff) Packs a Pdu into the ByteBuffer.
void	marshal(java.io.DataOutputStream dos)
void	setConstantGrid(short pConstantGrid)
void	setCoordinateSystem(int pCoordinateSystem)
void	setEnvironmentalSimulationApplicationID(EntityID pEnvironmentalSimulationApplicationID)
void	setEnvironmentType(EntityType pEnvironmentType)
void	setFieldNumber(int pFieldNumber)
void	setGridDataList(java.util.List<GridAxisRecord> pGridDataList)
void	setNumberOfGridAxes(short pNumberOfGridAxes) Note that setting this value will not change the marshalled value.
void	setOrientation(Orientation pOrientation)
void	setPadding1(int pPadding1)
void	setPadding2(short pPadding2)
void	setPduNumber(int pPduNumber)
void	setPduTotal(int pPduTotal)
void	setSampleTime(long pSampleTime)
void	setTotalValues(long pTotalValues)
void	setVectorDimension(short pVectorDimension)
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

environmentalSimulationApplicationID

protected EntityID environmentalSimulationApplicationID

environmental simulation application ID

fieldNumber

protected int fieldNumber

unique identifier for each piece of enviornmental data

pduNumber

protected int pduNumber

sequence number for the total set of PDUS used to transmit the data

pduTotal

protected int pduTotal

Total number of PDUS used to transmit the data

coordinateSystem

protected int coordinateSystem

coordinate system of the grid

numberOfGridAxes

protected short numberOfGridAxes

number of grid axes for the environmental data

constantGrid

protected short constantGrid

are domain grid axes identidal to those of the priveious domain update?

environmentType

protected EntityType environmentType

type of environment

orientation

protected Orientation orientation

orientation of the data grid

sampleTime

protected long sampleTime

valid time of the enviormental data sample, 64 bit unsigned int

totalValues

protected long totalValues

total number of all data values for all pdus for an environmental sample

vectorDimension

protected short vectorDimension

total number of data values at each grid point.

padding1

protected int padding1

padding

padding2

protected short padding2

padding

gridDataList

protected java.util.List<GridAxisRecord> gridDataList

Grid data ^^^This is wrong

Constructor Detail

GriddedDataPdu

public GriddedDataPdu()

Constructor

Method Detail

getMarshalledSize

public int getMarshalledSize()

Overrides:

getMarshalledSize in class SyntheticEnvironmentFamilyPdu

setEnvironmentalSimulationApplicationID

public void setEnvironmentalSimulationApplicationID(EntityID pEnvironmentalSimulationApplicationID)

getEnvironmentalSimulationApplicationID

public EntityID getEnvironmentalSimulationApplicationID()

setFieldNumber

public void setFieldNumber(int pFieldNumber)

getFieldNumber

public int getFieldNumber()

setPduNumber

public void setPduNumber(int pPduNumber)

getPduNumber

public int getPduNumber()

setPduTotal

public void setPduTotal(int pPduTotal)

getPduTotal

public int getPduTotal()

setCoordinateSystem

public void setCoordinateSystem(int pCoordinateSystem)

getCoordinateSystem

public int getCoordinateSystem()

getNumberOfGridAxes

public short getNumberOfGridAxes()

setNumberOfGridAxes

public void setNumberOfGridAxes(short pNumberOfGridAxes)

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

setConstantGrid

public void setConstantGrid(short pConstantGrid)

getConstantGrid

public short getConstantGrid()

setEnvironmentType

public void setEnvironmentType(EntityType pEnvironmentType)

getEnvironmentType

public EntityType getEnvironmentType()

setOrientation

public void setOrientation(Orientation pOrientation)

getOrientation

public Orientation getOrientation()

setSampleTime

public void setSampleTime(long pSampleTime)

getSampleTime

public long getSampleTime()

setTotalValues

public void setTotalValues(long pTotalValues)

getTotalValues

public long getTotalValues()

setVectorDimension

public void setVectorDimension(short pVectorDimension)

getVectorDimension

public short getVectorDimension()

setPadding1

public void setPadding1(int pPadding1)

getPadding1

public int getPadding1()

setPadding2

public void setPadding2(short pPadding2)

getPadding2

public short getPadding2()

setGridDataList

public void setGridDataList(java.util.List<GridAxisRecord> pGridDataList)

getGridDataList

public java.util.List<GridAxisRecord> getGridDataList()

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.