org.djunits.unit

Class LinearUnit<U extends LinearUnit<U>>

java.lang.Object

org.djunits.unit.Unit<U>

org.djunits.unit.LinearUnit<U>

Type Parameters:

U - the linear Unit.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbsoluteLinearUnit, AccelerationUnit, AngleSolidUnit, AreaUnit, DensityUnit, DurationUnit, ElectricalChargeUnit, ElectricalCurrentUnit, ElectricalPotentialUnit, ElectricalResistanceUnit, EnergyUnit, FlowMassUnit, FlowVolumeUnit, ForceUnit, FrequencyUnit, LengthUnit, LinearDensityUnit, MassUnit, MoneyPerAreaUnit, MoneyPerDurationUnit, MoneyPerEnergyUnit, MoneyPerLengthUnit, MoneyPerMassUnit, MoneyPerVolumeUnit, MoneyUnit, PowerUnit, PressureUnit, SpeedUnit, TemperatureUnit, TorqueUnit, VolumeUnit

public abstract class LinearUnit<U extends LinearUnit<U>>
extends Unit<U>

A linear unit with easy-access constructor with a linear factor, and access to the linear factor.
A linear unit is a unit that is linearly related to the SI standard unit. E.g. Mile is linearly related to meter (the SI unit for length). Unlike temperature in degrees Celsius which is not linearly related to the Kelvin (the SI unit for temperature).

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

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Oct 11, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields inherited from class org.djunits.unit.Unit

STANDARD_UNITS

Constructor Summary

Constructors

Modifier	Constructor and Description
	LinearUnit(String name, String abbreviation, UnitSystem unitSystem) Build a user-defined unit with a linear scale and create the fields for that unit.
protected	LinearUnit(String name, String abbreviation, UnitSystem unitSystem, Scale scale) Build a user-defined unit with a specific conversion scale to/from the standard unit.
protected	LinearUnit(String name, String abbreviation, UnitSystem unitSystem, U referenceUnit, double scaleFactorToReferenceUnit) Build a user-defined unit with a linear conversion factor to another unit.
	LinearUnit(String abbreviationKey, UnitSystem unitSystem) Build a standard unit with a linear scale and create the fields for that unit.
protected	LinearUnit(String abbreviationKey, UnitSystem unitSystem, Scale scale) Build a standard unit with a specific conversion scale to/from the standard unit.
protected	LinearUnit(String abbreviationKey, UnitSystem unitSystem, U referenceUnit, double scaleFactorToReferenceUnit) Build a standard unit with a linear conversion factor to another unit.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	equalsIgnoreNaming(Object obj) Test if two units are the same, except for the name and abbreviation.
LinearScale	getScale()
double	getScaleFactor()
int	hashCode()

Methods inherited from class org.djunits.unit.Unit

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LinearUnit

public LinearUnit(String abbreviationKey,
                  UnitSystem unitSystem)

Build a standard unit with a linear scale and create the fields for that unit. For a standard unit, a UnitException is silently ignored.

Parameters:

abbreviationKey - String; the key to the locale file for the abbreviation of the unit

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

LinearUnit

protected LinearUnit(String abbreviationKey,
                     UnitSystem unitSystem,
                     U referenceUnit,
                     double scaleFactorToReferenceUnit)

Build a standard unit with a linear conversion factor to another unit.

Parameters:

abbreviationKey - String; the key to the locale file for the abbreviation of the unit

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

referenceUnit - U; the unit to convert to

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

LinearUnit

protected LinearUnit(String abbreviationKey,
                     UnitSystem unitSystem,
                     Scale scale)

Build a standard unit with a specific conversion scale to/from the standard unit.

Parameters:

abbreviationKey - String; the key to the locale file for the abbreviation of the unit

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

scale - Scale; the conversion scale to use for this unit

LinearUnit

public LinearUnit(String name,
                  String abbreviation,
                  UnitSystem unitSystem)

Build a user-defined unit with a linear scale and create the fields for that unit.

Parameters:

name - String; the name of the unit

abbreviation - String; the abbreviation of the unit

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

LinearUnit

protected LinearUnit(String name,
                     String abbreviation,
                     UnitSystem unitSystem,
                     U referenceUnit,
                     double scaleFactorToReferenceUnit)

Build a user-defined unit with a linear conversion factor to another unit.

Parameters:

name - String; the name of the unit

abbreviation - String; the abbreviation of the unit

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

referenceUnit - U; the unit to convert to

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

LinearUnit

protected LinearUnit(String name,
                     String abbreviation,
                     UnitSystem unitSystem,
                     Scale scale)

Build a user-defined unit with a specific conversion scale to/from the standard unit.

Parameters:

name - String; the name of the unit

abbreviation - String; the abbreviation of the unit

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

scale - Scale; the conversion scale to use for this unit

Method Detail

getScale

public LinearScale getScale()

Overrides:

getScale in class Unit<U extends LinearUnit<U>>

Returns:

the scale to transform between this unit and the reference (e.g., SI) unit.

getScaleFactor

public final double getScaleFactor()

Returns:

the conversion factor to the standard unit (e.g., the SI unit)

hashCode

public int hashCode()

Overrides:

hashCode in class Unit<U extends LinearUnit<U>>

equals

public boolean equals(Object obj)

Overrides:

equals in class Unit<U extends LinearUnit<U>>

equalsIgnoreNaming

public boolean equalsIgnoreNaming(Object obj)

Test if two units are the same, except for the name and abbreviation. This means for instance that for the MassUnits METRIC_TON and MEGAGRAM (both 1000 kg) equals(...) will yield false, but equalsIgnoreNaming will yield true.

Specified by:

equalsIgnoreNaming in class Unit<U extends LinearUnit<U>>

Parameters:

obj - Object; the object to compare with

Returns:

true if the two units are the same numerically, except for the naming and/or abbreviation