ForceUnit.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.Force;

public final class ForceUnit extends MultUnit<MassUnit, LinearAccelerationUnit> {
  private static final CombinatoryUnitCache<MassUnit, LinearAccelerationUnit, ForceUnit> cache =
      new CombinatoryUnitCache<>(ForceUnit::new);
 
  ForceUnit(MassUnit mass, LinearAccelerationUnit acceleration) {
    super(
        mass.isBaseUnit() && acceleration.isBaseUnit()
            ? null
            : combine(mass.getBaseUnit(), acceleration.getBaseUnit()),
        mass,
        acceleration);
  }
 
  ForceUnit(
      ForceUnit baseUnit,
      UnaryFunction toBaseConverter,
      UnaryFunction fromBaseConverter,
      String name,
      String symbol) {
    super(baseUnit, toBaseConverter, fromBaseConverter, name, symbol);
  }

  public static ForceUnit combine(MassUnit mass, LinearAccelerationUnit acceleration) {
    return cache.combine(mass, acceleration);
  }
 
  @Override
  public ForceUnit getBaseUnit() {
    return (ForceUnit) super.getBaseUnit();
  }

  public TorqueUnit multAsTorque(DistanceUnit distance) {
    return TorqueUnit.combine(distance, this);
  }
 
  // TODO: Add a multAsEnergy equivalent
 
  @Override
  public Force of(double magnitude) {
    return new Force(magnitude, toBaseUnits(magnitude), this);
  }
 
  @Override
  public Force ofBaseUnits(double baseUnitMagnitude) {
    return new Force(toBaseUnits(baseUnitMagnitude), baseUnitMagnitude, this);
  }
 
  @Override
  public Force zero() {
    return (Force) super.zero();
  }
 
  @Override
  public Force one() {
    return (Force) super.one();
  }
 
  @Override
  public VelocityUnit<ForceUnit> per(TimeUnit time) {
    return VelocityUnit.combine(this, time);
  }

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

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