Class mil.navy.nps.dis.ArticulationParameter
java.lang.Object
|
+--mil.navy.nps.dis.PduElement
|
+--mil.navy.nps.dis.ArticulationParameter
- public class ArticulationParameter
- extends PduElement
- Version:
- 1.0
- Author:
- Don McGregor (http://www.stl.nps.navy.mil/~mcgredo)
- Location:
-
http://www.stl.nps.navy.mil/dis-java-vrml/mil/navy/nps/dis/ArticulationParameter.java
- Hierarchy Diagram:
- Summary:
- Location of the origin of the entity's coordinate system shall be specified
by a set of three coordinates: X, Y, and Z.
- Explanation
- The articulation parameter describes how a part of an entity, such as a turret or fin,
is oriented wrt the rest of the entity.
This is a subclass of the PduElement class, the abstract class that all parts of a
PDU inherit from. It knows how to serialize, deserialize, and clone itself. It
is kept as a part of the EntityStatePdu.
- History:
- 21Oct96 /Don McGregor /New
- 04Mar97 /Don McGregor /changes for javadoc
- 16Apr97 /Don McGregor /PrintStream passed to printValues
- 8Dec97 /Ronan Fauglas /changes for documentation templates + complements in documentation
- 11Dec97 /Ronan Fauglas /changes access methods names from "variable()" to "getVariable()"
- 04Jan98 /Ronan Fauglas /suppressed redundant comments for clone, printValues, etc...
- 12Jan98 /Ronan Fauglas /changed changeIndicator to parameterChangeIndicator.
- 12Jan98 /Ronan Fauglas /changed partID to articulationAttachmentID.
- References:
- DIS Data Dictionary:
Articulation Parameter Record
- DIS specification : IEEE 1278.1, Section 5.3.5, Annex A
- See Also:
- PduElement, DetonationPdu, mil.navy.nps.util.SerializationInterface, EntityPosition, EntityStatePdu
Field Summary
|
mil.navy.nps.util.UnsignedShort
|
articulationAttachmentID
The identification of the articulated part to which this articulation parameter is attached.
|
mil.navy.nps.util.UnsignedByte
|
changeIndicator
The change of any parameter for any articulated part shall be indicated by a change indicator field.
|
mil.navy.nps.util.UnsignedInt
|
parameterType
The type of parameter represented shall be specified by an enumeration.
|
mil.navy.nps.util.UnsignedByte
|
parameterTypeDesignator
The identification of wether the Parameter Type Record is for an articulated
or attached part shall be designated by this field.
|
long
|
parameterValue
This field contains the value of the Articulation parameter.
|
static int
|
sizeOf
Constant value--size of an Articulation Parameter WHEN WRITTEN TO THE WIRE; here :sizeOf = 16 bytes . |
Methods inherited from class java.lang.Object |
, clone, equals, finalize, getClass, hashCode, notifyAll, notify, toString, wait, wait, wait |
parameterTypeDesignator
protected mil.navy.nps.util.UnsignedByte parameterTypeDesignator
- The identification of wether the Parameter Type Record is for an articulated
or attached part shall be designated by this field.
- Value:
- Enumeration, see references below for values.
- References:
- DIS Data Dictionary :
Parameter Type Designator Field
changeIndicator
protected mil.navy.nps.util.UnsignedByte changeIndicator
- The change of any parameter for any articulated part shall be indicated by a change indicator field.
- Value:
- This field shall be set to o for each exercise and sequencially incremented by one
for each change in articulation parameter. In the case all possible values are exhausted, the numbers
shall be reused beginning at zero.
- References:
- DIS Data Dictionary :
Parameter Change Indicator Field
- See section 4 in EBV-DOC
articulationAttachmentID
protected mil.navy.nps.util.UnsignedShort articulationAttachmentID
- The identification of the articulated part to which this articulation parameter is attached.
- Value:
- This field shall contain the value 0 if the articulated part is attached directly to the entity.
- References:
- DIS Data Dictionary :
Articulation Attachment ID Field
parameterType
protected mil.navy.nps.util.UnsignedInt parameterType
- The type of parameter represented shall be specified by an enumeration.
- Value:
- Enumeration, see references below for values.
- Note:
- The Dis Data Dictionnary is bugged, please refer to the standard.
- References:
- DIS Data Dictionary :
Parameter Type Varient (bugged...)
- DIS specification : IEEE 1278.1, Annex A
- See Section 4 in EBV-DOC
parameterValue
protected long parameterValue
- This field contains the value of the Articulation parameter.
- Value:
- The definition of the 64 bits shall be determined based on the type of parameter specified
in the ParameterType field. See References below for further information.
- References:
- DIS Data Dictionary :
Articulation Parameter Record (bugged...)
- DIS specification : IEEE 1278.1, 5.3.5.4
- See Section 4 in EBV-DOC
sizeOf
public static final int sizeOf
- Constant value--size of an Articulation Parameter WHEN WRITTEN TO THE WIRE; here :
sizeOf = 16 bytes
.
ArticulationParameter
public ArticulationParameter()
- Default constructor--fills with zeros for all values.
clone
public java.lang.Object clone()
- Overrides:
- clone in class PduElement
serialize
public void serialize(java.io.DataOutputStream outputStream)
- Overrides:
- serialize in class PduElement
deSerialize
public void deSerialize(java.io.DataInputStream inputStream)
- Overrides:
- deSerialize in class PduElement
length
public int length()
- Overrides:
- length in class PduElement
printValues
public void printValues(int indentLevel,
java.io.PrintStream printStream)
- Overrides:
- printValues in class PduElement
getParameterTypeDesignator
public mil.navy.nps.util.UnsignedByte getParameterTypeDesignator()
setParameterTypeDesignator
public void setParameterTypeDesignator(mil.navy.nps.util.UnsignedByte pParameterTypeDesignator)
setParameterTypeDesignator
public void setParameterTypeDesignator(int pParameterTypeDesignator)
getChangeIndicator
public mil.navy.nps.util.UnsignedByte getChangeIndicator()
setChangeIndicator
public void setChangeIndicator(mil.navy.nps.util.UnsignedByte pChangeIndicator)
setChangeIndicator
public void setChangeIndicator(int pChangeIndicator)
getArticulationAttachmentID
public mil.navy.nps.util.UnsignedShort getArticulationAttachmentID()
setArticulationAttachmentID
public void setArticulationAttachmentID(mil.navy.nps.util.UnsignedShort pArticulationAttachmentID)
setArticulationAttachmentID
public void setArticulationAttachmentID(int pArticulationAttachmentID)
getParameterType
public mil.navy.nps.util.UnsignedInt getParameterType()
setParameterType
public void setParameterType(mil.navy.nps.util.UnsignedInt pParameterType)
setParameterType
public void setParameterType(int pParameterType)
getParameterValue
public long getParameterValue()
setParameterValue
public void setParameterValue(long pParameterValue)