public class TLcdAltitudeUnit extends Object implements Serializable, ILcdISO19103UnitOfMeasure
Modifier and Type | Field and Description |
---|---|
static TLcdAltitudeUnit |
FEET
Altitude unit for feet.
|
static TLcdAltitudeUnit |
FEET_AMSL
Deprecated.
This constant is an alias for
FEET . It has been renamed because the "AMSL" qualifier is inappropriate here. |
static TLcdAltitudeUnit |
FLIGHT_LEVEL
Altitude unit for flight levels.
|
static TLcdAltitudeUnit |
KM
Altitude unit for kilometers.
|
static TLcdAltitudeUnit |
KM_AMSL
Deprecated.
This constant is an alias for
KM . It has been renamed because the "AMSL" qualifier is inappropriate here. |
static TLcdAltitudeUnit |
METRE
Altitude unit for meters.
|
static TLcdAltitudeUnit |
METRE_AMSL
Deprecated.
This constant is an alias for
METRE . It has been renamed because the "AMSL" qualifier is inappropriate here. |
Constructor and Description |
---|
TLcdAltitudeUnit(String aUnitName,
String aUnitShortName,
double aToMetreFactor)
Constructs a new altitude unit.
|
Modifier and Type | Method and Description |
---|---|
static void |
addAltitudeUnit(TLcdAltitudeUnit aAltitudeUnit)
Adds the specified altitude unit to the set of altitude units which are registered for this
JVM session.
|
double |
convertFromAltitudeAMSL(double aAltitude,
double aWGS84Lon,
double aWGS84Lat)
Converts an altitude expressed in meters above mean sea level to this altitudes unit.
|
double |
convertFromStandard(double aValue)
Converts from meters AMSL.
|
double |
convertToAltitudeAMSL(double aAltitude,
double aWGS84Lon,
double aWGS84Lat)
Converts an altitude expressed in this altitudes unit to meters above mean sea level.
|
double |
convertToStandard(double aValue)
Converts to meters AMSL.
|
boolean |
equals(Object aO) |
static TLcdAltitudeUnit[] |
getAllAltitudeUnits()
Returns the available altitude units to consider in a JVM session.
|
TLcdISO19103MeasureTypeCode |
getMeasureType()
The type of measure this unit of measure is used for.
|
String |
getNameOfStandardUnit()
Returns the name of the standard unit for this type of measure,
which is unit name of
METRE_AMSL . |
double |
getToMetreFactor()
Deprecated.
use
convertToAltitudeAMSL(double, double, double) to convert the altitude expressed in this unit to meters AMSL. |
String |
getUnitName()
Returns the name of this
TLcdAltitudeUnit (e.g. Meter, Kilometer, Mile, etc ...). |
String |
getUnitShortName()
Returns the short name of this
TLcdAltitudeUnit (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 |
removeAltitudeUnit(TLcdAltitudeUnit aAltitudeUnit)
Removes the specified altitude unit from the set of altitude units which are registered for this
JVM session.
|
static void |
setAllAltitudeUnits(TLcdAltitudeUnit[] aAllAltitudeUnitArray)
Sets statically all
TLcdAltitudeUnit to consider in a JVM session. |
String |
toString()
Returns the unit name.
|
public static final TLcdAltitudeUnit METRE
TLcdUnitOfMeasureFactory.ALTITUDE_METRE
.public static final TLcdAltitudeUnit KM
TLcdUnitOfMeasureFactory.ALTITUDE_KILOMETRE
.public static final TLcdAltitudeUnit FEET
TLcdUnitOfMeasureFactory.ALTITUDE_FEET
.@Deprecated public static final TLcdAltitudeUnit METRE_AMSL
METRE
. It has been renamed because the "AMSL" qualifier is inappropriate here.@Deprecated public static final TLcdAltitudeUnit KM_AMSL
KM
. It has been renamed because the "AMSL" qualifier is inappropriate here.@Deprecated public static final TLcdAltitudeUnit FEET_AMSL
FEET
. It has been renamed because the "AMSL" qualifier is inappropriate here.public static final TLcdAltitudeUnit FLIGHT_LEVEL
TLcdUnitOfMeasureFactory.ALTITUDE_FLIGHT_LEVEL
.public TLcdAltitudeUnit(String aUnitName, String aUnitShortName, double aToMetreFactor)
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.public String getUnitName()
TLcdAltitudeUnit
(e.g. Meter, Kilometer, Mile, etc ...).TLcdAltitudeUnit
(e.g. Meter, Kilometer, Mile, etc ...)public String getUnitShortName()
TLcdAltitudeUnit
(e.g. m, Km, Mi, etc ...).TLcdAltitudeUnit
(e.g. m, Km, Mi, etc ...).public double getToMetreFactor()
convertToAltitudeAMSL(double, double, double)
to convert the altitude expressed in this unit to meters AMSL.public double convertToAltitudeAMSL(double aAltitude, double aWGS84Lon, double aWGS84Lat)
aAltitude
- an altitude expressed in this altitudes unit.aWGS84Lon
- the location above which the altitude is converted expressed in WGS84 longitude.aWGS84Lat
- the location above which the altitude is converted expressed in WGS84 latitude.public double convertFromAltitudeAMSL(double aAltitude, double aWGS84Lon, double aWGS84Lat)
aAltitude
- an altitude expressed in meters above mean sea level.aWGS84Lon
- the location above which the altitude is converted expressed in WGS84 longitude.aWGS84Lat
- the location above which the altitude is converted expressed in WGS84 latitude.public String toString()
public String getUOMName()
ILcdISO19103UnitOfMeasure
getUOMName
in interface ILcdISO19103UnitOfMeasure
public String getUOMSymbol()
ILcdISO19103UnitOfMeasure
getUOMSymbol
in interface ILcdISO19103UnitOfMeasure
public TLcdISO19103MeasureTypeCode getMeasureType()
ILcdISO19103UnitOfMeasure
getMeasureType
in interface ILcdISO19103UnitOfMeasure
public String getNameOfStandardUnit()
METRE_AMSL
.getNameOfStandardUnit
in interface ILcdISO19103UnitOfMeasure
METRE_AMSL
.public double convertToStandard(double aValue)
convertToStandard
in interface ILcdISO19103UnitOfMeasure
aValue
- the value expressed in this unit of measure.public double convertFromStandard(double aValue)
convertFromStandard
in interface ILcdISO19103UnitOfMeasure
aValue
- the value expressed in meters AMSLpublic static TLcdAltitudeUnit[] getAllAltitudeUnits()
setAllAltitudeUnits(com.luciad.util.TLcdAltitudeUnit[])
public static void setAllAltitudeUnits(TLcdAltitudeUnit[] aAllAltitudeUnitArray)
TLcdAltitudeUnit
to consider in a JVM session. Typically, this method should
be called in the main of the application.aAllAltitudeUnitArray
- the altitude units to consider in a JVM sessiongetAllAltitudeUnits()
public static void addAltitudeUnit(TLcdAltitudeUnit aAltitudeUnit)
aAltitudeUnit
- a altitude unit to be registered for this JVM session.IllegalArgumentException
- If an altitude unit with the same symbol was already registered before.public static void removeAltitudeUnit(TLcdAltitudeUnit aAltitudeUnit)
aAltitudeUnit
- an altitude unit to be removed for this JVM session.IllegalArgumentException
- If the specified altitude unit is not contained in the list of
registered altitude units.