com.esri.arcgis.geoprocessing
Interface IGPValueTable

All Superinterfaces:
Serializable
All Known Implementing Classes:
GPMultiValue, GPSATopoFeatures, GPSAWeightedOverlayTable, GPSAWeightedSum, GPValueTable

public interface IGPValueTable
extends Serializable

Provides access to the properties/methods of a value table object.

When To Use

For an extended code sample refer to the Parameter DataTypeŚLists section of the Building Geoprocessing Functions technical document.

Product Availability

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

Supported Platforms

Windows


Method Summary
 void addDataType(IGPDataType pDataType)
          Adds the data type as a column to the value table.
 void addRecord(IArray pValues)
          Adds a record to the value table.
 IGPDataType getDataType(int index)
          The data type object of the given column index.
 int getDataTypeCount()
          The number of data types/columns of the value table.
 IArray getRecord(int index)
          Returns the array of values of the specified record in the value table.
 int getRecordCount()
          The number of rows in the value table.
 IGPValue getValue(int row, int col)
          Returns the value of the given row/column.
 void insertRecord(int index, IArray pValues)
          Inserts a record in the value table at the specified index.
 void removeDataType(int index)
          Removes the given column from the value table.
 void removeRecord(int index)
          Removes the specified record from the value table.
 void removeValue(IGPValue pValue)
          Removes the given value from the value table.
 void replaceRecord(int index, IArray pValues)
          Replaces the record in the value table at the specified index.
 void setValue(int row, int col, IGPValue ppValue)
          Sets the vlaue of the given row/column.
 

Method Detail

getDataTypeCount

int getDataTypeCount()
                     throws IOException,
                            AutomationException
The number of data types/columns of the value table.

Product Availability

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

Supported Platforms

Windows

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

getDataType

IGPDataType getDataType(int index)
                        throws IOException,
                               AutomationException
The data type object of the given column index.

Product Availability

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

Parameters:
index - The index (in)
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.

addDataType

void addDataType(IGPDataType pDataType)
                 throws IOException,
                        AutomationException
Adds the data type as a column to the value table.

Product Availability

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

Supported Platforms

Windows

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

removeDataType

void removeDataType(int index)
                    throws IOException,
                           AutomationException
Removes the given column from the value table.

Product Availability

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

Supported Platforms

Windows

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

getRecordCount

int getRecordCount()
                   throws IOException,
                          AutomationException
The number of rows in the value table.

Product Availability

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

Supported Platforms

Windows

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

getValue

IGPValue getValue(int row,
                  int col)
                  throws IOException,
                         AutomationException
Returns the value of the given row/column.

Product Availability

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

Supported Platforms

Windows

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

setValue

void setValue(int row,
              int col,
              IGPValue ppValue)
              throws IOException,
                     AutomationException
Sets the vlaue of the given row/column.

Product Availability

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

Supported Platforms

Windows

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

addRecord

void addRecord(IArray pValues)
               throws IOException,
                      AutomationException
Adds a record to the value table.

Product Availability

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

Supported Platforms

Windows

Parameters:
pValues - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertRecord

void insertRecord(int index,
                  IArray pValues)
                  throws IOException,
                         AutomationException
Inserts a record in the value table at the specified index.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
pValues - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceRecord

void replaceRecord(int index,
                   IArray pValues)
                   throws IOException,
                          AutomationException
Replaces the record in the value table at the specified index.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
pValues - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeRecord

void removeRecord(int index)
                  throws IOException,
                         AutomationException
Removes the specified record from the value table.

Product Availability

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

Supported Platforms

Windows

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

getRecord

IArray getRecord(int index)
                 throws IOException,
                        AutomationException
Returns the array of values of the specified record in the value table.

Product Availability

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

Supported Platforms

Windows

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

removeValue

void removeValue(IGPValue pValue)
                 throws IOException,
                        AutomationException
Removes the given value from the value table.

Product Availability

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

Supported Platforms

Windows

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