net.talvi.puffinplot.data

Enum MomentUnit

java.lang.Object

java.lang.Enum<MomentUnit>

net.talvi.puffinplot.data.MomentUnit

All Implemented Interfaces:

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

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

This enum represents a unit in which magnetic dipole moment per unit volume can be measured. It is intended for use in the tabular file importer.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AM amperes per metre (A/m)
KILOAM kiloamperes per metre (kA/m); equivalent to emu/cm³
MILLIAM milliamperes per metre (mA/m)

Method Summary

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

AM

public static final MomentUnit AM

amperes per metre (A/m)

MILLIAM

public static final MomentUnit MILLIAM

milliamperes per metre (mA/m)

KILOAM

public static final MomentUnit KILOAM

kiloamperes per metre (kA/m); equivalent to emu/cm³

Method Detail

values

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

Returns:

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

valueOf

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

getFactorForAm

public double getFactorForAm()

Returns:

the number by which a value measured in this unit should be multiplied in order to produce a value measured in A/m.