com.esri.arcgis.geodatabase
Interface IGPValue

All Superinterfaces:
Serializable
All Known Implementing Classes:
DEAddressLocator, DEArcInfoTable, DECadastralFabric, DECadDrawingDataset, DECatalogRoot, DECoverage, DECoverageFeatureClass, DEDbaseTable, DEDiskConnection, DEFeatureClass, DEFeatureDataset, DEFile, DEFolder, DEGeoDataServer, DEGeometricNetwork, DEGlobeServer, DEGPServer, DEImageServer, DELayer, DEMapDocument, DEMapServer, DENetworkDataset, DEPrjFile, DERasterBand, DERasterCatalog, DERasterDataset, DERelationshipClass, DERemoteDatabaseFolder, DERepresentationClass, DEShapeFile, DESpatialReferencesFolder, DETable, DETerrain, DETextFile, DETin, DETool, DEToolbox, DETopology, DEVPFCoverage, DEVPFTable, DEWCSCoverage, DEWorkspace, Field, GPAddressLocatorStyle, GPAnalysisCellSize, GPArcInfoItem, GPArealUnit, GPBoolean, GPCompositeLayer, GPCoordinateSystem, GPDataFile, GPDate, GPDouble, GPEnvelope, GPEvaluationScale, GPExtent, GPFeatureLayer, GPFeatureRecordSetLayer, GPFieldInfo, GPFieldMapping, GPGALayer, GPGroupLayer, GPINFOExpression, GPLine, GPLinearUnit, GPLong, GPMDomain, GPMultiValue, GPNAHierarchySettings, GPNALayer, GPNetworkDatasetLayer, GPPoint, GPPolygon, GPRandomNumberGenerator, GPRasterCatalogLayer, GPRasterData, GPRasterDataLayer, GPRasterFormulated, GPRasterGDBEnvCompression, GPRasterGDBEnvPyramid, GPRasterGDBEnvStatistics, GPRasterGDBEnvTileSize, GPRasterLayer, GPRecordSet, GPRouteMeasureEventProperties, GPSACellSize, GPSAHorizontalFactor, GPSAMapAlgebraExp, GPSANeighborhood, GPSANumberRemap, GPSARadius, GPSASemiVariogram, GPSAStringRemap, GPSATimeConfiguration, GPSATopoFeatures, GPSAVerticalFactor, GPSAWeightedOverlayTable, GPSAWeightedSum, GPSpatialReference, GPSQLExpression, GPString, GPTableView, GPTerrainLayer, GPTinLayer, GPTopologyLayer, GPValueTable, GPVariant, GPXYDomain, GPZDomain, Index, MdVariable, NAClassFieldMap

public interface IGPValue
extends Serializable

Provides access to members of a GPValue.

When To Use

The IGPValue interface provides access to the property and methods required to create and define a Value object.

Values are the actual inputs to a tool containing scalars or paths to the data.

An array of values is created, based on the same order of the parameter definiton of a geoprocessing tool. This array of values is then used as input to both the Validate and Execute methods of the tool.

A complete example to create a geoprocessing function tool, including the use of IGPValue, is available here: Building Geoprocessing Function Tools .

See also IGPDataType

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void empty()
          Clears the value object.
 String getAsText()
          Provides the value of the value object.
 IGPDataType getDataType()
          The data type of the value object.
 boolean isEmpty()
          Indicates if the value object is empty.
 IGPMessage setAsText(String text)
          Provides the value of the value object with the given string value.
 

Method Detail

getDataType

IGPDataType getDataType()
                        throws IOException,
                               AutomationException
The data type of the value object.

Remarks

The DataType property returns the DataType object associated with this Value object.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geodatabase.IGPDataType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEmpty

boolean isEmpty()
                throws IOException,
                       AutomationException
Indicates if the value object is empty.

Remarks

The IsEmpty method returns if this Value object has been set or not.

Product Availability

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

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

empty

void empty()
           throws IOException,
                  AutomationException
Clears the value object.

Remarks

The Empty method clears this Value object and releases any associated objects.

Product Availability

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

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

getAsText

String getAsText()
                 throws IOException,
                        AutomationException
Provides the value of the value object.

Remarks

The GetAsText method returns this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string for the scalar value.

Product Availability

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

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

setAsText

IGPMessage setAsText(String text)
                     throws IOException,
                            AutomationException
Provides the value of the value object with the given string value.

Remarks

The SetAsText method sets the value of this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string representing the scalar value.

Product Availability

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

Parameters:
text - The text (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessage
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.