org.djunits.unit

Class SICoefficients

java.lang.Object

org.djunits.unit.SICoefficients

public class SICoefficients
extends Object

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

$LastChangedDate: 2018-01-28 03:17:44 +0100 (Sun, 28 Jan 2018) $, @version $Revision: 256 $, by $Author: averbraeck $, initial version Jun 15, 2014

Author:

Alexander Verbraeck

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SICoefficients(EnumMap<SI,Integer> coefficients) Construct an instance of SICoefficients.

Method Summary

Modifier and Type	Method and Description
static SICoefficients	divide(SICoefficients a, SICoefficients b)
protected static String	enumMapToString(EnumMap<SI,Integer> map) Convert an enumMap of coefficient to the normalized string representation.
EnumMap<SI,Integer>	getCoefficientsMap()
static SICoefficients	multiply(SICoefficients a, SICoefficients b)
static String	normalize(String coefficientString) Convert a coefficient string to standard format.
static EnumMap<SI,Integer>	parse(String coefficientString)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SICoefficients

protected SICoefficients(EnumMap<SI,Integer> coefficients)

Construct an instance of SICoefficients.

Parameters:

coefficients - the map with SI base units and corresponding coefficients

Method Detail

toString

public final String toString()

Overrides:

toString in class Object

enumMapToString

protected static String enumMapToString(EnumMap<SI,Integer> map)

Convert an enumMap of coefficient to the normalized string representation.

Parameters:

map - EnumMap<SI, Integer>; the EnumMap

Returns:

String

getCoefficientsMap

public final EnumMap<SI,Integer> getCoefficientsMap()

Returns:

coefficientsMap

normalize

public static String normalize(String coefficientString)
                        throws UnitException

Convert a coefficient string to standard format.

Parameters:

coefficientString - String; the string to convert

Returns:

String; the normalized coefficient string

Throws:

UnitException - when the coefficientString could not be parsed

parse

public static EnumMap<SI,Integer> parse(String coefficientString)
                                 throws UnitException

Parameters:

coefficientString - such as kgm/s2 or kg-2m^3/s2A or Kmmol3/Askcd4 or mol.
The grammar of a coefficientString is:

coefficientString	::=	<empty> | [ 1 | powerString ] | [ '1 /' powerString ]
powerString	::=	unitName [ [ ^ ] integer ] [ [ dotOrSlash ] powerString ]
dotOrSlash	::=	. | /
unitName	::=	kg | m | s | A | K | cd | mol

White space can appear anywhere in a coefficientString.
If "integer" does not fit in an Integer, the resulting coefficient will be very wrong.

Returns:

an instance of SICoefficients

Throws:

UnitException - if the coefficientString is not parsable.

multiply

public static SICoefficients multiply(SICoefficients a,
                                      SICoefficients b)

Parameters:

a - the first set of coefficients

b - the second set of coefficients

Returns:

the coefficients of a*b (coefficients are added)

divide

public static SICoefficients divide(SICoefficients a,
                                    SICoefficients b)

Parameters:

a - the first set of coefficients

b - the second set of coefficients

Returns:

the coefficients of a/b (coefficients are subtracted)