com.esri.arcgis.datasourcesraster
Interface IRasterKeyProperties

All Superinterfaces:
Serializable
All Known Implementing Classes:
CachedRasterFunction, ExtractBandFunction, FunctionRasterDatasetName, GeometricFunction, IdentityFunction, RasterInfoFunction, StretchFunction

public interface IRasterKeyProperties
extends Serializable

Provides access to members that control raster key properties.

Product Availability

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


Method Summary
 void getAllBandProperties(int bandIndex, IStringArray[] ppNames, IVariantArray[] ppValues)
          Queries all available band-specific key properties.
 void getAllProperties(IStringArray[] ppNames, IVariantArray[] ppValues)
          Queries all available key properties.
 Object getBandProperty(String sName, int bandIndex)
          Returns the requested key property by name for a given band.
 Object getProperty(String sName)
          Returns the requested key property by name.
 void removeBandProperty(String sName, int bandIndex)
          Removes all occurrences of the specified key property for a given band.
 void removeProperty(String sName)
          Removes all occurrences of the specified key property.
 void setBandProperty(String sName, int bandIndex, Object vtValue)
          Updates the value of the specified key property by name for a given band.
 void setProperty(String sName, Object vtValue)
          Updates the value of the specified key property by name.
 

Method Detail

getProperty

Object getProperty(String sName)
                   throws IOException,
                          AutomationException
Returns the requested key property by name.

Product Availability

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

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

setProperty

void setProperty(String sName,
                 Object vtValue)
                 throws IOException,
                        AutomationException
Updates the value of the specified key property by name.

Product Availability

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

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

removeProperty

void removeProperty(String sName)
                    throws IOException,
                           AutomationException
Removes all occurrences of the specified key property.

Product Availability

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

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

getAllProperties

void getAllProperties(IStringArray[] ppNames,
                      IVariantArray[] ppValues)
                      throws IOException,
                             AutomationException
Queries all available key properties.

Product Availability

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

Parameters:
ppNames - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)
ppValues - A reference to a com.esri.arcgis.system.IVariantArray (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBandProperty

Object getBandProperty(String sName,
                       int bandIndex)
                       throws IOException,
                              AutomationException
Returns the requested key property by name for a given band.

Product Availability

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

Parameters:
sName - The sName (in)
bandIndex - The bandIndex (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBandProperty

void setBandProperty(String sName,
                     int bandIndex,
                     Object vtValue)
                     throws IOException,
                            AutomationException
Updates the value of the specified key property by name for a given band.

Product Availability

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

Parameters:
sName - The sName (in)
bandIndex - The bandIndex (in)
vtValue - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeBandProperty

void removeBandProperty(String sName,
                        int bandIndex)
                        throws IOException,
                               AutomationException
Removes all occurrences of the specified key property for a given band.

Product Availability

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

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

getAllBandProperties

void getAllBandProperties(int bandIndex,
                          IStringArray[] ppNames,
                          IVariantArray[] ppValues)
                          throws IOException,
                                 AutomationException
Queries all available band-specific key properties.

Product Availability

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

Parameters:
bandIndex - The bandIndex (in)
ppNames - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)
ppValues - A reference to a com.esri.arcgis.system.IVariantArray (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.