com.esri.arcgis.datasourcesraster
Interface IBuildSeamlinesParameters

All Superinterfaces:
Serializable
All Known Subinterfaces:
IBuildSeamlinesParameters2
All Known Implementing Classes:
BuildSeamlinesParameters, IBuildSeamlinesParametersProxy

public interface IBuildSeamlinesParameters
extends Serializable

Provides access to members that control parameters to the build seamlines operation.

Product Availability

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


Method Summary
 double getCellSizeClusterTolerance()
          The factor controlling clustering of cell sizes values.
 ICursor getCursor()
          The cursor of mosaic items that determines the order in which items are seamline mosaicked.
 IRasterFunctionTemplate getDifferenceFunctionTemplate()
          The optional raster function template used for generating the 'difference' between each item raster and the mosaic raster for computing the item's seamline geometry.
 ISeamlineModifier getSeamlineModifier()
          The optional seamline modifier object used for building seamlines.
 boolean isModifySeamlines()
          Indicates whether seamline geometry is updated for selected items.
 boolean isUpdateSeamlineOrder()
          Inidicates whether seamline order (SOrder) attribute is updated.
 void setCellSizeClusterTolerance(double pCellSizeClusterTolerance)
          The factor controlling clustering of cell sizes values.
 void setCursorByRef(ICursor pInputCursor)
          The cursor of mosaic items that determines the order in which items are seamline mosaicked.
 void setDifferenceFunctionTemplateByRef(IRasterFunctionTemplate ppDifferenceFunction)
          The optional raster function template used for generating the 'difference' between each item raster and the mosaic raster for computing the item's seamline geometry.
 void setModifySeamlines(boolean pbModifySeamlines)
          Indicates whether seamline geometry is updated for selected items.
 void setSeamlineModifierByRef(ISeamlineModifier ppSeamlineModifier)
          The optional seamline modifier object used for building seamlines.
 void setUpdateSeamlineOrder(boolean pbUpdateSeamlineOrder)
          Inidicates whether seamline order (SOrder) attribute is updated.
 

Method Detail

setUpdateSeamlineOrder

void setUpdateSeamlineOrder(boolean pbUpdateSeamlineOrder)
                            throws IOException,
                                   AutomationException
Inidicates whether seamline order (SOrder) attribute is updated.

Product Availability

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

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

isUpdateSeamlineOrder

boolean isUpdateSeamlineOrder()
                              throws IOException,
                                     AutomationException
Inidicates whether seamline order (SOrder) attribute is updated.

Product Availability

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

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

setModifySeamlines

void setModifySeamlines(boolean pbModifySeamlines)
                        throws IOException,
                               AutomationException
Indicates whether seamline geometry is updated for selected items.

Product Availability

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

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

isModifySeamlines

boolean isModifySeamlines()
                          throws IOException,
                                 AutomationException
Indicates whether seamline geometry is updated for selected items.

Product Availability

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

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

setCellSizeClusterTolerance

void setCellSizeClusterTolerance(double pCellSizeClusterTolerance)
                                 throws IOException,
                                        AutomationException
The factor controlling clustering of cell sizes values. Two cell size values with a difference factor less than the value in this property are considered one.

Product Availability

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

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

getCellSizeClusterTolerance

double getCellSizeClusterTolerance()
                                   throws IOException,
                                          AutomationException
The factor controlling clustering of cell sizes values. Two cell size values with a difference factor less than the value in this property are considered one.

Product Availability

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

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

setCursorByRef

void setCursorByRef(ICursor pInputCursor)
                    throws IOException,
                           AutomationException
The cursor of mosaic items that determines the order in which items are seamline mosaicked.

Product Availability

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

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

getCursor

ICursor getCursor()
                  throws IOException,
                         AutomationException
The cursor of mosaic items that determines the order in which items are seamline mosaicked.

Product Availability

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

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

setDifferenceFunctionTemplateByRef

void setDifferenceFunctionTemplateByRef(IRasterFunctionTemplate ppDifferenceFunction)
                                        throws IOException,
                                               AutomationException
The optional raster function template used for generating the 'difference' between each item raster and the mosaic raster for computing the item's seamline geometry. The template makes use of at least two dataset type raster function variables with names: Item????&

Product Availability

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

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

getDifferenceFunctionTemplate

IRasterFunctionTemplate getDifferenceFunctionTemplate()
                                                      throws IOException,
                                                             AutomationException
The optional raster function template used for generating the 'difference' between each item raster and the mosaic raster for computing the item's seamline geometry. The template makes use of at least two dataset type raster function variables with names: Item????&

Product Availability

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

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

setSeamlineModifierByRef

void setSeamlineModifierByRef(ISeamlineModifier ppSeamlineModifier)
                              throws IOException,
                                     AutomationException
The optional seamline modifier object used for building seamlines.

Product Availability

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

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

getSeamlineModifier

ISeamlineModifier getSeamlineModifier()
                                      throws IOException,
                                             AutomationException
The optional seamline modifier object used for building seamlines.

Product Availability

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

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