com.esri.arcgis.geoprocessing
Interface IGPLinearUnit

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPLinearUnit

public interface IGPLinearUnit
extends Serializable

Provides access to the properties/methods of a geoprocessing linear 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 linear unit type.
int	getUnits() Gets the type of linear unit.
double	getValue() Gets the value, as a double, of the linear unit.
void	setUnits(int pUnits) Gets the type of linear unit.
void	setValue(double pValue) Gets the value, as a double, of the linear unit.

Method Detail

getValue

double getValue()
                throws IOException,
                       AutomationException

Gets the value, as a double, of the linear unit.

Product Availability

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

Supported Platforms

Windows

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 linear unit.

Product Availability

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

Supported Platforms

Windows

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 linear unit.

Product Availability

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

Supported Platforms

Windows

Returns:

A com.esri.arcgis.system.esriUnits 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 linear unit.

Product Availability

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

Supported Platforms

Windows

Parameters:

pUnits - A com.esri.arcgis.system.esriUnits 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 linear unit type.

Product Availability

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

Supported Platforms

Windows

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Returns:

The pValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.