net.talvi.puffinplot.data

Enum FieldUnit

java.lang.Object

java.lang.Enum<FieldUnit>

net.talvi.puffinplot.data.FieldUnit

All Implemented Interfaces:

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

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

This enum represents a unit in which magnetic field strength can be measured. It is intended for use in the tabular file importer.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GAUSS gauss (G)
KILOGAUSS kilogauss (kG)
MILLITESLA millitesla (mT)
TESLA tesla (T)

Method Summary

Modifier and Type	Method and Description
double	getFactorForTesla()
static FieldUnit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FieldUnit[]	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

TESLA

public static final FieldUnit TESLA

tesla (T)

MILLITESLA

public static final FieldUnit MILLITESLA

millitesla (mT)

GAUSS

public static final FieldUnit GAUSS

gauss (G)

KILOGAUSS

public static final FieldUnit KILOGAUSS

kilogauss (kG)

Method Detail

values

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

Returns:

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

valueOf

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

getFactorForTesla

public double getFactorForTesla()

Returns:

the number by which a value expressed in this unit must be multiplied, in order to produce a value expressed in tesla