org.djunits.unit

Class SIUnit

java.lang.Object

org.djunits.unit.Unit<SIUnit>

org.djunits.unit.SIUnit

All Implemented Interfaces:

Serializable

public class SIUnit
extends Unit<SIUnit>

Helper class to create arbitrary SI units.

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-01-18 00:35:01 +0100 (Fri, 18 Jan 2019) $, @version $Revision: 324 $, by $Author: averbraeck $, initial version Jun 15, 2014

Author:

Alexander Verbraeck

See Also:

Serialized Form

Field Summary

Fields inherited from class org.djunits.unit.Unit

STANDARD_UNITS

Constructor Summary

Constructors

Constructor and Description
SIUnit(String siCoefficientString) Create an arbitrary SI unit based on a coefficient string, such as m3/cd2.
SIUnit(String siCoefficientString, boolean standardUnit) Create an arbitrary SI unit based on a coefficient string, such as m3/cd2.

Method Summary

Modifier and Type	Method and Description
boolean	equalsIgnoreNaming(Object obj) Test if two units are the same, except for the name and abbreviation.
String	getSICoefficientsString()
SIUnit	getStandardUnit()

Methods inherited from class org.djunits.unit.Unit

equals, generateHashCode, getAbbreviation, getAbbreviationKey, getAllUnitsOfThisType, getName, getNameKey, getScale, getSICoefficients, getUnits, getUnitSystem, hashCode, isBaseSIUnit, isLocalizable, lookupOrCreateSIUnitWithSICoefficients, lookupOrCreateUnitWithSICoefficients, lookupUnitWithSICoefficients, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SIUnit

public SIUnit(String siCoefficientString)

Create an arbitrary SI unit based on a coefficient string, such as m3/cd2.

Parameters:

siCoefficientString - String; textual description of the unit.

SIUnit

public SIUnit(String siCoefficientString,
              boolean standardUnit)

Create an arbitrary SI unit based on a coefficient string, such as m3/cd2.

Parameters:

siCoefficientString - String; textual description of the unit.

standardUnit - boolean; if true; the new unit is standard and there should be localization info; if false; localization will not be available

Method Detail

getStandardUnit

public final SIUnit getStandardUnit()

Specified by:

getStandardUnit in class Unit<SIUnit>

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<SIUnit>

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)

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<SIUnit>

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