VolumeUnit.java
package org.djunits.unit;
import static org.djunits.unit.unitsystem.UnitSystem.IMPERIAL;
import static org.djunits.unit.unitsystem.UnitSystem.SI_ACCEPTED;
import static org.djunits.unit.unitsystem.UnitSystem.SI_DERIVED;
import static org.djunits.unit.unitsystem.UnitSystem.US_CUSTOMARY;
import org.djunits.unit.unitsystem.UnitSystem;
/**
* VolumeUnit defines a number of common units for volumes.
* <p>
* Copyright (c) 2015-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
* BSD-style license. See <a href="http://djunits.org/docs/license.html">DJUNITS License</a>.
* <p>
* $LastChangedDate: 2018-01-28 03:17:44 +0100 (Sun, 28 Jan 2018) $, @version $Revision: 256 $, by $Author: averbraeck $,
* initial version May 15, 2014 <br>
* @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
*/
public class VolumeUnit extends LinearUnit<VolumeUnit>
{
/** */
private static final long serialVersionUID = 20140604L;
/** The unit of length for the volume unit, e.g., meter. */
private final LengthUnit lengthUnit;
/** The SI unit for volume is m^3. */
public static final VolumeUnit SI;
/** am^3. */
public static final VolumeUnit CUBIC_ATTOMETER;
/** fm^3. */
public static final VolumeUnit CUBIC_FEMTOMETER;
/** pm^3. */
public static final VolumeUnit CUBIC_PICOMETER;
/** nm^3. */
public static final VolumeUnit CUBIC_NANOMETER;
/** µm^3. */
public static final VolumeUnit CUBIC_MICROMETER;
/** mm^3. */
public static final VolumeUnit CUBIC_MILLIMETER;
/** cm^3. */
public static final VolumeUnit CUBIC_CENTIMETER;
/** dm^3. */
public static final VolumeUnit CUBIC_DECIMETER;
/** m^3. */
public static final VolumeUnit CUBIC_METER;
/** dam^3. */
public static final VolumeUnit CUBIC_DEKAMETER;
/** hm^3. */
public static final VolumeUnit CUBIC_HECTOMETER;
/** km^3. */
public static final VolumeUnit CUBIC_KILOMETER;
/** Mm^3. */
public static final VolumeUnit CUBIC_MEGAMETER;
/** liter. */
public static final VolumeUnit LITER;
/** mile^3. */
public static final VolumeUnit CUBIC_MILE;
/** ft^3. */
public static final VolumeUnit CUBIC_FOOT;
/** in^3. */
public static final VolumeUnit CUBIC_INCH;
/** yd^3. */
public static final VolumeUnit CUBIC_YARD;
/** gallon (US), fluids. */
public static final VolumeUnit GALLON_US_FLUID;
/** gallon (imperial). */
public static final VolumeUnit GALLON_IMP;
/** ounce (fluid US). */
public static final VolumeUnit OUNCE_US_FLUID;
/** ounce (fluid imperial). */
public static final VolumeUnit OUNCE_IMP_FLUID;
/** pint (fluid US). */
public static final VolumeUnit PINT_US_FLUID;
/** pint (imperial). */
public static final VolumeUnit PINT_IMP;
/** quart (fluid US). */
public static final VolumeUnit QUART_US_FLUID;
/** quart (imperial). */
public static final VolumeUnit QUART_IMP;
/** Cubic lightyear. */
public static final VolumeUnit CUBIC_LIGHTYEAR;
/** Cubic Parsec. */
public static final VolumeUnit CUBIC_PARSEC;
static
{
SI = new VolumeUnit(LengthUnit.METER, "VolumeUnit.cubic_meter", "VolumeUnit.m^3", SI_DERIVED, true);
CUBIC_METER = SI;
CUBIC_ATTOMETER =
new VolumeUnit(LengthUnit.ATTOMETER, "VolumeUnit.cubic_attometer", "VolumeUnit.am^3", SI_DERIVED, true);
CUBIC_FEMTOMETER =
new VolumeUnit(LengthUnit.FEMTOMETER, "VolumeUnit.cubic_femtometer", "VolumeUnit.fm^3", SI_DERIVED, true);
CUBIC_PICOMETER =
new VolumeUnit(LengthUnit.PICOMETER, "VolumeUnit.cubic_picometer", "VolumeUnit.pm^3", SI_DERIVED, true);
CUBIC_NANOMETER =
new VolumeUnit(LengthUnit.NANOMETER, "VolumeUnit.cubic_nanometer", "VolumeUnit.nm^3", SI_DERIVED, true);
CUBIC_MICROMETER =
new VolumeUnit(LengthUnit.MICROMETER, "VolumeUnit.cubic_micrometer", "VolumeUnit.mum^3", SI_DERIVED, true);
CUBIC_MILLIMETER =
new VolumeUnit(LengthUnit.MILLIMETER, "VolumeUnit.cubic_millimeter", "VolumeUnit.mm^3", SI_DERIVED, true);
CUBIC_CENTIMETER =
new VolumeUnit(LengthUnit.CENTIMETER, "VolumeUnit.cubic_centimeter", "VolumeUnit.cm^3", SI_DERIVED, true);
CUBIC_DECIMETER =
new VolumeUnit(LengthUnit.DECIMETER, "VolumeUnit.cubic_decimeter", "VolumeUnit.dm^3", SI_DERIVED, true);
CUBIC_DEKAMETER =
new VolumeUnit(LengthUnit.DEKAMETER, "VolumeUnit.cubic_dekameter", "VolumeUnit.dam^3", SI_DERIVED, true);
CUBIC_HECTOMETER =
new VolumeUnit(LengthUnit.HECTOMETER, "VolumeUnit.cubic_hectometer", "VolumeUnit.hm^3", SI_DERIVED, true);
CUBIC_KILOMETER =
new VolumeUnit(LengthUnit.KILOMETER, "VolumeUnit.cubic_kilometer", "VolumeUnit.km^3", SI_DERIVED, true);
CUBIC_MEGAMETER =
new VolumeUnit(LengthUnit.MEGAMETER, "VolumeUnit.cubic_megameter", "VolumeUnit.Mm^3", SI_DERIVED, true);
LITER = new VolumeUnit("VolumeUnit.liter", "VolumeUnit.L", SI_ACCEPTED, CUBIC_DECIMETER, 1.0, true);
CUBIC_MILE = new VolumeUnit(LengthUnit.MILE, "VolumeUnit.cubic_mile", "VolumeUnit.mi^3", IMPERIAL, true);
CUBIC_FOOT = new VolumeUnit(LengthUnit.FOOT, "VolumeUnit.cubic_foot", "VolumeUnit.ft^3", IMPERIAL, true);
CUBIC_INCH = new VolumeUnit(LengthUnit.INCH, "VolumeUnit.cubic_inch", "VolumeUnit.in^3", IMPERIAL, true);
CUBIC_YARD = new VolumeUnit(LengthUnit.YARD, "VolumeUnit.cubic_yard", "VolumeUnit.yd^3", IMPERIAL, true);
GALLON_US_FLUID = new VolumeUnit("VolumeUnit.gallon_(US)", "VolumeUnit.gal(US)", US_CUSTOMARY, CUBIC_INCH, 231.0, true);
GALLON_IMP = new VolumeUnit("VolumeUnit.gallon_(imp)", "VolumeUnit.gal(imp)", IMPERIAL, LITER, 4.5409, true);
OUNCE_US_FLUID = new VolumeUnit("VolumeUnit.ounce_(fluid_US)", "VolumeUnit.US_fl_oz", US_CUSTOMARY, GALLON_US_FLUID,
1.0 / 128.0, true);
OUNCE_IMP_FLUID = new VolumeUnit("VolumeUnit.ounce_(fluid_imperial)", "VolumeUnit.fl_oz_(imp)", IMPERIAL, GALLON_IMP,
1.0 / 160.0, true);
PINT_US_FLUID = new VolumeUnit("VolumeUnit.pint_(US_fluid)", "VolumeUnit.pt(US_fl)", US_CUSTOMARY, GALLON_US_FLUID,
1.0 / 8.0, true);
PINT_IMP = new VolumeUnit("VolumeUnit.pint_(imperial)", "VolumeUnit.pt_(imp)", IMPERIAL, GALLON_IMP, 1.0 / 8.0, true);
QUART_US_FLUID = new VolumeUnit("VolumeUnit.quart_(US_fluid)", "VolumeUnit.qt(US_fl)", US_CUSTOMARY, GALLON_US_FLUID,
1.0 / 4.0, true);
QUART_IMP = new VolumeUnit("VolumeUnit.quart_(imperial)", "VolumeUnit.qt_(imp)", IMPERIAL, GALLON_IMP, 1.0 / 4.0, true);
CUBIC_LIGHTYEAR =
new VolumeUnit(LengthUnit.LIGHTYEAR, "VolumeUnit.cubic_lightyear", "VolumeUnit.ly^3", SI_DERIVED, true);
CUBIC_PARSEC = new VolumeUnit(LengthUnit.PARSEC, "VolumeUnit.cubic_parsec", "VolumeUnit.pc^3", SI_DERIVED, true);
}
/**
* Define volume unit based on length, e.g. a m^3 is based on meters.
* @param lengthUnit the unit of length for the speed unit, e.g., meter
* @param nameOrNameKey if standardUnit: the key to the locale file for the long name of the unit, otherwise the name itself
* @param abbreviationOrAbbreviationKey if standardUnit: the key to the locale file for the abbreviation of the unit,
* otherwise the abbreviation itself
* @param unitSystem the unit system, e.g. SI or Imperial
* @param standardUnit indicates whether it is a standard unit with a definition in the locale, or a user-defined unit
*/
private VolumeUnit(final LengthUnit lengthUnit, final String nameOrNameKey, final String abbreviationOrAbbreviationKey,
final UnitSystem unitSystem, final boolean standardUnit)
{
super(nameOrNameKey, abbreviationOrAbbreviationKey, unitSystem, CUBIC_METER, Math.pow(lengthUnit.getScaleFactor(), 3),
standardUnit);
this.lengthUnit = lengthUnit;
}
/**
* Define a user-defined volume unit based on length, e.g. a m^3 is based on meters.
* @param lengthUnit the unit of length for the speed unit, e.g., meter
* @param name the long name of the unit
* @param abbreviation the abbreviation of the unit
* @param unitSystem the unit system, e.g. SI or Imperial
*/
public VolumeUnit(final LengthUnit lengthUnit, final String name, final String abbreviation, final UnitSystem unitSystem)
{
this(lengthUnit, name, abbreviation, unitSystem, false);
}
/**
* This constructor constructs a uVolumeUnitnit out of another defined VolumeUnit, e.g. quart is 0.25 gallon.
* @param nameOrNameKey if standardUnit: the key to the locale file for the long name of the unit, otherwise the name itself
* @param abbreviationOrAbbreviationKey if standardUnit: the key to the locale file for the abbreviation of the unit,
* otherwise the abbreviation itself
* @param unitSystem the unit system, e.g. SI or Imperial
* @param referenceUnit the unit to convert to
* @param scaleFactorToReferenceUnit multiply a value in this unit by the factor to convert to the given reference unit
* @param standardUnit indicates whether it is a standard unit with a definition in the locale, or a user-defined unit
*/
private VolumeUnit(final String nameOrNameKey, final String abbreviationOrAbbreviationKey, final UnitSystem unitSystem,
final VolumeUnit referenceUnit, final double scaleFactorToReferenceUnit, final boolean standardUnit)
{
super(nameOrNameKey, abbreviationOrAbbreviationKey, unitSystem, referenceUnit, scaleFactorToReferenceUnit,
standardUnit);
this.lengthUnit = referenceUnit.getLengthUnit();
}
/**
* Build a user-defined VolumeUnit with a conversion factor to another VolumeUnit, e.g. quart is 0.25 gallon.
* @param name the long name of the unit
* @param abbreviation the abbreviation of the unit
* @param unitSystem the unit system, e.g. SI or Imperial
* @param referenceUnit the unit to convert to
* @param scaleFactorToReferenceUnit multiply a value in this unit by the factor to convert to the given reference unit
*/
public VolumeUnit(final String name, final String abbreviation, final UnitSystem unitSystem, final VolumeUnit referenceUnit,
final double scaleFactorToReferenceUnit)
{
this(name, abbreviation, unitSystem, referenceUnit, scaleFactorToReferenceUnit, false);
}
/**
* @return lengthUnit
*/
public final LengthUnit getLengthUnit()
{
return this.lengthUnit;
}
/** {@inheritDoc} */
@Override
public final VolumeUnit getStandardUnit()
{
return CUBIC_METER;
}
/** {@inheritDoc} */
@Override
public final String getSICoefficientsString()
{
return "m3";
}
}