| java.lang.Object | |
| ↳ | com.esri.core.geometry.Unit |
 Known Direct Subclasses
|
Class Overview
A base class for units.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| enum | Unit.EsriUnit | ||||||||||
| enum | Unit.UnitType | Unit type (linear, angular, or area) | |||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| protected String | mAbbreviation | ||||||||||
| protected String | mDisplayName | ||||||||||
| protected int | mID | ||||||||||
| protected String | mName | ||||||||||
| protected String | mPluralDisplayName | ||||||||||
| protected int | mWKID | ||||||||||
| protected double | m_factor | ||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Unit() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static double |
convertUnits(double valueIn, Unit unitFrom, Unit unitTo)
Converts an input value to new units.
| ||||||||||
| static void |
convertUnits(double[] valueIn, int countIn, Unit unitFrom, Unit unitTo, double[] valueOut)
Converts an array of values to new units of same UnitType.
| ||||||||||
| static Unit |
create(int wkid)
Create a unit class from the well-known id(wkid).
| ||||||||||
| boolean |
equals(Object other)
Indicates if this unit is the same type (linear, angular, or area) and the same unit(meter, degree, acre, etc.)as
another.
| ||||||||||
| abstract String |
getAbbreviation()
Returns the abbreviated name of this unit.
| ||||||||||
| abstract double |
getConversionFactor(Unit destinationUnit)
Returns a conversion factor from this unit to the destination unit.
| ||||||||||
| abstract String |
getDisplayName()
Returns the display name of this unit.
| ||||||||||
| abstract int |
getID()
Returns the unit well-known ID.
| ||||||||||
| abstract String |
getName()
Returns the canonical name of the unit as defined in Projection Engine.
| ||||||||||
| abstract String |
getPluralDisplayName()
Returns the display name of this unit.
| ||||||||||
| double |
getUnitToBaseFactor()
the conversion factor from this unit to the base unit.
| ||||||||||
| abstract Unit.UnitType |
getUnitType()
Returns the unit type.
| ||||||||||
| int | hashCode() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
Fields
protected int mID
protected int mWKID
protected double m_factor
Public Constructors
public Unit ()
Public Methods
public static double convertUnits (double valueIn, Unit unitFrom, Unit unitTo)
Converts an input value to new units.
Parameters
| valueIn | The value to be converted from unitFrom to unitTo. |
|---|---|
| unitFrom | The units to convert from. |
| unitTo | The units to convert to. |
Returns
- A converted value as double.
public static void convertUnits (double[] valueIn, int countIn, Unit unitFrom, Unit unitTo, double[] valueOut)
Converts an array of values to new units of same UnitType.
Parameters
| valueIn | The value to converted from. |
|---|---|
| countIn | The count for the to converted values. |
| unitFrom | The unit to convert from. |
| unitTo | The unit to convert to. |
| valueOut | the value to convert to. |
public static Unit create (int wkid)
Create a unit class from the well-known id(wkid). The list of codes for common wkids can be found in the
Parameters
| wkid | The well known ID. |
|---|
Returns
- The unit object of type angular, area, or linear.
AngularUnit.Codeinterface, theLinearUnit.Codeinterface, and theAreaUnit.Codeinterface.
public boolean equals (Object other)
Indicates if this unit is the same type (linear, angular, or area) and the same unit(meter, degree, acre, etc.)as another.
Parameters
| other | The other object. |
|---|
Returns
- true, if equals
public abstract String getAbbreviation ()
Returns the abbreviated name of this unit.
Returns
- A string value of abbreviation for unit.
public abstract double getConversionFactor (Unit destinationUnit)
Returns a conversion factor from this unit to the destination unit. To convert a value V from this units to the dst units.
Parameters
| destinationUnit | The destination unit. |
|---|
Returns
- A double conversion factor.
public abstract String getDisplayName ()
Returns the display name of this unit.
Returns
- A string value of unit display name.
public abstract int getID ()
Returns the unit well-known ID. The ID value is a positive number for the units with well known IDs, and 0 for the custom and area units.
Returns
- Integer value for wkid.
public abstract String getName ()
Returns the canonical name of the unit as defined in Projection Engine. (ex. for German Meter the projection engine canonical string value is METER_GERMAN)
Returns
- A string representation of Projection Engine unit name.
public abstract String getPluralDisplayName ()
Returns the display name of this unit.
Returns
- string value of plural display name
public double getUnitToBaseFactor ()
the conversion factor from this unit to the base unit. for example: to SI meter for linear units, to radian for angular, and to SI square meter for area units.
Returns
- the unit to base factor