generated.docs.javadoc.org.eclipse.dawnsci.nexus.validation.NexusUnitCategory.html Maven / Gradle / Ivy
NexusUnitCategory (h5jan API)
org.eclipse.dawnsci.nexus.validation
Enum NexusUnitCategory
- java.lang.Object
-
- java.lang.Enum<NexusUnitCategory>
-
- org.eclipse.dawnsci.nexus.validation.NexusUnitCategory
-
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Comparable<NexusUnitCategory>
public enum NexusUnitCategory
extends java.lang.Enum<NexusUnitCategory>
-
-
Enum Constant Summary
Enum Constants
Enum Constant and Description
NX_ANGLE
NX_ANY
NX_AREA
NX_CHARGE
NX_CROSS_SECTION
NX_CURRENT
NX_DIMENSIONLESS
NX_EMITTANCE
Emmittance, a length * angle, e.g.
NX_ENERGY
NX_FLUX
TODO: what unit of flux to use?
The nexus format documentation gives the example: s-1 cm-2,
NX_FREQUENCY
NX_LENGTH
NX_MASS
NX_MASS_DENSITY
NX_MOLECULAR_WEIGHT
NX_PER_AREA
NX_PER_LENGTH
NX_PERIOD
Alias to NX_TIME
NX_POWER
NX_PRESSURE
NX_PULSES
Alias to NX_NUMBER
TODO check unit for this category - could use sub-interface of Dimensionless
NX_SCATTERING_LENGTH_DENSITY
NX_SOLID_ANGLE
NX_TEMPERATURE
NX_TIME
NX_TIME_OF_FLIGHT
Alias to NX_TIME
NX_UNITLESS
TODO, what units for unitless? could we use a subinterface of Dimensionless?
NX_VOLTAGE
NX_VOLUME
NX_WAVELENGTH
NX_WAVENUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
boolean
isCompatible(<any> unit)
static NexusUnitCategory
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
static NexusUnitCategory[]
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
-
-
Enum Constant Detail
-
NX_ANGLE
public static final NexusUnitCategory NX_ANGLE
-
NX_ANY
public static final NexusUnitCategory NX_ANY
-
NX_AREA
public static final NexusUnitCategory NX_AREA
-
NX_CHARGE
public static final NexusUnitCategory NX_CHARGE
-
NX_CROSS_SECTION
public static final NexusUnitCategory NX_CROSS_SECTION
-
NX_CURRENT
public static final NexusUnitCategory NX_CURRENT
-
NX_DIMENSIONLESS
public static final NexusUnitCategory NX_DIMENSIONLESS
-
NX_EMITTANCE
public static final NexusUnitCategory NX_EMITTANCE
Emmittance, a length * angle, e.g. metre-radians
-
NX_ENERGY
public static final NexusUnitCategory NX_ENERGY
-
NX_FLUX
public static final NexusUnitCategory NX_FLUX
TODO: what unit of flux to use?
The nexus format documentation gives the example: s-1 cm-2,
-
NX_FREQUENCY
public static final NexusUnitCategory NX_FREQUENCY
-
NX_LENGTH
public static final NexusUnitCategory NX_LENGTH
-
NX_MASS
public static final NexusUnitCategory NX_MASS
-
NX_MASS_DENSITY
public static final NexusUnitCategory NX_MASS_DENSITY
-
NX_MOLECULAR_WEIGHT
public static final NexusUnitCategory NX_MOLECULAR_WEIGHT
-
NX_PERIOD
public static final NexusUnitCategory NX_PERIOD
Alias to NX_TIME
-
NX_PER_AREA
public static final NexusUnitCategory NX_PER_AREA
-
NX_PER_LENGTH
public static final NexusUnitCategory NX_PER_LENGTH
-
NX_POWER
public static final NexusUnitCategory NX_POWER
-
NX_PRESSURE
public static final NexusUnitCategory NX_PRESSURE
-
NX_PULSES
public static final NexusUnitCategory NX_PULSES
Alias to NX_NUMBER
TODO check unit for this category - could use sub-interface of Dimensionless
-
NX_SCATTERING_LENGTH_DENSITY
public static final NexusUnitCategory NX_SCATTERING_LENGTH_DENSITY
-
NX_SOLID_ANGLE
public static final NexusUnitCategory NX_SOLID_ANGLE
-
NX_TEMPERATURE
public static final NexusUnitCategory NX_TEMPERATURE
-
NX_TIME
public static final NexusUnitCategory NX_TIME
-
NX_TIME_OF_FLIGHT
public static final NexusUnitCategory NX_TIME_OF_FLIGHT
Alias to NX_TIME
-
NX_UNITLESS
public static final NexusUnitCategory NX_UNITLESS
TODO, what units for unitless? could we use a subinterface of Dimensionless?
-
NX_VOLTAGE
public static final NexusUnitCategory NX_VOLTAGE
-
NX_VOLUME
public static final NexusUnitCategory NX_VOLUME
-
NX_WAVELENGTH
public static final NexusUnitCategory NX_WAVELENGTH
-
NX_WAVENUMBER
public static final NexusUnitCategory NX_WAVENUMBER
-
Method Detail
-
values
public static NexusUnitCategory[] 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 (NexusUnitCategory c : NexusUnitCategory.values())
System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static NexusUnitCategory 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
-
isCompatible
public boolean isCompatible(<any> unit)