com.esri.arcgis.datasourcesraster
Class BuildSeamlinesParameters

java.lang.Object
  com.esri.arcgis.datasourcesraster.BuildSeamlinesParameters

All Implemented Interfaces:

IBuildSeamlinesParameters, IMosaicDatasetOperationParameters, ISelectionParameters, IThreadedOperationParameters, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class BuildSeamlinesParameters
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, IBuildSeamlinesParameters, ISelectionParameters, IThreadedOperationParameters

An object that controls how the seamline geometry for items in a mosiac dataset are computed.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

BuildSeamlinesParameters()
Constructs a BuildSeamlinesParameters using ArcGIS Engine.

BuildSeamlinesParameters(Object obj)
Construct a BuildSeamlinesParameters using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
double	getCellSizeClusterTolerance() The factor controlling clustering of cell sizes values.
static String	getClsid() getClsid.
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.
int	getNumThreads() The number of parallel threads that execute parts of the associated operation.
IPropertySet	getParameters() All parameters associated with the mosaic dataset operation.
IProgressor	getProgressor() The external progressor object associated with the mosaic dataset operation.
IQueryFilter	getQueryFilter() The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation.
void	getRecommendedNumThreads(int[] pRecommendedNumThreads) The number of parallel threads of execution recommended by the system.
IPropertySet	getResults() The properties of the result associated with the mosaic dataset operation.
ISeamlineModifier	getSeamlineModifier() The optional seamline modifier object used for building seamlines.
ISelectionSet	getSelectionSet() The selection set that identifies the collection of catalog items on which to perform the associated operation.
String	getServerName() The host machine name where parts of the operation are remotely executed.
int	hashCode() the hashcode for this object
boolean	isDatasetReadOnly() Indicates whether the mosaic dataset is in read-only mode.
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	setIsDatasetReadOnly(boolean pbIsDatasetReadOnly) Indicates whether the mosaic dataset is in read-only mode.
void	setModifySeamlines(boolean pbModifySeamlines) Indicates whether seamline geometry is updated for selected items.
void	setNumThreads(int pNumThreads) The number of parallel threads that execute parts of the associated operation.
void	setParametersByRef(IPropertySet ppAllParameters) All parameters associated with the mosaic dataset operation.
void	setProgressorByRef(IProgressor ppProgressor) The external progressor object associated with the mosaic dataset operation.
void	setQueryFilterByRef(IQueryFilter ppQueryFilter) The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation.
void	setResultsByRef(IPropertySet ppOperationResults) The properties of the result associated with the mosaic dataset operation.
void	setSeamlineModifierByRef(ISeamlineModifier ppSeamlineModifier) The optional seamline modifier object used for building seamlines.
void	setSelectionSetByRef(ISelectionSet ppSelectionSet) The selection set that identifies the collection of catalog items on which to perform the associated operation.
void	setServerName(String pServerName) The host machine name where parts of the operation are remotely executed.
void	setUpdateSeamlineOrder(boolean pbUpdateSeamlineOrder) Inidicates whether seamline order (SOrder) attribute is updated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

BuildSeamlinesParameters

public BuildSeamlinesParameters()
                         throws IOException,
                                UnknownHostException

Constructs a BuildSeamlinesParameters using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

BuildSeamlinesParameters

public BuildSeamlinesParameters(Object obj)
                         throws IOException

Construct a BuildSeamlinesParameters using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to BuildSeamlinesParameters.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems BuildSeamlinesParameters theBuildSeamlinesParameters = (BuildSeamlinesParameters) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setParametersByRef

public void setParametersByRef(IPropertySet ppAllParameters)
                        throws IOException,
                               AutomationException

All parameters associated with the mosaic dataset operation.

Product Availability

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

Specified by:

setParametersByRef in interface IMosaicDatasetOperationParameters

Parameters:

ppAllParameters - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameters

public IPropertySet getParameters()
                           throws IOException,
                                  AutomationException

All parameters associated with the mosaic dataset operation.

Product Availability

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

Specified by:

getParameters in interface IMosaicDatasetOperationParameters

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProgressorByRef

public void setProgressorByRef(IProgressor ppProgressor)
                        throws IOException,
                               AutomationException

The external progressor object associated with the mosaic dataset operation.

Product Availability

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

Specified by:

setProgressorByRef in interface IMosaicDatasetOperationParameters

Parameters:

ppProgressor - A reference to a com.esri.arcgis.system.IProgressor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProgressor

public IProgressor getProgressor()
                          throws IOException,
                                 AutomationException

The external progressor object associated with the mosaic dataset operation.

Product Availability

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

Specified by:

getProgressor in interface IMosaicDatasetOperationParameters

Returns:

A reference to a com.esri.arcgis.system.IProgressor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsDatasetReadOnly

public void setIsDatasetReadOnly(boolean pbIsDatasetReadOnly)
                          throws IOException,
                                 AutomationException

Indicates whether the mosaic dataset is in read-only mode. Mosaic dataset operations do not perform write operations on a read-only mosaic.

Product Availability

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

Specified by:

setIsDatasetReadOnly in interface IMosaicDatasetOperationParameters

Parameters:

pbIsDatasetReadOnly - The pbIsDatasetReadOnly (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDatasetReadOnly

public boolean isDatasetReadOnly()
                          throws IOException,
                                 AutomationException

Indicates whether the mosaic dataset is in read-only mode. Mosaic dataset operations do not perform write operations on a read-only mosaic.

Product Availability

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

Specified by:

isDatasetReadOnly in interface IMosaicDatasetOperationParameters

Returns:

The pbIsDatasetReadOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResultsByRef

public void setResultsByRef(IPropertySet ppOperationResults)
                     throws IOException,
                            AutomationException

The properties of the result associated with the mosaic dataset operation.

Product Availability

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

Specified by:

setResultsByRef in interface IMosaicDatasetOperationParameters

Parameters:

ppOperationResults - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResults

public IPropertySet getResults()
                        throws IOException,
                               AutomationException

The properties of the result associated with the mosaic dataset operation.

Product Availability

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

Specified by:

getResults in interface IMosaicDatasetOperationParameters

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpdateSeamlineOrder

public 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.

Specified by:

setUpdateSeamlineOrder in interface IBuildSeamlinesParameters

Parameters:

pbUpdateSeamlineOrder - The pbUpdateSeamlineOrder (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUpdateSeamlineOrder

public boolean isUpdateSeamlineOrder()
                              throws IOException,
                                     AutomationException

Inidicates whether seamline order (SOrder) attribute is updated.

Product Availability

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

Specified by:

isUpdateSeamlineOrder in interface IBuildSeamlinesParameters

Returns:

The pbUpdateSeamlineOrder

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setModifySeamlines

public 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.

Specified by:

setModifySeamlines in interface IBuildSeamlinesParameters

Parameters:

pbModifySeamlines - The pbModifySeamlines (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isModifySeamlines

public 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.

Specified by:

isModifySeamlines in interface IBuildSeamlinesParameters

Returns:

The pbModifySeamlines

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCellSizeClusterTolerance

public 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.

Specified by:

setCellSizeClusterTolerance in interface IBuildSeamlinesParameters

Parameters:

pCellSizeClusterTolerance - The pCellSizeClusterTolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellSizeClusterTolerance

public 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.

Specified by:

getCellSizeClusterTolerance in interface IBuildSeamlinesParameters

Returns:

The pCellSizeClusterTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCursorByRef

public 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.

Specified by:

setCursorByRef in interface IBuildSeamlinesParameters

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

public 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.

Specified by:

getCursor in interface IBuildSeamlinesParameters

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

public 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.

Specified by:

setDifferenceFunctionTemplateByRef in interface IBuildSeamlinesParameters

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

public 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.

Specified by:

getDifferenceFunctionTemplate in interface IBuildSeamlinesParameters

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

public 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.

Specified by:

setSeamlineModifierByRef in interface IBuildSeamlinesParameters

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

public 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.

Specified by:

getSeamlineModifier in interface IBuildSeamlinesParameters

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.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet ppSelectionSet)
                          throws IOException,
                                 AutomationException

The selection set that identifies the collection of catalog items on which to perform the associated operation.

Product Availability

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

Specified by:

setSelectionSetByRef in interface ISelectionParameters

Parameters:

ppSelectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws IOException,
                                     AutomationException

The selection set that identifies the collection of catalog items on which to perform the associated operation.

Product Availability

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

Specified by:

getSelectionSet in interface ISelectionParameters

Returns:

A reference to a com.esri.arcgis.geodatabase.ISelectionSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryFilterByRef

public void setQueryFilterByRef(IQueryFilter ppQueryFilter)
                         throws IOException,
                                AutomationException

The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation. If no selection is specified, the query filter is applied on the entire catalog.

Product Availability

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

Specified by:

setQueryFilterByRef in interface ISelectionParameters

Parameters:

ppQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueryFilter

public IQueryFilter getQueryFilter()
                            throws IOException,
                                   AutomationException

The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation. If no selection is specified, the query filter is applied on the entire catalog.

Product Availability

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

Specified by:

getQueryFilter in interface ISelectionParameters

Returns:

A reference to a com.esri.arcgis.geodatabase.IQueryFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServerName

public void setServerName(String pServerName)
                   throws IOException,
                          AutomationException

The host machine name where parts of the operation are remotely executed.

Product Availability

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

Specified by:

setServerName in interface IThreadedOperationParameters

Parameters:

pServerName - The pServerName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerName

public String getServerName()
                     throws IOException,
                            AutomationException

The host machine name where parts of the operation are remotely executed.

Product Availability

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

Specified by:

getServerName in interface IThreadedOperationParameters

Returns:

The pServerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumThreads

public void setNumThreads(int pNumThreads)
                   throws IOException,
                          AutomationException

The number of parallel threads that execute parts of the associated operation.

Product Availability

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

Specified by:

setNumThreads in interface IThreadedOperationParameters

Parameters:

pNumThreads - The pNumThreads (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumThreads

public int getNumThreads()
                  throws IOException,
                         AutomationException

The number of parallel threads that execute parts of the associated operation.

Product Availability

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

Specified by:

getNumThreads in interface IThreadedOperationParameters

Returns:

The pNumThreads

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRecommendedNumThreads

public void getRecommendedNumThreads(int[] pRecommendedNumThreads)
                              throws IOException,
                                     AutomationException

The number of parallel threads of execution recommended by the system.

Product Availability

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

Specified by:

getRecommendedNumThreads in interface IThreadedOperationParameters

Parameters:

pRecommendedNumThreads - The pRecommendedNumThreads (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.