Package edu.nps.moves.dis7
Class GridAxisDescriptor
java.lang.Object
edu.nps.moves.dis7.GridAxisDescriptor
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
GridAxisDescriptorFixed
,GridAxisDescriptorVariable
public class GridAxisDescriptor
extends java.lang.Object
implements java.io.Serializable
IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation—Application Protocols
- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description protected GridAxisDescriptorAxisType
axisType
type of grid axis uid 377protected double
domainFinalXi
coordinate of the endpoint or final valueprotected double
domainInitialXi
coordinate of the grid origin or initial valueprotected short
domainPointsXi
The number of grid points along the Xi domain axis for the enviornmental state dataprotected byte
interleafFactor
interleaf factor along the domain axis. -
Constructor Summary
Constructors Constructor Description GridAxisDescriptor()
Constructor -
Method Summary
Modifier and Type Method Description 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, forthis
and the supplied objectGridAxisDescriptorAxisType
getAxisType()
Getter foraxisType
double
getDomainFinalXi()
Getter fordomainFinalXi
double
getDomainInitialXi()
Getter fordomainInitialXi
short
getDomainPointsXi()
Getter fordomainPointsXi
byte
getInterleafFactor()
Getter forinterleafFactor
int
getMarshalledSize()
Returns the size of this serialized object in bytesvoid
marshal(java.io.DataOutputStream dos)
Serializes an object to a DataOutputStream.void
marshal(java.nio.ByteBuffer buff)
Packs an object into the ByteBuffer.GridAxisDescriptor
setAxisType(GridAxisDescriptorAxisType pAxisType)
Setter foraxisType
GridAxisDescriptor
setDomainFinalXi(double pDomainFinalXi)
Setter fordomainFinalXi
GridAxisDescriptor
setDomainInitialXi(double pDomainInitialXi)
Setter fordomainInitialXi
GridAxisDescriptor
setDomainPointsXi(short pDomainPointsXi)
Setter fordomainPointsXi
GridAxisDescriptor
setInterleafFactor(byte pInterleafFactor)
Setter forinterleafFactor
java.lang.String
toString()
int
unmarshal(java.io.DataInputStream dis)
Unserializes an object from a DataInputStream.int
unmarshal(java.nio.ByteBuffer buff)
Unpacks a Pdu from the underlying data.
-
Field Details
-
domainInitialXi
protected double domainInitialXicoordinate of the grid origin or initial value -
domainFinalXi
protected double domainFinalXicoordinate of the endpoint or final value -
domainPointsXi
protected short domainPointsXiThe number of grid points along the Xi domain axis for the enviornmental state data -
interleafFactor
protected byte interleafFactorinterleaf factor along the domain axis. -
axisType
type of grid axis uid 377
-
-
Constructor Details
-
GridAxisDescriptor
public GridAxisDescriptor()Constructor
-
-
Method Details
-
getMarshalledSize
public int getMarshalledSize()Returns the size of this serialized object in bytes -
setDomainInitialXi
Setter fordomainInitialXi
-
getDomainInitialXi
public double getDomainInitialXi()Getter fordomainInitialXi
-
setDomainFinalXi
Setter fordomainFinalXi
-
getDomainFinalXi
public double getDomainFinalXi()Getter fordomainFinalXi
-
setDomainPointsXi
Setter fordomainPointsXi
-
getDomainPointsXi
public short getDomainPointsXi()Getter fordomainPointsXi
-
setInterleafFactor
Setter forinterleafFactor
-
getInterleafFactor
public byte getInterleafFactor()Getter forinterleafFactor
-
setAxisType
Setter foraxisType
-
getAxisType
Getter foraxisType
-
marshal
public void marshal(java.io.DataOutputStream dos) throws java.lang.ExceptionSerializes an object to a DataOutputStream.- Parameters:
dos
- the OutputStream- Throws:
java.lang.Exception
- if something goes wrong- See Also:
DataOutputStream
-
unmarshal
public int unmarshal(java.io.DataInputStream dis) throws java.lang.ExceptionUnserializes an object from a DataInputStream.- Parameters:
dis
- the InputStream- Returns:
- unmarshalled size
- Throws:
java.lang.Exception
- if something goes wrong- See Also:
DataInputStream
-
marshal
public void marshal(java.nio.ByteBuffer buff) throws java.lang.ExceptionPacks an object into the ByteBuffer.- Parameters:
buff
- The ByteBuffer at the position to begin writing- Throws:
java.nio.BufferOverflowException
- if buff is too smalljava.nio.ReadOnlyBufferException
- if buff is read onlyjava.lang.Exception
- ByteBuffer-generated exception- See Also:
ByteBuffer
-
unmarshal
public int unmarshal(java.nio.ByteBuffer buff) throws java.lang.ExceptionUnpacks a Pdu from the underlying data.- Parameters:
buff
- The ByteBuffer at the position to begin reading- Returns:
- marshalled size
- Throws:
java.nio.BufferUnderflowException
- if buff is too smalljava.lang.Exception
- ByteBuffer-generated exception- See Also:
ByteBuffer
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classjava.lang.Object
-
equalsImpl
public boolean equalsImpl(java.lang.Object obj)Compare all fields that contribute to the state, ignoring transient and static fields, forthis
and the supplied object- Parameters:
obj
- the object to compare to- Returns:
- true if the objects are equal, false otherwise.
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-