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-2018 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 nameOrNameKey, String abbreviationOrAbbreviationKey, UnitSystem unitSystem, boolean standardUnit) Build a standard linear unit and create the fields for a unit.
protected	LinearUnit(String nameOrNameKey, String abbreviationOrAbbreviationKey, UnitSystem unitSystem, Scale scale, boolean standardUnit) Build a unit with a specific conversion scale to/from the standard unit.
protected	LinearUnit(String nameOrNameKey, String abbreviationOrAbbreviationKey, UnitSystem unitSystem, U referenceUnit, double scaleFactorToReferenceUnit, boolean standardUnit) Build a 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, getName, getNameKey, getSICoefficients, getSICoefficientsString, getStandardUnit, 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 nameOrNameKey,
                  String abbreviationOrAbbreviationKey,
                  UnitSystem unitSystem,
                  boolean standardUnit)

Build a standard linear unit and create the fields for a unit. If the parameter standardUnit is true, it is a standard unit where name is the nameKey, and abbreviation is the abbreviationKey; if false, this unit is a user-defined unit where the localization files do not have an entry. If standardUnit is true, a UnitException is silently ignored; if standardUnit is false a UnitException is thrown as a RunTimeException.

Parameters:

nameOrNameKey - if standardUnit: the key to the locale file for the long name of the unit, otherwise the name itself

abbreviationOrAbbreviationKey - if standardUnit: the key to the locale file for the abbreviation of the unit, otherwise the abbreviation itself

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

standardUnit - indicates whether it is a standard unit with a definition in the locale, or a user-defined unit

LinearUnit

protected LinearUnit(String nameOrNameKey,
                     String abbreviationOrAbbreviationKey,
                     UnitSystem unitSystem,
                     U referenceUnit,
                     double scaleFactorToReferenceUnit,
                     boolean standardUnit)

Build a unit with a linear conversion factor to another unit. If the parameter standardUnit is true, it is a standard unit where name is the nameKey, and abbreviation is the abbreviationKey; if false, this unit is a user-defined unit where the localization files do not have an entry. If standardUnit is true, a UnitException is silently ignored; if standardUnit is false a UnitException is thrown as a RunTimeException.

Parameters:

nameOrNameKey - if standardUnit: the key to the locale file for the long name of the unit, otherwise the name itself

abbreviationOrAbbreviationKey - if standardUnit: the key to the locale file for the abbreviation of the unit, otherwise the abbreviation itself

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

referenceUnit - the unit to convert to

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

standardUnit - indicates whether it is a standard unit with a definition in the locale, or a user-defined unit

LinearUnit

protected LinearUnit(String nameOrNameKey,
                     String abbreviationOrAbbreviationKey,
                     UnitSystem unitSystem,
                     Scale scale,
                     boolean standardUnit)

Build a unit with a specific conversion scale to/from the standard unit. If the parameter standardUnit is true, it is a standard unit where name is the nameKey, and abbreviation is the abbreviationKey; if false, this unit is a user-defined unit where the localization files do not have an entry. If standardUnit is true, a UnitException is silently ignored; if standardUnit is false a UnitException is thrown as a RunTimeException.

Parameters:

nameOrNameKey - if standardUnit: the key to the locale file for the long name of the unit, otherwise the name itself

abbreviationOrAbbreviationKey - if standardUnit: the key to the locale file for the abbreviation of the unit, otherwise the abbreviation itself

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

scale - the conversion scale to use for this unit

standardUnit - indicates whether it is a standard unit with a definition in the locale, or a user-defined 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 - the object to compare with

Returns:

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