edu.nps.moves.dis7mobile
Class GridAxis

java.lang.Object
  extended by edu.nps.moves.dis7mobile.GridAxis
All Implemented Interfaces:
java.io.Serializable

public class GridAxis
extends java.lang.Object
implements java.io.Serializable

Grid axis record for fixed data. Section 6.2.41 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 axisType
          type of grid axis
protected  double domainFinalXi
          coordinate of the endpoint or final value
protected  double domainInitialXi
          coordinate of the grid origin or initial value
protected  int domainPointsXi
          The number of grid points along the Xi domain axis for the enviornmental state data
protected  int initialIndex
          initial grid point for the current pdu
protected  short interleafFactor
          interleaf factor along the domain axis.
protected  int numberOfPointsOnXiAxis
          Number of grid locations along Xi axis
 
Constructor Summary
GridAxis()
          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 getAxisType()
           
 double getDomainFinalXi()
           
 double getDomainInitialXi()
           
 int getDomainPointsXi()
           
 int getInitialIndex()
           
 short getInterleafFactor()
           
 int getMarshalledSize()
           
 int getNumberOfPointsOnXiAxis()
           
 void marshal(java.nio.ByteBuffer buff)
          Packs a Pdu into the ByteBuffer.
 void marshal(java.io.DataOutputStream dos)
           
 void setAxisType(short pAxisType)
           
 void setDomainFinalXi(double pDomainFinalXi)
           
 void setDomainInitialXi(double pDomainInitialXi)
           
 void setDomainPointsXi(int pDomainPointsXi)
           
 void setInitialIndex(int pInitialIndex)
           
 void setInterleafFactor(short pInterleafFactor)
           
 void setNumberOfPointsOnXiAxis(int pNumberOfPointsOnXiAxis)
           
 void unmarshal(java.nio.ByteBuffer buff)
          Unpacks a Pdu from the underlying data.
 void unmarshal(java.io.DataInputStream dis)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

domainInitialXi

protected double domainInitialXi
coordinate of the grid origin or initial value


domainFinalXi

protected double domainFinalXi
coordinate of the endpoint or final value


domainPointsXi

protected int domainPointsXi
The number of grid points along the Xi domain axis for the enviornmental state data


interleafFactor

protected short interleafFactor
interleaf factor along the domain axis.


axisType

protected short axisType
type of grid axis


numberOfPointsOnXiAxis

protected int numberOfPointsOnXiAxis
Number of grid locations along Xi axis


initialIndex

protected int initialIndex
initial grid point for the current pdu

Constructor Detail

GridAxis

public GridAxis()
Constructor

Method Detail

getMarshalledSize

public int getMarshalledSize()

setDomainInitialXi

public void setDomainInitialXi(double pDomainInitialXi)

getDomainInitialXi

public double getDomainInitialXi()

setDomainFinalXi

public void setDomainFinalXi(double pDomainFinalXi)

getDomainFinalXi

public double getDomainFinalXi()

setDomainPointsXi

public void setDomainPointsXi(int pDomainPointsXi)

getDomainPointsXi

public int getDomainPointsXi()

setInterleafFactor

public void setInterleafFactor(short pInterleafFactor)

getInterleafFactor

public short getInterleafFactor()

setAxisType

public void setAxisType(short pAxisType)

getAxisType

public short getAxisType()

setNumberOfPointsOnXiAxis

public void setNumberOfPointsOnXiAxis(int pNumberOfPointsOnXiAxis)

getNumberOfPointsOnXiAxis

public int getNumberOfPointsOnXiAxis()

setInitialIndex

public void setInitialIndex(int pInitialIndex)

getInitialIndex

public int getInitialIndex()

marshal

public void marshal(java.io.DataOutputStream dos)

unmarshal

public void unmarshal(java.io.DataInputStream dis)

marshal

public void marshal(java.nio.ByteBuffer buff)
Packs a Pdu into the ByteBuffer.

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.

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 java.lang.Object

equalsImpl

public 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

Parameters:
obj - the object to compare to
Returns:
true if the objects are equal, false otherwise.