Class LabeledValue


  • public class LabeledValue
    extends java.lang.Object
    A double value along with it's label.

    Very primitive class comparable to a c struct.

    Version:
    $Revision: 1.7 $
    Author:
    Achim Westermann
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean m_isMajorTick
      The flag showing if this label is a major tick.
      protected java.lang.String m_label
      The label.
      protected double m_value
      The corresponding value scaled to a position between 0.0 and 1.0.
    • Constructor Summary

      Constructors 
      Constructor Description
      LabeledValue()
      Internal defcon.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getLabel()
      Returns the label String.
      double getValue()
      Returns the value of this label which is scaled to lie between 0.0 and 1.0.
      boolean isMajorTick()
      Returns true if this label is a major tick, false else.
      void setLabel​(java.lang.String label)
      Sets the label String.
      void setMajorTick​(boolean isMajorTick)
      Set this label as a major tick.
      void setValue​(double value)
      Sets the value.
      java.lang.String toString()
      Returns the concatenation of the label string, ':' and the value's String representation.
      • Methods inherited from class java.lang.Object

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

      • m_isMajorTick

        protected boolean m_isMajorTick
        The flag showing if this label is a major tick.
      • m_label

        protected java.lang.String m_label
        The label.
      • m_value

        protected double m_value
        The corresponding value scaled to a position between 0.0 and 1.0.
    • Constructor Detail

      • LabeledValue

        public LabeledValue()
        Internal defcon.

    • Method Detail

      • getLabel

        public java.lang.String getLabel()
        Returns the label String.

        Returns:
        the label String.
      • getValue

        public double getValue()
        Returns the value of this label which is scaled to lie between 0.0 and 1.0.

        Returns:
        the value of this label which is scaled to lie between 0.0 and 1.0.
      • setLabel

        public void setLabel​(java.lang.String label)
        Sets the label String.

        Parameters:
        label - the label String.
      • setValue

        public final void setValue​(double value)
        Sets the value.

        Parameters:
        value - The value to set.
      • toString

        public java.lang.String toString()
        Returns the concatenation of the label string, ':' and the value's String representation.

        Overrides:
        toString in class java.lang.Object
        Returns:
        the concatenation of the label string, ':' and the value's String representation.
        See Also:
        Object.toString()