VelocityUnit.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 org.wpilib.units.measure.Velocity;

public final class VelocityUnit<D extends Unit> extends PerUnit<D, TimeUnit> {
  @SuppressWarnings("rawtypes")
  private static final CombinatoryUnitCache<Unit, TimeUnit, VelocityUnit> cache =
      new CombinatoryUnitCache<>(VelocityUnit::new);
 
  @SuppressWarnings("unchecked")
  VelocityUnit(D numerator, TimeUnit denominator) {
    super(
        numerator.isBaseUnit() && denominator.isBaseUnit()
            ? null
            : combine((D) numerator.getBaseUnit(), denominator.getBaseUnit()),
        numerator,
        denominator);
  }
 
  VelocityUnit(
      VelocityUnit<D> baseUnit,
      UnaryFunction toBaseConverter,
      UnaryFunction fromBaseConverter,
      String name,
      String symbol) {
    super(baseUnit, toBaseConverter, fromBaseConverter, name, symbol);
  }

  @SuppressWarnings("unchecked")
  public static <D extends Unit> VelocityUnit<D> combine(D unit, TimeUnit period) {
    return cache.combine(unit, period);
  }
 
  @Override
  public VelocityUnit<D> getBaseUnit() {
    return (VelocityUnit<D>) super.getBaseUnit();
  }

  public D getUnit() {
    return numerator();
  }

  public TimeUnit getPeriod() {
    return denominator();
  }
 
  @Override
  public Velocity<D> of(double magnitude) {
    return new Velocity<>(magnitude, toBaseUnits(magnitude), this);
  }
 
  @Override
  public Velocity<D> ofBaseUnits(double baseUnitMagnitude) {
    return new Velocity<>(fromBaseUnits(baseUnitMagnitude), baseUnitMagnitude, this);
  }
 
  @Override
  @SuppressWarnings("unchecked")
  public Velocity<D> zero() {
    return (Velocity<D>) super.zero();
  }
 
  @Override
  @SuppressWarnings("unchecked")
  public Velocity<D> one() {
    return (Velocity<D>) super.one();
  }

  @Override
  public AccelerationUnit<D> per(TimeUnit period) {
    return AccelerationUnit.combine(this, period);
  }

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

  public double convertFrom(double magnitude, VelocityUnit<? extends D> otherUnit) {
    return fromBaseUnits(otherUnit.toBaseUnits(magnitude));
  }
}