org.djunits.unit

Class AreaUnit

java.lang.Object

org.djunits.unit.Unit<U>

org.djunits.unit.LinearUnit<AreaUnit>

org.djunits.unit.AreaUnit

All Implemented Interfaces:

Serializable

public class AreaUnit
extends LinearUnit<AreaUnit>

AreaUnit defines a number of common units for areas.

Copyright (c) 2015-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2019-03-02 19:06:46 +0100 (Sat, 02 Mar 2019) $, @version $Revision: 342 $, by $Author: averbraeck $, initial version May 15, 2014

Author:

Alexander Verbraeck

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static AreaUnit	ACRE acre (international).
static AreaUnit	ARE are.
static AreaUnit	CENTIARE centiare.
static AreaUnit	HECTARE hectare.
static AreaUnit	SI The SI unit for area is m^2.
static AreaUnit	SQUARE_ATTOMETER am^2.
static AreaUnit	SQUARE_CENTIMETER cm^2.
static AreaUnit	SQUARE_DECIMETER dm^2.
static AreaUnit	SQUARE_DEKAMETER dam^2.
static AreaUnit	SQUARE_FEMTOMETER fm^2.
static AreaUnit	SQUARE_FOOT ft^2.
static AreaUnit	SQUARE_HECTOMETER hm^2.
static AreaUnit	SQUARE_INCH in^2.
static AreaUnit	SQUARE_KILOMETER km^2.
static AreaUnit	SQUARE_MEGAMETER Mm^2.
static AreaUnit	SQUARE_METER m^2.
static AreaUnit	SQUARE_MICROMETER µm^2.
static AreaUnit	SQUARE_MILE mile^2.
static AreaUnit	SQUARE_MILLIMETER mm^2.
static AreaUnit	SQUARE_NANOMETER nm^2.
static AreaUnit	SQUARE_NAUTICAL_MILE Nautical mile^2.
static AreaUnit	SQUARE_PICOMETER pm^2.
static AreaUnit	SQUARE_YARD yd^2.

Fields inherited from class org.djunits.unit.Unit

STANDARD_UNITS

Constructor Summary

Constructors

Constructor and Description
AreaUnit(LengthUnit lengthUnit, String name, String abbreviation, UnitSystem unitSystem) Create a user-defined area unit based on length.
AreaUnit(String name, String abbreviation, UnitSystem unitSystem, AreaUnit referenceUnit, double scaleFactorToReferenceUnit) Build a user-defined unit with a conversion factor to another unit, e.g.

Method Summary

Modifier and Type	Method and Description
LengthUnit	getLengthUnit()
String	getSICoefficientsString()
AreaUnit	getStandardUnit()

Methods inherited from class org.djunits.unit.LinearUnit

equals, equalsIgnoreNaming, getScale, getScaleFactor, hashCode

Methods inherited from class org.djunits.unit.Unit

generateHashCode, getAbbreviation, getAbbreviationKey, getAllUnitsOfThisType, getDefaultLocaleAbbreviation, getDefaultLocaleName, getDefaultLocaleTextualRepresentation, getDefaultLocaleTextualRepresentations, getDefaultTextualRepresentation, getName, getSICoefficients, getTextualRepresentations, getUnits, getUnitSystem, isBaseSIUnit, isLocalizable, lookupOrCreateSIUnitWithSICoefficients, lookupOrCreateUnitWithSICoefficients, lookupUnitWithSICoefficients, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SI

public static final AreaUnit SI

The SI unit for area is m^2.

SQUARE_ATTOMETER

public static final AreaUnit SQUARE_ATTOMETER

am^2.

SQUARE_FEMTOMETER

public static final AreaUnit SQUARE_FEMTOMETER

fm^2.

SQUARE_PICOMETER

public static final AreaUnit SQUARE_PICOMETER

pm^2.

SQUARE_NANOMETER

public static final AreaUnit SQUARE_NANOMETER

nm^2.

SQUARE_MICROMETER

public static final AreaUnit SQUARE_MICROMETER

µm^2.

SQUARE_MILLIMETER

public static final AreaUnit SQUARE_MILLIMETER

mm^2.

SQUARE_METER

public static final AreaUnit SQUARE_METER

m^2.

SQUARE_CENTIMETER

public static final AreaUnit SQUARE_CENTIMETER

cm^2.

SQUARE_DECIMETER

public static final AreaUnit SQUARE_DECIMETER

dm^2.

SQUARE_DEKAMETER

public static final AreaUnit SQUARE_DEKAMETER

dam^2.

SQUARE_HECTOMETER

public static final AreaUnit SQUARE_HECTOMETER

hm^2.

SQUARE_KILOMETER

public static final AreaUnit SQUARE_KILOMETER

km^2.

SQUARE_MEGAMETER

public static final AreaUnit SQUARE_MEGAMETER

Mm^2.

CENTIARE

public static final AreaUnit CENTIARE

centiare.

ARE

public static final AreaUnit ARE

are.

HECTARE

public static final AreaUnit HECTARE

hectare.

SQUARE_MILE

public static final AreaUnit SQUARE_MILE

mile^2.

SQUARE_NAUTICAL_MILE

public static final AreaUnit SQUARE_NAUTICAL_MILE

Nautical mile^2.

SQUARE_FOOT

public static final AreaUnit SQUARE_FOOT

ft^2.

SQUARE_INCH

public static final AreaUnit SQUARE_INCH

in^2.

SQUARE_YARD

public static final AreaUnit SQUARE_YARD

yd^2.

ACRE

public static final AreaUnit ACRE

acre (international).

Constructor Detail

AreaUnit

public AreaUnit(LengthUnit lengthUnit,
                String name,
                String abbreviation,
                UnitSystem unitSystem)

Create a user-defined area unit based on length.

Parameters:

lengthUnit - LengthUnit; the unit of length for the area unit, e.g., meter

name - String; the long name of the unit

abbreviation - String; the abbreviation of the unit

unitSystem - UnitSystem; the unit system, e.g. SI or Imperial

AreaUnit

public AreaUnit(String name,
                String abbreviation,
                UnitSystem unitSystem,
                AreaUnit referenceUnit,
                double scaleFactorToReferenceUnit)

Build a user-defined unit with a conversion factor to another unit, e.g. an are is 100 m^2.

Parameters:

name - String; the long name of the unit

abbreviation - String; the abbreviation of the unit

unitSystem - UnitSystem; the unit system, e.g. SI or Imperial

referenceUnit - AreaUnit; the unit to convert to

scaleFactorToReferenceUnit - double; multiply a value in this unit by the factor to convert to the given reference unit

Method Detail

getLengthUnit

public final LengthUnit getLengthUnit()

Returns:

lengthUnit

getStandardUnit

public final AreaUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<AreaUnit>

Returns:

the SI standard unit for this unit, or the de facto standard unit if SI is not available

getSICoefficientsString

public final String getSICoefficientsString()

Specified by:

getSICoefficientsString in class Unit<AreaUnit>

Returns:

the SI standard coefficients for this unit, e.g., kgm/s2 or m-2s2A or m^-2.s^2.A or m^-2s^2A (not necessarily normalized)