com.esri.arcgis.geoprocessing
Interface IGPArealUnit

All Superinterfaces:
Serializable
All Known Implementing Classes:
GPArealUnit

public interface IGPArealUnit
extends Serializable

Provides access to the properties/methods of a geoprocessing areal unit object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Method Summary
 double convertValue(int units)
          Converts the current value to the specified areal unit type.
 int getUnits()
          Gets the type of areal unit.
 double getValue()
          Gets the value, as a double, of the areal unit.
 void setUnits(int pUnits)
          Gets the type of areal unit.
 void setValue(double pValue)
          Gets the value, as a double, of the areal unit.
 

Method Detail

getValue

double getValue()
                throws IOException,
                       AutomationException
Gets the value, as a double, of the areal unit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValue

void setValue(double pValue)
              throws IOException,
                     AutomationException
Gets the value, as a double, of the areal unit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pValue - The pValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUnits

int getUnits()
             throws IOException,
                    AutomationException
Gets the type of areal unit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A com.esri.arcgis.system.esriAreaUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUnits

void setUnits(int pUnits)
              throws IOException,
                     AutomationException
Gets the type of areal unit.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pUnits - A com.esri.arcgis.system.esriAreaUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

convertValue

double convertValue(int units)
                    throws IOException,
                           AutomationException
Converts the current value to the specified areal unit type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
units - A com.esri.arcgis.system.esriAreaUnits constant (in)
Returns:
The pValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.