Class GridAxisDescriptorVariable

java.lang.Object

edu.nps.moves.dis7.pdus.GridAxisDescriptor

edu.nps.moves.dis7.pdus.GridAxisDescriptorVariable

All Implemented Interfaces:

Serializable

public class GridAxisDescriptorVariable
extends GridAxisDescriptor
implements Serializable

Grid axis descriptor fo variable spacing axis data.

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 double	coordinateOffsetXi	The constant offset value that shall be applied to the grid locations for the xi axis
protected double	coordinateScaleXi	value that linearly scales the coordinates of the grid locations for the xi axis
protected short	initialIndex	initial grid point for the current pdu
protected short	numberOfPointsOnXiAxis	Number of grid locations along Xi axis
protected short[]	xiValues	list of coordinates

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

axisType, domainFinalXi, domainInitialXi, domainPointsXi, interleafFactor

Constructor Summary

Constructors

Constructor	Description
GridAxisDescriptorVariable()	Constructor creates and configures a new instance object

Method Summary

Modifier and Type	Method	Description
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
double	getCoordinateOffsetXi()	Getter for coordinateOffsetXi
double	getCoordinateScaleXi()	Getter for coordinateScaleXi
short	getInitialIndex()	Getter for initialIndex
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
short	getNumberOfPointsOnXiAxis()	Getter for numberOfPointsOnXiAxis
short[]	getXiValues()	Getter for xiValues
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
GridAxisDescriptorVariable	setCoordinateOffsetXi(double pCoordinateOffsetXi)	Setter for coordinateOffsetXi
GridAxisDescriptorVariable	setCoordinateScaleXi(double pCoordinateScaleXi)	Setter for coordinateScaleXi
GridAxisDescriptorVariable	setInitialIndex(int pInitialIndex)	Utility setter for initialIndex
GridAxisDescriptorVariable	setInitialIndex(short pInitialIndex)	Setter for initialIndex
GridAxisDescriptorVariable	setNumberOfPointsOnXiAxis(int pNumberOfPointsOnXiAxis)	Utility setter for numberOfPointsOnXiAxis
GridAxisDescriptorVariable	setNumberOfPointsOnXiAxis(short pNumberOfPointsOnXiAxis)	Setter for numberOfPointsOnXiAxis
GridAxisDescriptorVariable	setXiValues(short[] pXiValues)	Setter for xiValues
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.GridAxisDescriptor

getAxisType, getDomainFinalXi, getDomainInitialXi, getDomainPointsXi, getInterleafFactor, setAxisType, setDomainFinalXi, setDomainInitialXi, setDomainPointsXi, setDomainPointsXi, setInterleafFactor, setInterleafFactor

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

numberOfPointsOnXiAxis

protected short numberOfPointsOnXiAxis

Number of grid locations along Xi axis

initialIndex

protected short initialIndex

initial grid point for the current pdu

coordinateScaleXi

protected double coordinateScaleXi

value that linearly scales the coordinates of the grid locations for the xi axis

coordinateOffsetXi

protected double coordinateOffsetXi

The constant offset value that shall be applied to the grid locations for the xi axis

xiValues

protected short[] xiValues

list of coordinates

Constructor Details

GridAxisDescriptorVariable

public GridAxisDescriptorVariable()

Constructor creates and configures a new instance object

Method Details

getMarshalledSize

public int getMarshalledSize()

Returns size of this serialized (marshalled) object in bytes

Overrides:

getMarshalledSize in class GridAxisDescriptor

Returns:

serialized size in bytes

See Also:

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

setNumberOfPointsOnXiAxis

public GridAxisDescriptorVariable setNumberOfPointsOnXiAxis(short pNumberOfPointsOnXiAxis)

Setter for numberOfPointsOnXiAxis

Parameters:

pNumberOfPointsOnXiAxis - new value of interest

Returns:

same object to permit progressive setters

setNumberOfPointsOnXiAxis

public GridAxisDescriptorVariable setNumberOfPointsOnXiAxis(int pNumberOfPointsOnXiAxis)

Utility setter for numberOfPointsOnXiAxis

Parameters:

pNumberOfPointsOnXiAxis - new value of interest

Returns:

same object to permit progressive setters

getNumberOfPointsOnXiAxis

public short getNumberOfPointsOnXiAxis()

Getter for numberOfPointsOnXiAxis

Returns:

value of interest

setInitialIndex

public GridAxisDescriptorVariable setInitialIndex(short pInitialIndex)

Setter for initialIndex

Parameters:

pInitialIndex - new value of interest

Returns:

same object to permit progressive setters

setInitialIndex

public GridAxisDescriptorVariable setInitialIndex(int pInitialIndex)

Utility setter for initialIndex

Parameters:

pInitialIndex - new value of interest

Returns:

same object to permit progressive setters

getInitialIndex

public short getInitialIndex()

Getter for initialIndex

Returns:

value of interest

setCoordinateScaleXi

public GridAxisDescriptorVariable setCoordinateScaleXi(double pCoordinateScaleXi)

Setter for coordinateScaleXi

Parameters:

pCoordinateScaleXi - new value of interest

Returns:

same object to permit progressive setters

getCoordinateScaleXi

public double getCoordinateScaleXi()

Getter for coordinateScaleXi

Returns:

value of interest

setCoordinateOffsetXi

public GridAxisDescriptorVariable setCoordinateOffsetXi(double pCoordinateOffsetXi)

Setter for coordinateOffsetXi

Parameters:

pCoordinateOffsetXi - new value of interest

Returns:

same object to permit progressive setters

getCoordinateOffsetXi

public double getCoordinateOffsetXi()

Getter for coordinateOffsetXi

Returns:

value of interest

setXiValues

public GridAxisDescriptorVariable setXiValues(short[] pXiValues)

Setter for xiValues

Parameters:

pXiValues - new value of interest

Returns:

same object to permit progressive setters

getXiValues

public short[] getXiValues()

Getter for xiValues

Returns:

value of interest

marshal

public void marshal(DataOutputStream dos)
             throws Exception

Serializes an object to a DataOutputStream.

Overrides:

marshal in class GridAxisDescriptor

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.

Overrides:

unmarshal in class GridAxisDescriptor

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.

Overrides:

marshal in class GridAxisDescriptor

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.

Overrides:

unmarshal in class GridAxisDescriptor

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 GridAxisDescriptor

equalsImpl

public boolean equalsImpl(Object obj)

Description copied from class: GridAxisDescriptor

Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object

Overrides:

equalsImpl in class GridAxisDescriptor

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class GridAxisDescriptor

hashCode

public int hashCode()

Overrides:

hashCode in class GridAxisDescriptor