Package ptolemy.data.ontologies.lattice.unit

Enum 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)

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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

    • 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.