Package edu.wpi.first.units

Class FrequencyUnit

java.lang.Object
edu.wpi.first.units.Unit
edu.wpi.first.units.PerUnit<DimensionlessUnit,TimeUnit>
edu.wpi.first.units.FrequencyUnit
public final class FrequencyUnit extends PerUnit<DimensionlessUnit,TimeUnit>
A unit of frequency like Units.Hertz.

  • Method Details

    • combine

      public static FrequencyUnit combine(DimensionlessUnit dim, TimeUnit period)
      Combines a dimensionless unit and a cycle period to create a frequency.
      Parameters:
      dim - the dimensionless unit
      period - the unit of time
      Returns:
      the combined unit of frequency

    • getBaseUnit

      public FrequencyUnit 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 PerUnit<DimensionlessUnit,TimeUnit>
      Returns:
      the base unit

    • inverse

      public static FrequencyUnit inverse(TimeUnit time)
      Inverts a unit of time to get its corresponding frequency (as if the unit of time is the period of the frequency).
      Parameters:
      time - period of the associated frequency
      Returns:
      the frequency associated with the period

    • of

      public Frequency of(double magnitude)
      Description copied from class: PerUnit
      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.

      Note: When called on an object of type PerUnit (and not a subclass!), this method will always return a Per instance. If you want to avoid casting, use PerUnit.ofNative(double) that returns a Per instance directly.

      Overrides:
      of in class PerUnit<DimensionlessUnit,TimeUnit>
      Parameters:
      magnitude - the magnitude of the measure
      Returns:
      the ratio measure

    • ofBaseUnits

      public Frequency ofBaseUnits(double baseUnitMagnitude)
      Description copied from class: PerUnit
      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.

      Note: When called on an object of type PerUnit (and not a subclass!), this method will always return a Per instance. If you want to avoid casting, use PerUnit.ofNativeBaseUnits(double) that returns a Per instance directly.

      Overrides:
      ofBaseUnits in class PerUnit<DimensionlessUnit,TimeUnit>
      Parameters:
      baseUnitMagnitude - the magnitude of the measure in terms of its base units.
      Returns:
      the ratio measure

    • zero

      public Frequency 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 PerUnit<DimensionlessUnit,TimeUnit>
      Returns:
      a zero-magnitude measure of this unit

    • one

      public Frequency 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 PerUnit<DimensionlessUnit,TimeUnit>
      Returns:
      a measure of magnitude 1.0 in terms of this unit

    • mutable

      public MutFrequency mutable(double initialMagnitude)
      Description copied from class: PerUnit
      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.

      Note: When called on an object of type PerUnit (and not a subclass!), this method will always return a MutPer instance.

      Overrides:
      mutable in class PerUnit<DimensionlessUnit,TimeUnit>
      Parameters:
      initialMagnitude - the starting magnitude of the measure
      Returns:
      the ratio measure

    • per

      public VelocityUnit<FrequencyUnit> per(TimeUnit time)
      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.
      Overrides:
      per in class PerUnit<DimensionlessUnit,TimeUnit>
      Parameters:
      time - the unit of time
      Returns:
      the combined unit

    • per

      public <U extends Unit> PerUnit<FrequencyUnit,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, FrequencyUnit otherUnit)
      Converts a measurement value in terms of another unit to this unit.
      Parameters:
      magnitude - the magnitude of the measurement in terms of the other unit
      otherUnit - the other unit
      Returns:
      the value of the measurement in terms of this unit