TLcdDistanceUnit (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.util.TLcdDistanceUnit

All Implemented Interfaces:

ILcdISO19103UnitOfMeasure, Serializable
```
public class TLcdDistanceUnit
extends Object
implements Serializable, ILcdISO19103UnitOfMeasure
```
This class defines distance unit constants. The standard unit is 'meter'.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static TLcdDistanceUnit`	`FT_UNIT` Distance unit for feet.
`static TLcdDistanceUnit`	`KM_UNIT` Distance unit for kilometers.
`static TLcdDistanceUnit`	`METRE_UNIT` Distance unit for meters.
`static TLcdDistanceUnit`	`MILE_US_UNIT` Distance unit for miles (US).
`static TLcdDistanceUnit`	`NM_UNIT` Distance unit for nautical miles.

Constructor Summary

Constructors
Constructor and Description

TLcdDistanceUnit(String aUnitName, String aUnitShortName, double aToMetreFactor)
Constructs a new distance unit.

Constructors
Constructor and Description
`TLcdDistanceUnit(String aUnitName, String aUnitShortName, double aToMetreFactor)` Constructs a new distance unit.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addDistanceUnit(TLcdDistanceUnit aDistanceUnit)` Adds the specified distance unit to the set of distance units which are registered for this JVM session.
`double`	`convertFromStandard(double aValue)` Converts a value which is assumed in the standard unit of measure to the unit of measure in the measureSFCT.
`double`	`convertToStandard(double aValue)` Converts a value which is assumed in this unit of measure to the standard unit of measure.
`boolean`	`equals(Object aO)`
`static TLcdDistanceUnit[]`	`getAllDistanceUnits()` Returns the available distance units to consider in a JVM session.
`TLcdISO19103MeasureTypeCode`	`getMeasureType()` The type of measure this unit of measure is used for.
`String`	`getNameOfStandardUnit()` The name of the standard unit for this type of measures.
`double`	`getToMetreFactor()` Returns the factor to apply to convert a distance expressed in that specific unit into a distance in meters.
`String`	`getUnitName()` Returns the name of this `TLcdDistanceUnit` (e.g. Meter, Kilometer, Mile, etc ...).
`String`	`getUnitShortName()` Returns the short name of this `TLcdDistanceUnit` (e.g. m, km, mi, etc ...).
`String`	`getUOMName()` The name of the unit of measure
`String`	`getUOMSymbol()` The symbol used for the unit of measure
`int`	`hashCode()`
`static void`	`removeDistanceUnit(TLcdDistanceUnit aDistanceUnit)` Removes the specified distance unit from the set of distance units which are registered for this JVM session.
`static void`	`setAllDistanceUnits(TLcdDistanceUnit[] aAllDistanceUnitArray)` Sets statically all `TLcdDistanceUnit` to consider in a JVM session.
`String`	`toString()` Returns the unit name.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - METRE_UNIT
```
public static final TLcdDistanceUnit METRE_UNIT
```
    Distance unit for meters. This constant is an alias for TLcdUnitOfMeasureFactory.DISTANCE_METRE.
  - KM_UNIT
```
public static final TLcdDistanceUnit KM_UNIT
```
    Distance unit for kilometers. This constant is an alias for TLcdUnitOfMeasureFactory.DISTANCE_KILOMETRE.
  - NM_UNIT
```
public static final TLcdDistanceUnit NM_UNIT
```
    Distance unit for nautical miles. This constant is an alias for TLcdUnitOfMeasureFactory.DISTANCE_NAUTICAL_MILE.
  - MILE_US_UNIT
```
public static final TLcdDistanceUnit MILE_US_UNIT
```
    Distance unit for miles (US). This constant is an alias for TLcdUnitOfMeasureFactory.DISTANCE_MILE.
  - FT_UNIT
```
public static final TLcdDistanceUnit FT_UNIT
```
    Distance unit for feet. This constant is an alias for TLcdUnitOfMeasureFactory.DISTANCE_FEET.
- Constructor Detail
  - TLcdDistanceUnit
```
public TLcdDistanceUnit(String aUnitName,
                        String aUnitShortName,
                        double aToMetreFactor)
```
    Constructs a new distance unit.
    
    Parameters:
    
    aUnitName - The name of the unit.
    
    aUnitShortName - The short name of the unit, typically used as the suffix after a number.
    
    aToMetreFactor - The factor to convert a value expressed in this unit to metres. For example, if the unit is km, the factor is 1000.
- Method Detail
  - getUnitName
```
public String getUnitName()
```
    Returns the name of this TLcdDistanceUnit (e.g. Meter, Kilometer, Mile, etc ...).
    
    Returns:
    
    the name of this TLcdDistanceUnit (e.g. Meter, Kilometer, Mile, etc ...).
  - getUnitShortName
```
public String getUnitShortName()
```
    Returns the short name of this TLcdDistanceUnit (e.g. m, km, mi, etc ...).
    
    Returns:
    
    the short name of this TLcdDistanceUnit (e.g. m, km, mi, etc ...).
  - getToMetreFactor
```
public double getToMetreFactor()
```
    Returns the factor to apply to convert a distance expressed in that specific unit into a distance in meters.
    
    Returns:
    
    the factor to apply to convert a distance expressed in that specific unit into a distance in meters.
  - getAllDistanceUnits
```
public static TLcdDistanceUnit[] getAllDistanceUnits()
```
    Returns the available distance units to consider in a JVM session.
    
    Returns:
    
    the available distance units to consider in a JVM session.
    
    See Also:
    
    setAllDistanceUnits(com.luciad.util.TLcdDistanceUnit[])
  - setAllDistanceUnits
```
public static void setAllDistanceUnits(TLcdDistanceUnit[] aAllDistanceUnitArray)
```
    Sets statically all TLcdDistanceUnit to consider in a JVM session. Typically, this method should be called in the main of the application.
    
    Parameters:
    
    aAllDistanceUnitArray - the distance units to consider in a JVM session
    
    See Also:
    
    getAllDistanceUnits()
  - addDistanceUnit
```
public static void addDistanceUnit(TLcdDistanceUnit aDistanceUnit)
```
    Adds the specified distance unit to the set of distance units which are registered for this JVM session.
    
    Parameters:
    
    aDistanceUnit - a distance unit to be registered for this JVM session.
    
    Throws:
    
    IllegalArgumentException - If a distance unit with the same symbol was already registered before.
  - removeDistanceUnit
```
public static void removeDistanceUnit(TLcdDistanceUnit aDistanceUnit)
```
    Removes the specified distance unit from the set of distance units which are registered for this JVM session.
    
    Parameters:
    
    aDistanceUnit - a distance unit to be removed for this JVM session.
    
    Throws:
    
    IllegalArgumentException - If the specified distance unit is not contained in the list of registered distance units.
  - toString
```
public String toString()
```
    Returns the unit name.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the unit name.
  - getUOMName
```
public String getUOMName()
```
    Description copied from interface: ILcdISO19103UnitOfMeasure
    
    The name of the unit of measure
    
    Specified by:
    
    getUOMName in interface ILcdISO19103UnitOfMeasure
    
    Returns:
    
    the name of the unit of measure
  - getUOMSymbol
```
public String getUOMSymbol()
```
    Description copied from interface: ILcdISO19103UnitOfMeasure
    
    The symbol used for the unit of measure
    
    Specified by:
    
    getUOMSymbol in interface ILcdISO19103UnitOfMeasure
    
    Returns:
    
    the symbol used for the unit of measure
  - getMeasureType
```
public TLcdISO19103MeasureTypeCode getMeasureType()
```
    Description copied from interface: ILcdISO19103UnitOfMeasure
    
    The type of measure this unit of measure is used for.
    
    Specified by:
    
    getMeasureType in interface ILcdISO19103UnitOfMeasure
    
    Returns:
    
    the type of measure this unit of measure is used for.
  - getNameOfStandardUnit
```
public String getNameOfStandardUnit()
```
    Description copied from interface: ILcdISO19103UnitOfMeasure
    
    The name of the standard unit for this type of measures.
    
    Specified by:
    
    getNameOfStandardUnit in interface ILcdISO19103UnitOfMeasure
    
    Returns:
    
    the name of the standard unit for this type of measures.
  - convertToStandard
```
public double convertToStandard(double aValue)
```
    Description copied from interface: ILcdISO19103UnitOfMeasure
    
    Converts a value which is assumed in this unit of measure to the standard unit of measure.
    
    Specified by:
    
    convertToStandard in interface ILcdISO19103UnitOfMeasure
  - convertFromStandard
```
public double convertFromStandard(double aValue)
```
    Description copied from interface: ILcdISO19103UnitOfMeasure
    
    Converts a value which is assumed in the standard unit of measure to the unit of measure in the measureSFCT.
    
    Specified by:
    
    convertFromStandard in interface ILcdISO19103UnitOfMeasure
  - equals
```
public boolean equals(Object aO)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

LuciadLightspeedClass TLcdDistanceUnit

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

METRE_UNIT

KM_UNIT

NM_UNIT

MILE_US_UNIT

FT_UNIT

Constructor Detail

TLcdDistanceUnit

Method Detail

getUnitName

getUnitShortName

getToMetreFactor

getAllDistanceUnits

setAllDistanceUnits

addDistanceUnit

removeDistanceUnit

toString

getUOMName

getUOMSymbol

getMeasureType

getNameOfStandardUnit

convertToStandard

convertFromStandard

equals

hashCode