| java.lang.Object | ||
| ↳ | com.esri.core.geometry.Unit | |
| ↳ | com.esri.core.geometry.AreaUnit | |
Class Overview
The units to measure for areas.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| interface | AreaUnit.Code | Area unit codes. | |||||||||
|
[Expand]
Inherited Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From class
com.esri.core.geometry.Unit
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| AreaUnit(int WKID) | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| double |
convertFromSquareMeters(double squareMeters)
Converts square meters to the area units of the object.
| ||||||||||
| double |
convertToSquareMeters(double thisUnitValue)
Converts the area units to square meters of the object.
| ||||||||||
| 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.
| ||||||||||
| String |
getAbbreviation()
Returns the abbreviated name of this unit.
| ||||||||||
| double |
getConversionFactor(Unit dstUnit)
Returns a conversion factor from this unit to the destination unit.
| ||||||||||
| String |
getDisplayName()
Returns the display name of this unit.
| ||||||||||
| int |
getID()
Returns the unit's well-known ID.
| ||||||||||
| String |
getName()
Returns the canonical name of the unit as defined in Projection Engine.
| ||||||||||
| String |
getPluralDisplayName()
Returns the display name of this unit.
| ||||||||||
| Unit.UnitType |
getUnitType()
Returns the unit type.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
com.esri.core.geometry.Unit
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public AreaUnit (int WKID)
Parameters
| WKID | well-known ID. |
|---|
Public Methods
public double convertFromSquareMeters (double squareMeters)
Converts square meters to the area units of the object.
Parameters
| squareMeters | The value in square meters. |
|---|
Returns
- The area unit value corresponding to the input parameter.
public double convertToSquareMeters (double thisUnitValue)
Converts the area units to square meters of the object.
Parameters
| thisUnitValue | The value in this area units to convert. |
|---|
Returns
- The value in square meters corresponding to the input parameter.
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 String getAbbreviation ()
Returns the abbreviated name of this unit.
Returns
- A string value of abbreviation for unit.
public double getConversionFactor (Unit dstUnit)
Returns a conversion factor from this unit to the destination unit.
Parameters
| dstUnit | The destination unit. |
|---|
Returns
- A double conversion factor.
public String getDisplayName ()
Returns the display name of this unit.
Returns
- A string value of unit display name.
public int getID ()
Returns the unit's well-known ID.
Returns
- Integer value for wkid.
public String getName ()
Returns the canonical name of the unit as defined in Projection Engine.
Returns
- A string representation of Projection Engine unit name.
public String getPluralDisplayName ()
Returns the display name of this unit.
Returns
- string value of plural display name