com.esri.arcgis.geoprocessing
Interface IGPRasterLayer

All Superinterfaces:
Serializable
All Known Implementing Classes:
GPRasterLayer

public interface IGPRasterLayer
extends Serializable

Provides access to the properties/methods of a geoprocessing raster layer object.

Product Availability

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

Supported Platforms

Windows


Method Summary
 int getBandCount()
          The number of bands in the raster layer object.
 int getColumnCount()
          The number of columns of the raster layer object.
 IField getField()
          The field of the raster layer.
 double getPixelHeight()
          The pixel height of the raster layer object.
 double getPixelWidth()
          The pixel width of the raster layer object.
 int getRowCount()
          The row count of the raster layer object.
 String getWhereClause()
          The where clause of the raster layer.
 boolean isInteger()
          Indicates whether or not the raster layer is of integer type.
 void setBandCount(int bandCount)
          The number of bands in the raster layer object.
 void setFieldByRef(IField ppField)
          The field of the raster layer.
 void setIsInteger(boolean isInteger)
          Indicates whether or not the raster layer is of integer type.
 void setPixelHeight(double pixelHeight)
          The pixel height of the raster layer object.
 void setPixelWidth(double pixelWidth)
          The pixel width of the raster layer object.
 void setWhereClause(String pWhereClause)
          The where clause of the raster layer.
 

Method Detail

getField

IField getField()
                throws IOException,
                       AutomationException
The field of the raster layer.

Product Availability

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

Supported Platforms

Windows

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

setFieldByRef

void setFieldByRef(IField ppField)
                   throws IOException,
                          AutomationException
The field of the raster layer.

Product Availability

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

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

getWhereClause

String getWhereClause()
                      throws IOException,
                             AutomationException
The where clause of the raster layer.

Product Availability

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

Supported Platforms

Windows

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

setWhereClause

void setWhereClause(String pWhereClause)
                    throws IOException,
                           AutomationException
The where clause of the raster layer.

Product Availability

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

Supported Platforms

Windows

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

isInteger

boolean isInteger()
                  throws IOException,
                         AutomationException
Indicates whether or not the raster layer is of integer type.

Product Availability

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

Supported Platforms

Windows

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

setIsInteger

void setIsInteger(boolean isInteger)
                  throws IOException,
                         AutomationException
Indicates whether or not the raster layer is of integer type.

Product Availability

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

Supported Platforms

Windows

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

getBandCount

int getBandCount()
                 throws IOException,
                        AutomationException
The number of bands in the raster layer object.

Product Availability

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

Supported Platforms

Windows

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

setBandCount

void setBandCount(int bandCount)
                  throws IOException,
                         AutomationException
The number of bands in the raster layer object.

Product Availability

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

Supported Platforms

Windows

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

getPixelWidth

double getPixelWidth()
                     throws IOException,
                            AutomationException
The pixel width of the raster layer object.

Product Availability

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

Supported Platforms

Windows

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

setPixelWidth

void setPixelWidth(double pixelWidth)
                   throws IOException,
                          AutomationException
The pixel width of the raster layer object.

Product Availability

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

Supported Platforms

Windows

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

getPixelHeight

double getPixelHeight()
                      throws IOException,
                             AutomationException
The pixel height of the raster layer object.

Product Availability

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

Supported Platforms

Windows

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

setPixelHeight

void setPixelHeight(double pixelHeight)
                    throws IOException,
                           AutomationException
The pixel height of the raster layer object.

Product Availability

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

Supported Platforms

Windows

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

getRowCount

int getRowCount()
                throws IOException,
                       AutomationException
The row count of the raster layer object.

Product Availability

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

Supported Platforms

Windows

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

getColumnCount

int getColumnCount()
                   throws IOException,
                          AutomationException
The number of columns of the raster layer object.

Product Availability

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

Supported Platforms

Windows

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