com.esri.arcgis.datasourcesraster
Class SeamlineTaskInfo

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

All Implemented Interfaces:

ISeamlineTaskInfo, ISeamlineTaskInfo2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class SeamlineTaskInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISeamlineTaskInfo, ISeamlineTaskInfo2

A seamline task information object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SeamlineTaskInfo()
Constructs a SeamlineTaskInfo using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
IPoint	getCellSize() The cell size at which seamlines are computed.
static String	getClsid() getClsid.
IRaster	getDifferenceRaster() The difference raster built using the selected item raster and the accumulated mosaic raster.
IPoint	getEndPoint() The recommended end point for the creation of the seamline.
IGeometry	getItemGeometry() The footprint geometry of the item for which the seamline is being computed.
int	getItemID() The object ID of the item for which the seamline is being computed.
IRaster	getItemRaster() The item raster for which the seamline is being computed.
IMosaicFunction	getMosaicFunction() The mosaic function associated with the mosaic dataset.
IGeometry	getMosaicGeometry() The geometry of the mosaic built using all items that appear below the selected item.
IFIDSet	getMosaicItemIDs() The object IDs of all items that appear below the selected item.
IRaster	getMosaicRaster() The mosaic raster used for computing the seamline
int	getRequestSize() The request size.
int	getRequestSizeType() The unit of the value specified for the 'RequestSize' property.
IPoint	getStartPoint() The recommended start point for the creation of the seamline.
int	hashCode() the hashcode for this object
void	setCellSizeByRef(IPoint ppCellsize) The cell size at which seamlines are computed.
void	setDifferenceRasterByRef(IRaster ppDifferenceRaster) The difference raster built using the selected item raster and the accumulated mosaic raster.
void	setEndPointByRef(IPoint ppEndPoint) The recommended end point for the creation of the seamline.
void	setItemGeometryByRef(IGeometry ppItemGeometry) The footprint geometry of the item for which the seamline is being computed.
void	setItemID(int pItemID) The object ID of the item for which the seamline is being computed.
void	setItemRasterByRef(IRaster ppItemRaster) The item raster for which the seamline is being computed.
void	setMosaicFunctionByRef(IMosaicFunction ppMosaicFunction) The mosaic function associated with the mosaic dataset.
void	setMosaicGeometryByRef(IGeometry ppMosaicGeometry) The geometry of the mosaic built using all items that appear below the selected item.
void	setMosaicItemIDsByRef(IFIDSet ppMosaicItemIDs) The object IDs of all items that appear below the selected item.
void	setMosaicRasterByRef(IRaster ppMosaicRaster) The mosaic raster used for computing the seamline
void	setRequestSize(int pRequestSize) The request size.
void	setRequestSizeType(int pRequestSizeType) The unit of the value specified for the 'RequestSize' property.
void	setStartPointByRef(IPoint ppStartPoint) The recommended start point for the creation of the seamline.

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

SeamlineTaskInfo

public SeamlineTaskInfo()
                 throws IOException,
                        UnknownHostException

Constructs a SeamlineTaskInfo using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SeamlineTaskInfo

public SeamlineTaskInfo(Object obj)
                 throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems SeamlineTaskInfo theSeamlineTaskInfo = (SeamlineTaskInfo) 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

setItemGeometryByRef

public void setItemGeometryByRef(IGeometry ppItemGeometry)
                          throws IOException,
                                 AutomationException

The footprint geometry of the item for which the seamline is being computed.

Product Availability

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

Specified by:

setItemGeometryByRef in interface ISeamlineTaskInfo

Parameters:

ppItemGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemGeometry

public IGeometry getItemGeometry()
                          throws IOException,
                                 AutomationException

The footprint geometry of the item for which the seamline is being computed.

Product Availability

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

Specified by:

getItemGeometry in interface ISeamlineTaskInfo

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setItemID

public void setItemID(int pItemID)
               throws IOException,
                      AutomationException

The object ID of the item for which the seamline is being computed.

Product Availability

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

Specified by:

setItemID in interface ISeamlineTaskInfo

Parameters:

pItemID - The pItemID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemID

public int getItemID()
              throws IOException,
                     AutomationException

The object ID of the item for which the seamline is being computed.

Product Availability

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

Specified by:

getItemID in interface ISeamlineTaskInfo

Returns:

The pItemID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCellSizeByRef

public void setCellSizeByRef(IPoint ppCellsize)
                      throws IOException,
                             AutomationException

The cell size at which seamlines are computed.

Product Availability

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

Specified by:

setCellSizeByRef in interface ISeamlineTaskInfo

Parameters:

ppCellsize - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellSize

public IPoint getCellSize()
                   throws IOException,
                          AutomationException

The cell size at which seamlines are computed.

Product Availability

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

Specified by:

getCellSize in interface ISeamlineTaskInfo

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicGeometryByRef

public void setMosaicGeometryByRef(IGeometry ppMosaicGeometry)
                            throws IOException,
                                   AutomationException

The geometry of the mosaic built using all items that appear below the selected item.

Product Availability

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

Specified by:

setMosaicGeometryByRef in interface ISeamlineTaskInfo

Parameters:

ppMosaicGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicGeometry

public IGeometry getMosaicGeometry()
                            throws IOException,
                                   AutomationException

The geometry of the mosaic built using all items that appear below the selected item.

Product Availability

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

Specified by:

getMosaicGeometry in interface ISeamlineTaskInfo

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicItemIDsByRef

public void setMosaicItemIDsByRef(IFIDSet ppMosaicItemIDs)
                           throws IOException,
                                  AutomationException

The object IDs of all items that appear below the selected item.

Product Availability

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

Specified by:

setMosaicItemIDsByRef in interface ISeamlineTaskInfo

Parameters:

ppMosaicItemIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicItemIDs

public IFIDSet getMosaicItemIDs()
                         throws IOException,
                                AutomationException

The object IDs of all items that appear below the selected item.

Product Availability

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

Specified by:

getMosaicItemIDs in interface ISeamlineTaskInfo

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicFunctionByRef

public void setMosaicFunctionByRef(IMosaicFunction ppMosaicFunction)
                            throws IOException,
                                   AutomationException

The mosaic function associated with the mosaic dataset.

Product Availability

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

Specified by:

setMosaicFunctionByRef in interface ISeamlineTaskInfo

Parameters:

ppMosaicFunction - A reference to a com.esri.arcgis.datasourcesraster.IMosaicFunction (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicFunction

public IMosaicFunction getMosaicFunction()
                                  throws IOException,
                                         AutomationException

The mosaic function associated with the mosaic dataset.

Product Availability

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

Specified by:

getMosaicFunction in interface ISeamlineTaskInfo

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IMosaicFunction

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDifferenceRasterByRef

public void setDifferenceRasterByRef(IRaster ppDifferenceRaster)
                              throws IOException,
                                     AutomationException

The difference raster built using the selected item raster and the accumulated mosaic raster.

Product Availability

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

Specified by:

setDifferenceRasterByRef in interface ISeamlineTaskInfo

Parameters:

ppDifferenceRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDifferenceRaster

public IRaster getDifferenceRaster()
                            throws IOException,
                                   AutomationException

The difference raster built using the selected item raster and the accumulated mosaic raster.

Product Availability

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

Specified by:

getDifferenceRaster in interface ISeamlineTaskInfo

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartPointByRef

public void setStartPointByRef(IPoint ppStartPoint)
                        throws IOException,
                               AutomationException

The recommended start point for the creation of the seamline.

Product Availability

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

Specified by:

setStartPointByRef in interface ISeamlineTaskInfo

Parameters:

ppStartPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartPoint

public IPoint getStartPoint()
                     throws IOException,
                            AutomationException

The recommended start point for the creation of the seamline.

Product Availability

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

Specified by:

getStartPoint in interface ISeamlineTaskInfo

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndPointByRef

public void setEndPointByRef(IPoint ppEndPoint)
                      throws IOException,
                             AutomationException

The recommended end point for the creation of the seamline.

Product Availability

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

Specified by:

setEndPointByRef in interface ISeamlineTaskInfo

Parameters:

ppEndPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndPoint

public IPoint getEndPoint()
                   throws IOException,
                          AutomationException

The recommended end point for the creation of the seamline.

Product Availability

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

Specified by:

getEndPoint in interface ISeamlineTaskInfo

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRequestSize

public int getRequestSize()
                   throws IOException,
                          AutomationException

The request size.

Product Availability

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

Specified by:

getRequestSize in interface ISeamlineTaskInfo

Returns:

The pRequestSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRequestSize

public void setRequestSize(int pRequestSize)
                    throws IOException,
                           AutomationException

The request size.

Product Availability

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

Specified by:

setRequestSize in interface ISeamlineTaskInfo

Parameters:

pRequestSize - The pRequestSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setItemRasterByRef

public void setItemRasterByRef(IRaster ppItemRaster)
                        throws IOException,
                               AutomationException

The item raster for which the seamline is being computed.

Product Availability

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

Specified by:

setItemRasterByRef in interface ISeamlineTaskInfo2

Parameters:

ppItemRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemRaster

public IRaster getItemRaster()
                      throws IOException,
                             AutomationException

The item raster for which the seamline is being computed.

Product Availability

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

Specified by:

getItemRaster in interface ISeamlineTaskInfo2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicRasterByRef

public void setMosaicRasterByRef(IRaster ppMosaicRaster)
                          throws IOException,
                                 AutomationException

The mosaic raster used for computing the seamline

Product Availability

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

Specified by:

setMosaicRasterByRef in interface ISeamlineTaskInfo2

Parameters:

ppMosaicRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicRaster

public IRaster getMosaicRaster()
                        throws IOException,
                               AutomationException

The mosaic raster used for computing the seamline

Product Availability

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

Specified by:

getMosaicRaster in interface ISeamlineTaskInfo2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRequestSizeType

public int getRequestSizeType()
                       throws IOException,
                              AutomationException

The unit of the value specified for the 'RequestSize' property.

Product Availability

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

Specified by:

getRequestSizeType in interface ISeamlineTaskInfo2

Returns:

A com.esri.arcgis.datasourcesraster.esriRequestSizeType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRequestSizeType

public void setRequestSizeType(int pRequestSizeType)
                        throws IOException,
                               AutomationException

The unit of the value specified for the 'RequestSize' property.

Product Availability

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

Specified by:

setRequestSizeType in interface ISeamlineTaskInfo2

Parameters:

pRequestSizeType - A com.esri.arcgis.datasourcesraster.esriRequestSizeType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.