manifold.science.measures

Enum CommonDimensionlessUnit

java.lang.Object

java.lang.Enum<CommonDimensionlessUnit>

manifold.science.measures.CommonDimensionlessUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CommonDimensionlessUnit>, DimensionlessUnit

public enum CommonDimensionlessUnit
extends java.lang.Enum<CommonDimensionlessUnit>
implements DimensionlessUnit

Enum Constant Summary

Enum Constants

Enum Constant and Description
kA Fine-structure constant, the coupling constant for the electromagnetic force.
mol The mole is a unit which measures the number of particles in a substance.
phi Phi is the ratio: A/B = B/C where A = B + C
pi Pi is the ratio: Circumference/Diameter.

Method Summary

Modifier and Type	Method and Description
Rational	getAmount()
java.lang.String	getUnitName()
java.lang.String	getUnitSymbol()
static CommonDimensionlessUnit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CommonDimensionlessUnit[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

emptyArray, getClass, jailbreak, notify, notifyAll, wait, wait, wait

Methods inherited from interface manifold.science.measures.DimensionlessUnit

postfixBind, postfixBind, postfixBind, postfixBind, postfixBind, postfixBind, postfixBind, postfixBind

Enum Constant Detail

pi

public static final CommonDimensionlessUnit pi

Pi is the ratio: Circumference/Diameter.

phi

public static final CommonDimensionlessUnit phi

Phi is the ratio: A/B = B/C where A = B + C

kA

public static final CommonDimensionlessUnit kA

Fine-structure constant, the coupling constant for the electromagnetic force.

mol

public static final CommonDimensionlessUnit mol

The mole is a unit which measures the number of particles in a substance.

Method Detail

values

public static CommonDimensionlessUnit[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CommonDimensionlessUnit c : CommonDimensionlessUnit.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CommonDimensionlessUnit valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getAmount

public Rational getAmount()

Specified by:

getAmount in interface DimensionlessUnit

getUnitName

public java.lang.String getUnitName()

Specified by:

getUnitName in interface DimensionlessUnit

getUnitSymbol

public java.lang.String getUnitSymbol()

Specified by:

getUnitSymbol in interface DimensionlessUnit