FrequencyUnit.java

// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
 
package org.wpilib.units;
 
import static org.wpilib.units.Units.Value;
 
import org.wpilib.units.measure.Frequency;

public final class FrequencyUnit extends PerUnit<DimensionlessUnit, TimeUnit> {
  private static final CombinatoryUnitCache<DimensionlessUnit, TimeUnit, FrequencyUnit> cache =
      new CombinatoryUnitCache<>(FrequencyUnit::new);
 
  FrequencyUnit(DimensionlessUnit numerator, TimeUnit denominator) {
    super(
        numerator.isBaseUnit() && denominator.isBaseUnit()
            ? null
            : combine(numerator.getBaseUnit(), denominator.getBaseUnit()),
        numerator,
        denominator);
  }
 
  FrequencyUnit(
      FrequencyUnit baseUnit,
      UnaryFunction toBaseConverter,
      UnaryFunction fromBaseConverter,
      String name,
      String symbol) {
    super(baseUnit, toBaseConverter, fromBaseConverter, name, symbol);
  }

  public static FrequencyUnit combine(DimensionlessUnit dim, TimeUnit period) {
    return cache.combine(dim, period);
  }
 
  @Override
  public FrequencyUnit getBaseUnit() {
    return (FrequencyUnit) super.getBaseUnit();
  }

  public static FrequencyUnit inverse(TimeUnit time) {
    return combine(Value, time);
  }
 
  @Override
  public Frequency of(double magnitude) {
    return new Frequency(magnitude, toBaseUnits(magnitude), this);
  }
 
  @Override
  public Frequency ofBaseUnits(double baseUnitMagnitude) {
    return new Frequency(fromBaseUnits(baseUnitMagnitude), baseUnitMagnitude, this);
  }
 
  @Override
  public Frequency zero() {
    return (Frequency) super.zero();
  }
 
  @Override
  public Frequency one() {
    return (Frequency) super.one();
  }
 
  @Override
  public VelocityUnit<FrequencyUnit> per(TimeUnit time) {
    return VelocityUnit.combine(this, time);
  }

  public <U extends Unit> PerUnit<FrequencyUnit, U> per(U other) {
    return PerUnit.combine(this, other);
  }

  public double convertFrom(double magnitude, FrequencyUnit otherUnit) {
    return fromBaseUnits(otherUnit.toBaseUnits(magnitude));
  }
}