Package edu.wpi.first.units

Class MassUnit

java.lang.Object
edu.wpi.first.units.Unit
edu.wpi.first.units.MassUnit
public final class MassUnit extends Unit
Unit of mass dimension.

This is the base type for units of mass dimension. It is also used to specify the dimension for the mass-specific Mass measurement type.

Actual units (such as Units.Grams and Units.Pounds) can be found in the Units class.

  • Method Details

    • getBaseUnit

      public MassUnit 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 Mass 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 Mass 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 Mass 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 Mass 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 MutMass 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

    • per

      public VelocityUnit<MassUnit> per(TimeUnit period)
      Description copied from class: Unit
      Combines this unit with a unit of time. This often - but not always - results in a velocity. Subclasses should sharpen the return type to be unit-specific.
      Specified by:
      per in class Unit
      Parameters:
      period - the unit of time
      Returns:
      the combined unit

    • per

      public <U extends Unit> PerUnit<MassUnit,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

    • convertFrom

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

    • mult

      public LinearMomentumUnit mult(LinearVelocityUnit velocity)
      Multiplies this mass unit by a unit of linear velocity to form a combined unit of linear momentum.
      Parameters:
      velocity - the unit of velocity
      Returns:
      the combined unit of momentum

    • mult

      public ForceUnit mult(LinearAccelerationUnit acceleration)
      Multiplies this mass unit by a unit of linear acceleration to form a combined unit of force.
      Parameters:
      acceleration - the unit of acceleration
      Returns:
      the combined unit of force