tec.units.ri.quantity

Class QuantityDimension

java.lang.Object

tec.units.ri.quantity.QuantityDimension

All Implemented Interfaces:

javax.measure.Dimension

public final class QuantityDimension
extends Object
implements javax.measure.Dimension

This class represents a quantity dimension (dimension of a physical quantity).

The dimension associated to any given quantity are given by the published DimensionService instances. For convenience, a static method {@link QuantityDimension#getInstance(Class) aggregating the results of all

Version:

0.7, $Date: 2016-06-21 $

Author:

Jean-Marie Dautelle, Werner Keil

Field Summary

Fields

Modifier and Type	Field and Description
static javax.measure.Dimension	AMOUNT_OF_SUBSTANCE Holds amount of substance dimension (N).
static javax.measure.Dimension	ELECTRIC_CURRENT Holds electric current dimension (I).
static javax.measure.Dimension	LENGTH Holds length dimension (L).
static javax.measure.Dimension	LUMINOUS_INTENSITY Holds luminous intensity dimension (J).
static javax.measure.Dimension	MASS Holds mass dimension (M).
static javax.measure.Dimension	NONE Holds dimensionless.
static javax.measure.Dimension	TEMPERATURE Holds temperature dimension (Θ).
static javax.measure.Dimension	TIME Holds time dimension (T).

Method Summary

Methods

Modifier and Type	Method and Description
javax.measure.Dimension	divide(javax.measure.Dimension that) Returns the quotient of this dimension with the one specified.
QuantityDimension	divide(QuantityDimension that) Returns the quotient of this dimension with the one specified.
boolean	equals(Object obj)
Map<? extends QuantityDimension,Integer>	getBaseDimensions() Returns the fundamental dimensions and their exponent whose product is this dimension or null if this dimension is a fundamental dimension.
static QuantityDimension	getInstance(char symbol) Returns the dimension for the specified symbol.
static <Q extends javax.measure.Quantity<Q>> javax.measure.Dimension	getInstance(Class<Q> quantityType) Returns the dimension for the specified quantity type by aggregating the results of DimensionService or null if the specified quantity is unknown.
int	hashCode()
javax.measure.Dimension	multiply(javax.measure.Dimension that) Returns the product of this dimension with the one specified.
QuantityDimension	multiply(QuantityDimension that) Returns the product of this dimension with the one specified.
QuantityDimension	pow(int n) Returns this dimension raised to an exponent.
QuantityDimension	root(int n) Returns the given root of this dimension.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final javax.measure.Dimension NONE

Holds dimensionless.

LENGTH

public static final javax.measure.Dimension LENGTH

Holds length dimension (L).

MASS

public static final javax.measure.Dimension MASS

Holds mass dimension (M).

TIME

public static final javax.measure.Dimension TIME

Holds time dimension (T).

ELECTRIC_CURRENT

public static final javax.measure.Dimension ELECTRIC_CURRENT

Holds electric current dimension (I).

TEMPERATURE

public static final javax.measure.Dimension TEMPERATURE

Holds temperature dimension (Θ).

AMOUNT_OF_SUBSTANCE

public static final javax.measure.Dimension AMOUNT_OF_SUBSTANCE

Holds amount of substance dimension (N).

LUMINOUS_INTENSITY

public static final javax.measure.Dimension LUMINOUS_INTENSITY

Holds luminous intensity dimension (J).

Method Detail

getInstance

public static <Q extends javax.measure.Quantity<Q>> javax.measure.Dimension getInstance(Class<Q> quantityType)

Returns the dimension for the specified quantity type by aggregating the results of DimensionService or null if the specified quantity is unknown.

Parameters:

quantityType - the quantity type.

Returns:

the dimension for the quantity type or null.

getInstance

public static QuantityDimension getInstance(char symbol)

Returns the dimension for the specified symbol.

Parameters:

sambol - the quantity symbol.

Returns:

the dimension for the given symbol.

multiply

public javax.measure.Dimension multiply(javax.measure.Dimension that)

Returns the product of this dimension with the one specified. If the specified dimension is not a physics dimension, then that.multiply(this) is returned.

Specified by:

multiply in interface javax.measure.Dimension

Parameters:

that - the dimension multiplicand.

Returns:

this * that

multiply

public QuantityDimension multiply(QuantityDimension that)

Returns the product of this dimension with the one specified.

Parameters:

that - the dimension multiplicand.

Returns:

this * that

divide

public javax.measure.Dimension divide(javax.measure.Dimension that)

Returns the quotient of this dimension with the one specified.

Specified by:

divide in interface javax.measure.Dimension

Parameters:

that - the dimension divisor.

Returns:

this.multiply(that.pow(-1))

divide

public QuantityDimension divide(QuantityDimension that)

Returns the quotient of this dimension with the one specified.

Parameters:

that - the dimension divisor.

Returns:

this.multiply(that.pow(-1))

pow

public final QuantityDimension pow(int n)

Returns this dimension raised to an exponent.

Specified by:

pow in interface javax.measure.Dimension

Parameters:

n - the exponent.

Returns:

the result of raising this dimension to the exponent.

root

public final QuantityDimension root(int n)

Returns the given root of this dimension.

Specified by:

root in interface javax.measure.Dimension

Parameters:

n - the root's order.

Returns:

the result of taking the given root of this dimension.

Throws:

ArithmeticException - if n == 0.

getBaseDimensions

public Map<? extends QuantityDimension,Integer> getBaseDimensions()

Returns the fundamental dimensions and their exponent whose product is this dimension or null if this dimension is a fundamental dimension.

Specified by:

getBaseDimensions in interface javax.measure.Dimension

Returns:

the mapping between the fundamental dimensions and their exponent.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object