Class FieldBit


  • public class FieldBit
    extends Field
    The Field_Bit class provides parameters for extracting one field out of a string of bytes which contains packed data (that is, data values either smaller than a single byte, or crossing byte boundaries, or both.

    Java class for Field_Bit complex type

    .

    The following schema fragment specifies the expected content contained within this class.

    
     <complexType name="Field_Bit">
       <complexContent>
         <extension base="{http://pds.nasa.gov/pds4/pds/v1}Field">
           <sequence>
             <element name="start_bit_location" type="{http://pds.nasa.gov/pds4/pds/v1}start_bit_location" minOccurs="0"/>
             <element name="start_bit" type="{http://pds.nasa.gov/pds4/pds/v1}start_bit" minOccurs="0"/>
             <element name="stop_bit_location" type="{http://pds.nasa.gov/pds4/pds/v1}stop_bit_location" minOccurs="0"/>
             <element name="stop_bit" type="{http://pds.nasa.gov/pds4/pds/v1}stop_bit" minOccurs="0"/>
             <element name="data_type" type="{http://pds.nasa.gov/pds4/pds/v1}data_type"/>
             <element name="field_format" type="{http://pds.nasa.gov/pds4/pds/v1}field_format" minOccurs="0"/>
             <element name="unit" type="{http://pds.nasa.gov/pds4/pds/v1}unit" minOccurs="0"/>
             <element name="scaling_factor" type="{http://pds.nasa.gov/pds4/pds/v1}scaling_factor" minOccurs="0"/>
             <element name="value_offset" type="{http://pds.nasa.gov/pds4/pds/v1}value_offset" minOccurs="0"/>
             <element name="description" type="{http://pds.nasa.gov/pds4/pds/v1}description" minOccurs="0"/>
             <element name="Special_Constants" type="{http://pds.nasa.gov/pds4/pds/v1}Special_Constants" minOccurs="0"/>
           </sequence>
         </extension>
       </complexContent>
     </complexType>
     
    • Constructor Summary

      Constructors 
      Constructor Description
      FieldBit()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDataType()
      Gets the value of the dataType property.
      java.lang.String getDescription()
      Gets the value of the description property.
      java.lang.String getFieldFormat()
      Gets the value of the fieldFormat property.
      java.lang.Double getScalingFactor()
      Gets the value of the scalingFactor property.
      SpecialConstants getSpecialConstants()
      Gets the value of the specialConstants property.
      java.math.BigInteger getStartBit()
      Gets the value of the startBit property.
      java.math.BigInteger getStartBitLocation()
      Gets the value of the startBitLocation property.
      java.math.BigInteger getStopBit()
      Gets the value of the stopBit property.
      java.math.BigInteger getStopBitLocation()
      Gets the value of the stopBitLocation property.
      java.lang.String getUnit()
      Gets the value of the unit property.
      java.lang.Double getValueOffset()
      Gets the value of the valueOffset property.
      void setDataType​(java.lang.String value)
      Sets the value of the dataType property.
      void setDescription​(java.lang.String value)
      Sets the value of the description property.
      void setFieldFormat​(java.lang.String value)
      Sets the value of the fieldFormat property.
      void setScalingFactor​(java.lang.Double value)
      Sets the value of the scalingFactor property.
      void setSpecialConstants​(SpecialConstants value)
      Sets the value of the specialConstants property.
      void setStartBit​(java.math.BigInteger value)
      Sets the value of the startBit property.
      void setStartBitLocation​(java.math.BigInteger value)
      Sets the value of the startBitLocation property.
      void setStopBit​(java.math.BigInteger value)
      Sets the value of the stopBit property.
      void setStopBitLocation​(java.math.BigInteger value)
      Sets the value of the stopBitLocation property.
      void setUnit​(java.lang.String value)
      Sets the value of the unit property.
      void setValueOffset​(java.lang.Double value)
      Sets the value of the valueOffset property.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • startBitLocation

        protected java.math.BigInteger startBitLocation
      • startBit

        protected java.math.BigInteger startBit
      • stopBitLocation

        protected java.math.BigInteger stopBitLocation
      • stopBit

        protected java.math.BigInteger stopBit
      • dataType

        protected java.lang.String dataType
      • fieldFormat

        protected java.lang.String fieldFormat
      • unit

        protected java.lang.String unit
      • scalingFactor

        protected java.lang.Double scalingFactor
      • valueOffset

        protected java.lang.Double valueOffset
      • description

        protected java.lang.String description
    • Constructor Detail

      • FieldBit

        public FieldBit()
    • Method Detail

      • getStartBitLocation

        public java.math.BigInteger getStartBitLocation()
        Gets the value of the startBitLocation property.
        Returns:
        possible object is BigInteger
      • setStartBitLocation

        public void setStartBitLocation​(java.math.BigInteger value)
        Sets the value of the startBitLocation property.
        Parameters:
        value - allowed object is BigInteger
      • getStartBit

        public java.math.BigInteger getStartBit()
        Gets the value of the startBit property.
        Returns:
        possible object is BigInteger
      • setStartBit

        public void setStartBit​(java.math.BigInteger value)
        Sets the value of the startBit property.
        Parameters:
        value - allowed object is BigInteger
      • getStopBitLocation

        public java.math.BigInteger getStopBitLocation()
        Gets the value of the stopBitLocation property.
        Returns:
        possible object is BigInteger
      • setStopBitLocation

        public void setStopBitLocation​(java.math.BigInteger value)
        Sets the value of the stopBitLocation property.
        Parameters:
        value - allowed object is BigInteger
      • getStopBit

        public java.math.BigInteger getStopBit()
        Gets the value of the stopBit property.
        Returns:
        possible object is BigInteger
      • setStopBit

        public void setStopBit​(java.math.BigInteger value)
        Sets the value of the stopBit property.
        Parameters:
        value - allowed object is BigInteger
      • getDataType

        public java.lang.String getDataType()
        Gets the value of the dataType property.
        Returns:
        possible object is String
      • setDataType

        public void setDataType​(java.lang.String value)
        Sets the value of the dataType property.
        Parameters:
        value - allowed object is String
      • getFieldFormat

        public java.lang.String getFieldFormat()
        Gets the value of the fieldFormat property.
        Returns:
        possible object is String
      • setFieldFormat

        public void setFieldFormat​(java.lang.String value)
        Sets the value of the fieldFormat property.
        Parameters:
        value - allowed object is String
      • getUnit

        public java.lang.String getUnit()
        Gets the value of the unit property.
        Returns:
        possible object is String
      • setUnit

        public void setUnit​(java.lang.String value)
        Sets the value of the unit property.
        Parameters:
        value - allowed object is String
      • getScalingFactor

        public java.lang.Double getScalingFactor()
        Gets the value of the scalingFactor property.
        Returns:
        possible object is Double
      • setScalingFactor

        public void setScalingFactor​(java.lang.Double value)
        Sets the value of the scalingFactor property.
        Parameters:
        value - allowed object is Double
      • getValueOffset

        public java.lang.Double getValueOffset()
        Gets the value of the valueOffset property.
        Returns:
        possible object is Double
      • setValueOffset

        public void setValueOffset​(java.lang.Double value)
        Sets the value of the valueOffset property.
        Parameters:
        value - allowed object is Double
      • getDescription

        public java.lang.String getDescription()
        Gets the value of the description property.
        Returns:
        possible object is String
      • setDescription

        public void setDescription​(java.lang.String value)
        Sets the value of the description property.
        Parameters:
        value - allowed object is String
      • getSpecialConstants

        public SpecialConstants getSpecialConstants()
        Gets the value of the specialConstants property.
        Returns:
        possible object is SpecialConstants
      • setSpecialConstants

        public void setSpecialConstants​(SpecialConstants value)
        Sets the value of the specialConstants property.
        Parameters:
        value - allowed object is SpecialConstants