Package com.flir.thermalsdk.image.utils

Enum Class UnitsConverter.DistanceUnit

java.lang.Object

java.lang.Enum<UnitsConverter.DistanceUnit>

com.flir.thermalsdk.image.utils.UnitsConverter.DistanceUnit

All Implemented Interfaces:

UnitsConverter.UnitInterface, Serializable, Comparable<UnitsConverter.DistanceUnit>, Constable

Enclosing class:

UnitsConverter

public static enum UnitsConverter.DistanceUnit
extends Enum<UnitsConverter.DistanceUnit>
implements UnitsConverter.UnitInterface

Defines distance units.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FEET
METERS

Method Summary

Modifier and Type	Method	Description
double	getSiValue(double value)	Converts value in units method is called for to value in SI units.
String	getUnit()	Gets the unit symbol.
UnitsConverter.UnitInterface	getUnitByName(String name)	Gets the unit by provided name.
double	getValue(double siValue)	Converts SI value to value in units it is called for.
static UnitsConverter.DistanceUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UnitsConverter.DistanceUnit[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.flir.thermalsdk.image.utils.UnitsConverter.UnitInterface

ordinal

Enum Constant Details

METERS

public static final UnitsConverter.DistanceUnit METERS

FEET

public static final UnitsConverter.DistanceUnit FEET

Method Details

values

public static UnitsConverter.DistanceUnit[] 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 UnitsConverter.DistanceUnit 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

getUnit

public String getUnit()

Description copied from interface: UnitsConverter.UnitInterface

Gets the unit symbol.

Specified by:

getUnit in interface UnitsConverter.UnitInterface

Returns:

unit symbol.

getValue

public double getValue(double siValue)

Description copied from interface: UnitsConverter.UnitInterface

Converts SI value to value in units it is called for.

Specified by:

getValue in interface UnitsConverter.UnitInterface

Parameters:

siValue - value in SI units.

Returns:

value in units method is called for.

getSiValue

public double getSiValue(double value)

Description copied from interface: UnitsConverter.UnitInterface

Converts value in units method is called for to value in SI units.

Specified by:

getSiValue in interface UnitsConverter.UnitInterface

Parameters:

value - value in units method is called for.

Returns:

value in SI units.

getUnitByName

public UnitsConverter.UnitInterface getUnitByName(String name)

Description copied from interface: UnitsConverter.UnitInterface

Gets the unit by provided name. First character is skipped in comparison. It is to prevent checking non-basic units.

Specified by:

getUnitByName in interface UnitsConverter.UnitInterface

Parameters:

name - full unit name.

Returns:

UnitsConverter.UnitInterface object of specified quantity, that has given unit.