Package edu.nps.moves.dis7.pdus
Class GridAxisDescriptor
java.lang.Object
edu.nps.moves.dis7.pdus.GridAxisDescriptor
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
GridAxisDescriptorFixed,GridAxisDescriptorVariable
Detailed information about the grid dimensions (axes) and coordinates for environmental state variables
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected GridAxisDescriptorAxisTypetype of grid axis uid 377protected doublecoordinate of the endpoint or final valueprotected doublecoordinate of the grid origin or initial valueprotected shortThe number of grid points along the Xi domain axis for the enviornmental state dataprotected byteinterleaf factor along the domain axis. -
Constructor Summary
ConstructorsConstructorDescriptionConstructor creates and configures a new instance object -
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleanequalsImpl(Object obj) Compare all fields that contribute to the state, ignoring transient and static fields, forthisand the supplied objectGetter foraxisTypedoubleGetter fordomainFinalXidoubleGetter fordomainInitialXishortGetter fordomainPointsXibyteGetter forinterleafFactorintReturns size of this serialized (marshalled) object in bytesinthashCode()voidmarshal(DataOutputStream dos) Serializes an object to a DataOutputStream.voidmarshal(ByteBuffer byteBuffer) Packs an object into the ByteBuffer.setAxisType(GridAxisDescriptorAxisType pAxisType) Setter foraxisTypesetDomainFinalXi(double pDomainFinalXi) Setter fordomainFinalXisetDomainInitialXi(double pDomainInitialXi) Setter fordomainInitialXisetDomainPointsXi(int pDomainPointsXi) Utility setter fordomainPointsXisetDomainPointsXi(short pDomainPointsXi) Setter fordomainPointsXisetInterleafFactor(byte pInterleafFactor) Setter forinterleafFactorsetInterleafFactor(int pInterleafFactor) Utility setter forinterleafFactortoString()intunmarshal(DataInputStream dis) Deserializes an object from a DataInputStream.intunmarshal(ByteBuffer byteBuffer) 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 creates and configures a new instance object
-
-
Method Details
-
getMarshalledSize
public int getMarshalledSize()Returns size of this serialized (marshalled) object in bytes- Returns:
- serialized size in bytes
- See Also:
-
setDomainInitialXi
Setter fordomainInitialXi- Parameters:
pDomainInitialXi- new value of interest- Returns:
- same object to permit progressive setters
-
getDomainInitialXi
-
setDomainFinalXi
Setter fordomainFinalXi- Parameters:
pDomainFinalXi- new value of interest- Returns:
- same object to permit progressive setters
-
getDomainFinalXi
-
setDomainPointsXi
Setter fordomainPointsXi- Parameters:
pDomainPointsXi- new value of interest- Returns:
- same object to permit progressive setters
-
setDomainPointsXi
Utility setter fordomainPointsXi- Parameters:
pDomainPointsXi- new value of interest- Returns:
- same object to permit progressive setters
-
getDomainPointsXi
-
setInterleafFactor
Setter forinterleafFactor- Parameters:
pInterleafFactor- new value of interest- Returns:
- same object to permit progressive setters
-
setInterleafFactor
Utility setter forinterleafFactor- Parameters:
pInterleafFactor- new value of interest- Returns:
- same object to permit progressive setters
-
getInterleafFactor
-
setAxisType
Setter foraxisType- Parameters:
pAxisType- new value of interest- Returns:
- same object to permit progressive setters
-
getAxisType
-
marshal
Serializes an object to a DataOutputStream.- Parameters:
dos- the OutputStream- Throws:
Exception- if something goes wrong- See Also:
-
unmarshal
Deserializes an object from a DataInputStream.- Parameters:
dis- the InputStream- Returns:
- marshalled serialized size in bytes
- Throws:
Exception- if something goes wrong- See Also:
-
marshal
Packs an object into the ByteBuffer.- Parameters:
byteBuffer- The ByteBuffer at the position to begin writing- Throws:
BufferOverflowException- if byteBuffer is too smallReadOnlyBufferException- if byteBuffer is read onlyException- ByteBuffer-generated exception- See Also:
-
unmarshal
Unpacks a Pdu from the underlying data.- Parameters:
byteBuffer- The ByteBuffer at the position to begin reading- Returns:
- marshalled serialized size in bytes
- Throws:
BufferUnderflowException- if byteBuffer is too smallException- ByteBuffer-generated exception- See Also:
-
equals
-
equalsImpl
Compare all fields that contribute to the state, ignoring transient and static fields, forthisand the supplied object- Parameters:
obj- the object to compare to- Returns:
- true if the objects are equal, false otherwise.
-
toString
-
hashCode
-