AUnit
info.monitorenter.util.units

Class AUnit

    • Method Detail

      • getDecimals

        public int getDecimals()
        Returns the number of decimals that should be be taken into account if the method getValue(double) is invoked (rounding).

        Returns:
        the number of decimals that should be be taken into account if the method getValue(double) is invoked (rounding).
      • getFactor

        public double getFactor()
        Returns the factor a result of getValue(double) had to be multiplied with if the real (unitless) value has to be calculated.

        For performance reason (fast access) factor is public. This is against "safety by desing" so do never set this value.

        Returns:
        the factor a result of getValue(double) had to be multiplied with if the real (unitless) value has to be calculated.
      • getLabel

        public String getLabel(double value)
        Returns the the value divided by this unit's factor, rounded to this unit's configured decimals and suffixed by the unit name.

        Parameters:
        value - the value for the label.
        Returns:
        the the value divided by this unit's factor, rounded by this unit's configured decimals and suffixed by the unit name.
        See Also:
        getUnitName(), getDecimals()
      • getNexLowerUnit

        public AUnit getNexLowerUnit()
        Returns the next smaller unit to this one within this unit's IUnitSystem.

        If this is already the smallest unit, this will be returned so add unit == unit.getLowerUnit() as the termination criteria in loops to search for the smallest unit (to avoid endless loops).

        Returns:
        the next lower unit to this one within this unit's IUnitSystem.
      • getNextHigherUnit

        public AUnit getNextHigherUnit()
        Returns the next greater unit to this one within this unit's IUnitSystem.

        If this is already the greatest unit, this will be returned so add unit == unit.getNextHigherUnit() as the termination criteria in loops to search for the greatest unit (to avoid endless loops).

        Returns:
        the next greater unit to this one within this unit's IUnitSystem.
      • getUnitName

        public String getUnitName()
        Retunrns the short unit name of this unit a result of getValue(double) has to be related with to know the this result is displayed in a unit.

        Returns:
        the short unit name of this unit a result of getValue(double) has to be related with to know the this result is displayed in a unit.

      • getValue

        public double getValue(double value)
        Transforms the given absolute value into the represented unit value by dividing by the specific factor.

        The result is rounded using the actual decimal setting.

        Parameters:
        value - the value to represent in this unit.
        Returns:
        The value to display in this unit rounded using the internal decimals.
      • setDecimals

        public void setDecimals(int aftercomma)
        Define how many decimals should be taken into account if the method getValue(double) is invoked (rounding).

        Parameters:
        aftercomma - the number of decimals that should be taken into account if the method getValue(double) is invoked (rounding)

SCaVis 2.2 © jWork.ORG