tec.units.ri.spi.US Maven / Gradle / Ivy

Go to download
/**
 *  Unit-API - Units of Measurement API for Java
 *  Copyright (c) 2005-2014, Jean-Marie Dautelle, Werner Keil, V2COM.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of JSR-363 nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package tec.units.ri.spi;

import static tec.units.ri.spi.SI.*;
import static tec.units.ri.spi.SIPrefix.MICRO;
import tec.units.ri.AbstractSystemOfUnits;
import tec.units.ri.AbstractUnit;
import tec.units.ri.function.RationalConverter;
import tec.units.ri.unit.ProductUnit;
import tec.units.ri.unit.TransformedUnit;

import javax.measure.Unit;
import javax.measure.quantity.Angle;
import javax.measure.quantity.Area;
import javax.measure.quantity.Information;
import javax.measure.quantity.Energy;
import javax.measure.quantity.Length;
import javax.measure.quantity.Mass;
import javax.measure.quantity.Power;
import javax.measure.quantity.Temperature;
import javax.measure.quantity.Time;
import javax.measure.quantity.Speed;
import javax.measure.quantity.Volume;
import javax.measure.spi.SystemOfUnits;

/**
 * 
 * This class contains units from the United States customary system.
 * 
 * 
 * 
 * @noextend This class is not intended to be extended by clients.
 * 
 * @author Jean-Marie Dautelle
 * @author Werner Keil
 * @version 1.17, $Date: 2014-04-06 22:44:42 +0200 (So, 06 Apr 2014) $
 * @see Wikipedia:
 *      United State Customary Units
 */
public final class US extends AbstractSystemOfUnits {

	/**
	 * Default constructor (prevents this class from being instantiated).
	 */
	private US() {
	}

	/**
	 * Returns the unique instance of this class.
	 * 
	 * @return the USCustomary instance.
	 */
	public static SystemOfUnits getInstance() {
		return INSTANCE;
	}

	private static final US INSTANCE = new US();

	// //////////
	// Length //
	// //////////
	/**
	 * US name for {@link SI#METRE}.
	 */
	public static final Unit METER = METRE;

	/**
	 * A unit of length equal to 0.3048 m (standard name
	 * ft).
	 */
	public static final Unit FOOT = addUnit(METER.multiply(3048)
			.divide(10000));

	/**
	 * A unit of length equal to 1200/3937 m (standard name
	 * foot_survey_us). See also: foot
	 */
	public static final Unit FOOT_SURVEY = addUnit(METER.multiply(1200)
			.divide(3937));

	/**
	 * A unit of length equal to 0.9144 m (standard name
	 * yd).
	 */
	public static final Unit YARD = addUnit(FOOT.multiply(3));

	/**
	 * A unit of length equal to 0.0254 m (standard name
	 * in).
	 */
	public static final Unit INCH = addUnit(FOOT.divide(12));

	/**
	 * A unit of length equal to 1609.344 m (standard name
	 * mi).
	 */
	public static final Unit MILE = addUnit(METER.multiply(1609344)
			.divide(1000));

	/**
	 * A unit of length equal to the distance that light travels in one year
	 * through a vacuum (standard name ly).
	 */
	public static final Unit LIGHT_YEAR = addUnit(METRE
			.multiply(9.460528405e15));
	
	/**
	 * A unit of length equal to 1852.0 m (standard name
	 * nmi).
	 */
	public static final Unit NAUTICAL_MILE = addUnit(METER
			.multiply(1852));

	// ////////
	// Mass //
	// ////////

	/**
	 * A unit of mass equal to 453.59237 grams (avoirdupois pound,
	 * standard name lb).
	 */
	public static final Unit POUND = addUnit(KILOGRAM.multiply(45359237)
			.divide(100000000)); //, Messages.US_lb_name);

	/**
	 * A unit of mass equal to 1 / 16 {@link #POUND} (standard name
	 * oz).
	 */
	public static final Unit OUNCE = addUnit(POUND.divide(16));

	/**
	 * A unit of mass equal to 2000 {@link #POUND} (short ton,
	 * standard name ton).
	 */
	public static final Unit TON = addUnit(POUND.multiply(2000));

	// ///////////////
	// Temperature //
	// ///////////////

	/**
	 * A unit of temperature equal to 5/9 °K (standard name
	 * °R).
	 */
	public static final Unit RANKINE = addUnit(KELVIN.multiply(5)
			.divide(9));

	/**
	 * A unit of temperature equal to degree Rankine minus
	 * 459.67 °R (standard name °F).
	 * 
	 * @see #RANKINE
	 */
	public static final Unit FAHRENHEIT = addUnit(RANKINE
			.shift(459.67));

	// /////////
	// Angle //
	// /////////

	/**
	 * A unit of angle equal to a full circle or 2π
	 * {@link SI#RADIAN} (standard name rev).
	 */
	public static final Unit REVOLUTION = addUnit(RADIAN.multiply(2)
			.multiply(Math.PI).asType(Angle.class));

	/**
	 * A unit of angle equal to 1/360 {@link #REVOLUTION} (standard
	 * name deg).
	 */
	public static final Unit DEGREE_ANGLE = addUnit(REVOLUTION
			.divide(360));

	/**
	 * A unit of angle equal to 1/60 {@link #DEGREE_ANGLE}
	 * (standard name ').
	 */
	public static final Unit MINUTE_ANGLE = addUnit(DEGREE_ANGLE
			.divide(60));

	/**
	 * A unit of angle equal to 1/60 {@link #MINUTE_ANGLE}
	 * (standard name ").
	 */
	public static final Unit SECOND_ANGLE = addUnit(MINUTE_ANGLE
			.divide(60));

	/**
	 * A unit of angle equal to 0.01 {@link SI#RADIAN} (standard
	 * name centiradian).
	 */
	public static final Unit CENTIRADIAN = addUnit(RADIAN.divide(100));

	/**
	 * A unit of angle measure equal to 1/400 {@link #REVOLUTION}
	 * (standard name grade ).
	 */
	public static final Unit GRADE = addUnit(REVOLUTION.divide(400));
	
	// ////////////
	// TimeUnit //
	// ////////////
	/**
	 * A unit of time equal to 60 s (standard name min
	 * ).
	 */
	public static final Unit MINUTE = addUnit(SECOND.multiply(60));

	/**
	 * A unit of duration equal to 60 {@link #MINUTE} (standard
	 * name h).
	 */
	public static final Unit HOUR = addUnit(MINUTE.multiply(60));

	// ////////////
	// Speed //
	// ////////////
	/**
	 * A unit of velocity expressing the number of {@link #FOOT feet} per
	 * {@link SI#SECOND second}.
	 */
	public static final Unit FEET_PER_SECOND = addUnit(
			FOOT.divide(SECOND)).asType(Speed.class);

	/**
	 * A unit of velocity expressing the number of international {@link #MILE
	 * miles} per {@link #HOUR hour} (abbreviation mph).
	 */
	public static final Unit MILES_PER_HOUR = addUnit(
			MILE.divide(HOUR)).asType(Speed.class);

	/**
	 * A unit of velocity expressing the number of {@link #NAUTICAL_MILE
	 * nautical miles} per {@link #HOUR hour} (abbreviation kn).
	 */
	public static final Unit KNOT = addUnit(
			NAUTICAL_MILE.divide(HOUR)).asType(Speed.class);

	// ////////
	// Area //
	// ////////

	/**
	 * A unit of area (standard name sft
	 * ).
	 */
	public static final Unit SQUARE_FOOT = addUnit(new ProductUnit(
			(AbstractUnit) FOOT.multiply(FOOT)));

	/**
	 * A unit of area equal to 100 m² (standard name a
	 * ).
	 */
	public static final Unit ARE = addUnit(SQUARE_METRE.multiply(100));
	
	/**
	 * A unit of area equal to 100 {@link #ARE} (standard name
	 * ha).
	 */
	public static final Unit HECTARE = addUnit(ARE.multiply(100)); // Exact.
	
	/**
	 * The acre is a unit of area used in the imperial and U.S. customary systems.
	 * It is equivalent to 43,560 square feet. 
	 * An acre is about 40% of a HECTARE – slightly smaller than an American football field. 
	 * (standard name ac
	 * ).
	 * @see http://en.wikipedia.org/wiki/Acre
	 */
	public static final Unit ACRE = addUnit(SQUARE_FOOT.multiply(43560));
	
	// ///////////////
	// Data Amount //
	// ///////////////
	/**
	 * A unit of data amount equal to 8 {@link SI#BIT} (BinarY
	 * TErm, standard name byte).
	 */
	public static final Unit BYTE = addUnit(BIT.multiply(8));

	/**
	 * Equivalent {@link #BYTE}
	 */
	public static final Unit OCTET = BYTE;

	// //////////
	// Energy //
	// //////////

	/**
	 * A unit of energy equal to one electron-volt (standard name
	 * eV, also recognized keV, MeV, GeV).
	 */
	public static final Unit ELECTRON_VOLT = addUnit(JOULE
			.multiply(1.602176462e-19));
	
	// //////////
	// Power   //
	// //////////
	
	/**
	 * Horsepower (HP) is the name of several units of measurement of power.
	 * The most common definitions equal between 735.5 and 750 watts.
	 * Horsepower was originally defined to compare the output of steam engines with the power of draft horses. 
	 * The unit was widely adopted to measure the output of piston engines, turbines, electric motors, and other machinery. The definition of the unit varied between geographical regions. Most countries now use the SI unit watt for measurement of power. With the implementation of the EU Directive 80/181/EEC on January 1, 2010, the use of horsepower in the EU is only permitted as supplementary unit.
	 */
	public static final Unit HORSEPOWER = addUnit(WATT.multiply(735.499));

	// //////////
	// Volume //
	// //////////
	/**
	 * A unit of volume equal to one cubic decimeter (default label
	 * L, also recognized µL, mL, cL, dL).
	 */
    public static final TransformedUnit LITER
        = new TransformedUnit(CUBIC_METRE, new RationalConverter(1, 1000));

	/**
	 * A unit of volume equal to one cubic inch (in³).
	 */
	public static final Unit CUBIC_INCH = addUnit(INCH.pow(3).asType(
			Volume.class));

	/**
	 * A unit of volume equal to one US dry gallon. (standard name
	 * gallon_dry_us).
	 */
	public static final Unit GALLON_DRY = addUnit(CUBIC_INCH.multiply(
			2688025).divide(10000));

	/**
	 * A unit of volume equal to one US gallon, Liquid Unit. The U.S. liquid
	 * gallon is based on the Queen Anne or Wine gallon occupying 231 cubic
	 * inches (standard name gal).
	 */
	public static final Unit GALLON_LIQUID = addUnit(CUBIC_INCH
			.multiply(231));

	/**
	 * A unit of volume equal to 1 / 128 {@link #GALLON_LIQUID}
	 * (standard name oz_fl).
	 */
	public static final Unit OUNCE_LIQUID = addUnit(GALLON_LIQUID
			.divide(128));

	/**
	 * A unit of volume ~ 1 drop or 0.95 grain of water  (standard
	 * name min).
	 */
	public static final Unit MINIM = addUnit(MICRO(LITER).multiply(
			61.61152d));

	/**
	 * A unit of volume equal to 60 {@link #MINIM} (standard name
	 * fl dr).
	 */
	public static final Unit FLUID_DRAM = addUnit(MINIM.multiply(60));

	/**
	 * A unit of volume equal to 80 {@link #MINIM} (standard name
	 * tsp).
	 */
	public static final Unit TEASPOON = addUnit(MINIM.multiply(80));

	/**
	 * A unit of volume equal to 3 {@link #TEASPOON} (standard name
	 * Tbsp).
	 */
	public static final Unit TABLESPOON = addUnit(TEASPOON.multiply(3));

	/**
	 * A unit of volume equal to 238.4810 {@link #LITER} (standard
	 * name bbl).
	 */
	public static final Unit BARREL = addUnit(LITER
			.multiply(238.4810d));

	/**
	 * Holds the international foot: 0.3048 m exact.
	 */
	// private static final int INTERNATIONAL_FOOT_DIVIDEND = 3048;

	// private static final int INTERNATIONAL_FOOT_DIViSOR = 10000;

//    /**
//     * Adds a new unit and maps it to the specified quantity type.
//     *
//     * @param  unit the unit being added.
//     * @param type the quantity type.
//     * @return unit.
//     */
//    private static >  U addUnit(U unit, Class> type) {
//        INSTANCE.units.add(unit);
//        return unit;
//    }
    
//	/**
//	 * Adds a new named unit to the collection.
//	 * 
//	 * @param unit the unit being added.
//	 * @param name the name of the unit.
//	 * @return unit.
//	 */
//	@SuppressWarnings("unchecked")
//	private static > U addUnit(U unit, String name) {
//		if (name != null && unit instanceof Unit) {
//			Unit aUnit = (Unit)unit;
//			//aUnit.setName(name);
//			INSTANCE.units.add(aUnit);
//			return (U) aUnit;
//		}
//		INSTANCE.units.add(unit);
//		return unit;
//	}

	/**
	 * Adds a new unit to the collection.
	 * 
	 * @param unit
	 *            the unit being added.
	 * @return unit.
	 */
	protected static > U addUnit(U unit) {
		INSTANCE.units.add(unit);
		return unit;
	}
	
	@Override
	public String getName() {
		return getClass().getSimpleName();
	}
}