Enum Class TUnits

java.lang.Object

java.lang.Enum<TUnits>

com.xinapse.multisliceimage.analyze.TUnits

All Implemented Interfaces:

Serializable, Comparable<TUnits>, Constable

public enum TUnits
extends Enum<TUnits>

This class represents the NIFTI units of time.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HERTZ	Time units of Hertz.
MSEC	Time units of milli seconds.
PPM	Time units of Hertz.
SEC	Time units of seconds.
UNKNOWN	Unknown time units; assume seconds by default.
USEC	Time units of micro seconds.

Method Summary

Modifier and Type	Method	Description
static void	main(String[] args)	Run a self-test on the TUnits class.
String	toString()	Returns a string describing this TUnits.
static TUnits	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TUnits[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final TUnits UNKNOWN

Unknown time units; assume seconds by default.

SEC

public static final TUnits SEC

Time units of seconds.

MSEC

public static final TUnits MSEC

Time units of milli seconds.

USEC

public static final TUnits USEC

Time units of micro seconds.

HERTZ

public static final TUnits HERTZ

Time units of Hertz.

PPM

public static final TUnits PPM

Time units of Hertz.

Method Details

values

public static TUnits[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TUnits valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Returns a string describing this TUnits.

Overrides:

toString in class Enum<TUnits>

Returns:

a string describing this TUnits.

main

public static void main(String[] args)

Run a self-test on the TUnits class.

Parameters:

args - ignored.