Package edu.wpi.first.units

Class DimensionlessUnit

java.lang.Object
edu.wpi.first.units.Unit
edu.wpi.first.units.DimensionlessUnit
public final class DimensionlessUnit extends Unit
A type of unit that corresponds to raw values and not any physical dimension, such as percentage.

  • Method Details

    • getBaseUnit

      public DimensionlessUnit getBaseUnit()
      Description copied from class: Unit
      Gets the base unit of measurement that this unit is derived from. If the unit is the base unit, the unit will be returned.

      NOTE: Subclasses must override this method to provide the correct return type. Failing to do say will make unit combinations that use it break at runtime! 

      
   Unit baseUnit = new Unit(null, ...);
   baseUnit.getBaseUnit(); // returns baseUnit

   Unit derivedUnit = new Unit(baseUnit, ...);
   derivedUnit.getBaseUnit(); // returns baseUnit
      Overrides:
      getBaseUnit in class Unit
      Returns:
      the base unit

    • of

      public Dimensionless of(double magnitude)
      Description copied from class: Unit
      Creates a new immutable measurement of the given magnitude in terms of this unit. Implementations are strongly recommended to sharpen the return type to a unit-specific measurement implementation.
      Specified by:
      of in class Unit
      Parameters:
      magnitude - the magnitude of the measurement.
      Returns:
      the measurement object

    • ofBaseUnits

      public Dimensionless ofBaseUnits(double baseUnitMagnitude)
      Description copied from class: Unit
      Creates a new immutable measurement of the given magnitude in terms of this unit's base unit. Implementations are strongly recommended to sharpen the return type to a unit-specific measurement implementation.
      Specified by:
      ofBaseUnits in class Unit
      Parameters:
      baseUnitMagnitude - the magnitude in terms of the base unit
      Returns:
      the measurement object

    • zero

      public Dimensionless zero()
      Description copied from class: Unit
      Gets a measure of zero magnitude in terms of this unit. The returned object is guaranteed to be of the same type returned by Unit.of(double). Subclasses are encouraged to override this method to sharpen the return type.
      Overrides:
      zero in class Unit
      Returns:
      a zero-magnitude measure of this unit

    • one

      public Dimensionless one()
      Description copied from class: Unit
      Gets a measure with a magnitude of 1.0 in terms of this unit. The returned object is guaranteed to be of the same type returned by Unit.of(double). Subclasses are encouraged to override this method to sharpen the return type.
      Overrides:
      one in class Unit
      Returns:
      a measure of magnitude 1.0 in terms of this unit

    • mutable

      public MutDimensionless mutable(double initialMagnitude)
      Description copied from class: Unit
      Creates a new mutable measurement that is initialized to the given magnitude in terms of this unit. Implementations are strongly recommended to sharpen the return type to a unit-specific measurement implementation.
      Specified by:
      mutable in class Unit
      Parameters:
      initialMagnitude - the initial magnitude of the mutable measurement
      Returns:
      the mutable measurement object

    • convertFrom

      public double convertFrom(double magnitude, DimensionlessUnit otherUnit)
      Converts a measurement value in terms of another dimensionless unit to this unit.
      Parameters:
      magnitude - the magnitude of the measurement in terms of the other dimensionless unit
      otherUnit - the other dimensionless unit
      Returns:
      the value of the measurement in terms of this unit

    • per

      public FrequencyUnit per(TimeUnit period)
      Creates a frequency unit as the ratio of this dimensionless unit to the period of time in which a single cycle is made.
      Specified by:
      per in class Unit
      Parameters:
      period - the cycle period
      Returns:
      the combined frequency unit

    • per

      public <U extends Unit> PerUnit<DimensionlessUnit,U> per(U other)
      Creates a ratio unit between this unit and an arbitrary other unit.
      Type Parameters:
      U - the type of the other unit
      Parameters:
      other - the other unit
      Returns:
      the ratio unit