ptolemy.data.ontologies.lattice.unit

Enum SIUnitPrefixes

java.lang.Object

java.lang.Enum<SIUnitPrefixes>

ptolemy.data.ontologies.lattice.unit.SIUnitPrefixes

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SIUnitPrefixes>

public enum SIUnitPrefixes
extends java.lang.Enum<SIUnitPrefixes>

An enumeration class that specifies all the valid prefixes (e.g, kilo-, centi-, milli-) for SI units.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Charles Shelton

Pt.AcceptedRating:

Red (cshelton)

Pt.ProposedRating:

Red (cshelton)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATTO
CENTI
DECI
DEKA
EXA
FEMTO
GIGA
HECTO
KILO
MEGA
MICRO
MILLI
NANO
PETA
PICO
TERA
YOCTO
YOTTA
ZEPTO
ZETTA

Method Summary

Modifier and Type	Method and Description
java.lang.String	prefixName() Return the name of the given unit prefix as a string.
java.lang.String	prefixSymbol() Return the short symbol representing the given unit prefix as a string.
double	unitFactor() Return the unit factor associated with the given unit prefix.
static SIUnitPrefixes	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SIUnitPrefixes[]	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

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

YOTTA

public static final SIUnitPrefixes YOTTA

ZETTA

public static final SIUnitPrefixes ZETTA

EXA

public static final SIUnitPrefixes EXA

PETA

public static final SIUnitPrefixes PETA

TERA

public static final SIUnitPrefixes TERA

GIGA

public static final SIUnitPrefixes GIGA

MEGA

public static final SIUnitPrefixes MEGA

KILO

public static final SIUnitPrefixes KILO

HECTO

public static final SIUnitPrefixes HECTO

DEKA

public static final SIUnitPrefixes DEKA

DECI

public static final SIUnitPrefixes DECI

CENTI

public static final SIUnitPrefixes CENTI

MILLI

public static final SIUnitPrefixes MILLI

MICRO

public static final SIUnitPrefixes MICRO

NANO

public static final SIUnitPrefixes NANO

PICO

public static final SIUnitPrefixes PICO

FEMTO

public static final SIUnitPrefixes FEMTO

ATTO

public static final SIUnitPrefixes ATTO

ZEPTO

public static final SIUnitPrefixes ZEPTO

YOCTO

public static final SIUnitPrefixes YOCTO

Method Detail

values

public static SIUnitPrefixes[] 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 (SIUnitPrefixes c : SIUnitPrefixes.values())
    System.out.println(c);

Returns:

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

valueOf

public static SIUnitPrefixes 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

unitFactor

public double unitFactor()

Return the unit factor associated with the given unit prefix.

Returns:

The unit factor as a double value.

prefixName

public java.lang.String prefixName()

Return the name of the given unit prefix as a string.

Returns:

The name of the unit prefix as a string.

prefixSymbol

public java.lang.String prefixSymbol()

Return the short symbol representing the given unit prefix as a string.

Returns:

The short symbol for the unit prefix as a string.