com.esri.arcgis.datasourcesraster
Interface IRasterTypeProperties

All Superinterfaces:

Serializable

All Known Implementing Classes:

IRasterTypePropertiesProxy, RasterType

public interface IRasterTypeProperties
extends Serializable

Provides access to members that control raster type properties.

Product Availability

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

Method Summary

IAddRastersParameters	getAddRastersParameters() The parameters controlling how rasters are added using this raster type.
String	getDataSourceFilter() Regular expression formed using wild card characters ('*', '?', or '.') for matching data source items requested for URI constructions.
String	getDescription() Description of the raster type.
Date	getFirstAddTimeStamp() The time when this raster type was first used for adding rasters to the mosaic dataset.
int	getInputDataSourceTypes() The types of input data source types as a bitwise combination of esriCrawlerDataSourceType values.
Date	getLastAddTimeStamp() The time when this raster type was last used for adding rasters to the mosaic dataset.
Date	getLastSyncTimeStamp() The time when this raster type was last used for synchronizing one or more rasters in the mosaic dataset.
String	getName() Name of the raster type.
String	getOperationDescription() A user-identifiable description of the collection of items added by this raster type instance.
IGeometricFunctionArguments	getOrthorectificationParameters() The parameters controlling orthorectification of raster datasets built by this raster type.
IArray	getSupportedURIFilters() Default URI filters supported by the raster type.
ISynchronizeParameters	getSynchronizeParameters() The parameters controlling how rasters are synchronized using this raster type instance.
boolean	isEnableClipToFootprint() Indicates whether datasets are clipped to their footprints.
boolean	isSupportsOrthorectification() Indicates whether the raster type supports orthorectification.
boolean	isSupportsSeamline() Indicates whether the raster type supports seamline.
boolean	isSupportsStereo() Indicates whether the raster type supports stereo.
void	setAddRastersParameters(IAddRastersParameters ppAddRastersParameters) The parameters controlling how rasters are added using this raster type.
void	setDataSourceFilter(String pDataSourceFilter) Regular expression formed using wild card characters ('*', '?', or '.') for matching data source items requested for URI constructions.
void	setDescription(String pRasterTypeDescription) Description of the raster type.
void	setEnableClipToFootprint(boolean pbEnableClipToFootprint) Indicates whether datasets are clipped to their footprints.
void	setFirstAddTimeStamp(Date pFirstAddTimeStamp) The time when this raster type was first used for adding rasters to the mosaic dataset.
void	setInputDataSourceTypes(int pInputDataSourceTypes) The types of input data source types as a bitwise combination of esriCrawlerDataSourceType values.
void	setLastAddTimeStamp(Date pLastAddTimeStamp) The time when this raster type was last used for adding rasters to the mosaic dataset.
void	setLastSyncTimeStamp(Date pLastSyncTimeStamp) The time when this raster type was last used for synchronizing one or more rasters in the mosaic dataset.
void	setName(String pRasterTypeName) Name of the raster type.
void	setOperationDescription(String pOperationDescription) A user-identifiable description of the collection of items added by this raster type instance.
void	setOrthorectificationParametersByRef(IGeometricFunctionArguments ppIGeometricFunctionArguments) The parameters controlling orthorectification of raster datasets built by this raster type.
void	setSupportedURIFiltersByRef(IArray pppItemURIFilterArray) Default URI filters supported by the raster type.
void	setSupportsOrthorectification(boolean pbSupportsOrthorectification) Indicates whether the raster type supports orthorectification.
void	setSupportsSeamline(boolean pbSupportsSeamline) Indicates whether the raster type supports seamline.
void	setSupportsStereo(boolean pbSupportsStereo) Indicates whether the raster type supports stereo.
void	setSynchronizeParameters(ISynchronizeParameters ppSynchronizeParameters) The parameters controlling how rasters are synchronized using this raster type instance.

Method Detail

setName

void setName(String pRasterTypeName)
             throws IOException,
                    AutomationException

Name of the raster type.

Product Availability

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

Parameters:

pRasterTypeName - The pRasterTypeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

Name of the raster type.

Product Availability

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

Returns:

The pRasterTypeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(String pRasterTypeDescription)
                    throws IOException,
                           AutomationException

Description of the raster type.

Product Availability

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

Parameters:

pRasterTypeDescription - The pRasterTypeDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

Description of the raster type.

Product Availability

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

Returns:

The pRasterTypeDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInputDataSourceTypes

void setInputDataSourceTypes(int pInputDataSourceTypes)
                             throws IOException,
                                    AutomationException

The types of input data source types as a bitwise combination of esriCrawlerDataSourceType values.

Product Availability

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

Parameters:

pInputDataSourceTypes - The pInputDataSourceTypes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputDataSourceTypes

int getInputDataSourceTypes()
                            throws IOException,
                                   AutomationException

The types of input data source types as a bitwise combination of esriCrawlerDataSourceType values.

Product Availability

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

Returns:

The pInputDataSourceTypes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataSourceFilter

void setDataSourceFilter(String pDataSourceFilter)
                         throws IOException,
                                AutomationException

Regular expression formed using wild card characters ('*', '?', or '.') for matching data source items requested for URI constructions. No item URIs are created for input that doesn't match the specified regular expression.

Product Availability

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

Parameters:

pDataSourceFilter - The pDataSourceFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSourceFilter

String getDataSourceFilter()
                           throws IOException,
                                  AutomationException

Regular expression formed using wild card characters ('*', '?', or '.') for matching data source items requested for URI constructions. No item URIs are created for input that doesn't match the specified regular expression.

Product Availability

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

Returns:

The pDataSourceFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportedURIFiltersByRef

void setSupportedURIFiltersByRef(IArray pppItemURIFilterArray)
                                 throws IOException,
                                        AutomationException

Default URI filters supported by the raster type.

Product Availability

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

Parameters:

pppItemURIFilterArray - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedURIFilters

IArray getSupportedURIFilters()
                              throws IOException,
                                     AutomationException

Default URI filters supported by the raster type.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsOrthorectification

void setSupportsOrthorectification(boolean pbSupportsOrthorectification)
                                   throws IOException,
                                          AutomationException

Indicates whether the raster type supports orthorectification.

Product Availability

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

Parameters:

pbSupportsOrthorectification - The pbSupportsOrthorectification (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsOrthorectification

boolean isSupportsOrthorectification()
                                     throws IOException,
                                            AutomationException

Indicates whether the raster type supports orthorectification.

Product Availability

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

Returns:

The pbSupportsOrthorectification

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsStereo

void setSupportsStereo(boolean pbSupportsStereo)
                       throws IOException,
                              AutomationException

Indicates whether the raster type supports stereo.

Product Availability

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

Parameters:

pbSupportsStereo - The pbSupportsStereo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsStereo

boolean isSupportsStereo()
                         throws IOException,
                                AutomationException

Indicates whether the raster type supports stereo.

Product Availability

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

Returns:

The pbSupportsStereo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsSeamline

void setSupportsSeamline(boolean pbSupportsSeamline)
                         throws IOException,
                                AutomationException

Indicates whether the raster type supports seamline.

Product Availability

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

Parameters:

pbSupportsSeamline - The pbSupportsSeamline (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsSeamline

boolean isSupportsSeamline()
                           throws IOException,
                                  AutomationException

Indicates whether the raster type supports seamline.

Product Availability

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

Returns:

The pbSupportsSeamline

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableClipToFootprint

void setEnableClipToFootprint(boolean pbEnableClipToFootprint)
                              throws IOException,
                                     AutomationException

Indicates whether datasets are clipped to their footprints.

Product Availability

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

Parameters:

pbEnableClipToFootprint - The pbEnableClipToFootprint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableClipToFootprint

boolean isEnableClipToFootprint()
                                throws IOException,
                                       AutomationException

Indicates whether datasets are clipped to their footprints.

Product Availability

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

Returns:

The pbEnableClipToFootprint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddRastersParameters

void setAddRastersParameters(IAddRastersParameters ppAddRastersParameters)
                             throws IOException,
                                    AutomationException

The parameters controlling how rasters are added using this raster type.

Product Availability

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

Parameters:

ppAddRastersParameters - A reference to a com.esri.arcgis.datasourcesraster.IAddRastersParameters (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAddRastersParameters

IAddRastersParameters getAddRastersParameters()
                                              throws IOException,
                                                     AutomationException

The parameters controlling how rasters are added using this raster type.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSynchronizeParameters

void setSynchronizeParameters(ISynchronizeParameters ppSynchronizeParameters)
                              throws IOException,
                                     AutomationException

The parameters controlling how rasters are synchronized using this raster type instance.

Product Availability

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

Parameters:

ppSynchronizeParameters - A reference to a com.esri.arcgis.datasourcesraster.ISynchronizeParameters (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSynchronizeParameters

ISynchronizeParameters getSynchronizeParameters()
                                                throws IOException,
                                                       AutomationException

The parameters controlling how rasters are synchronized using this raster type instance.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOrthorectificationParametersByRef

void setOrthorectificationParametersByRef(IGeometricFunctionArguments ppIGeometricFunctionArguments)
                                          throws IOException,
                                                 AutomationException

The parameters controlling orthorectification of raster datasets built by this raster type.

Product Availability

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

Parameters:

ppIGeometricFunctionArguments - A reference to a com.esri.arcgis.datasourcesraster.IGeometricFunctionArguments (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrthorectificationParameters

IGeometricFunctionArguments getOrthorectificationParameters()
                                                            throws IOException,
                                                                   AutomationException

The parameters controlling orthorectification of raster datasets built by this raster type.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFirstAddTimeStamp

void setFirstAddTimeStamp(Date pFirstAddTimeStamp)
                          throws IOException,
                                 AutomationException

The time when this raster type was first used for adding rasters to the mosaic dataset. The value in this property also appears in the moasic dataset's raster type table.

Product Availability

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

Parameters:

pFirstAddTimeStamp - The pFirstAddTimeStamp (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFirstAddTimeStamp

Date getFirstAddTimeStamp()
                          throws IOException,
                                 AutomationException

The time when this raster type was first used for adding rasters to the mosaic dataset. The value in this property also appears in the moasic dataset's raster type table.

Product Availability

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

Returns:

The pFirstAddTimeStamp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLastAddTimeStamp

void setLastAddTimeStamp(Date pLastAddTimeStamp)
                         throws IOException,
                                AutomationException

The time when this raster type was last used for adding rasters to the mosaic dataset. The value in this property also appears in the moasic dataset's raster type table.

Product Availability

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

Parameters:

pLastAddTimeStamp - The pLastAddTimeStamp (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastAddTimeStamp

Date getLastAddTimeStamp()
                         throws IOException,
                                AutomationException

The time when this raster type was last used for adding rasters to the mosaic dataset. The value in this property also appears in the moasic dataset's raster type table.

Product Availability

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

Returns:

The pLastAddTimeStamp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLastSyncTimeStamp

void setLastSyncTimeStamp(Date pLastSyncTimeStamp)
                          throws IOException,
                                 AutomationException

The time when this raster type was last used for synchronizing one or more rasters in the mosaic dataset. The value in this property also appears in the moasic dataset's raster type table.

Product Availability

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

Parameters:

pLastSyncTimeStamp - The pLastSyncTimeStamp (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastSyncTimeStamp

Date getLastSyncTimeStamp()
                          throws IOException,
                                 AutomationException

The time when this raster type was last used for synchronizing one or more rasters in the mosaic dataset. The value in this property also appears in the moasic dataset's raster type table.

Product Availability

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

Returns:

The pLastSyncTimeStamp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOperationDescription

void setOperationDescription(String pOperationDescription)
                             throws IOException,
                                    AutomationException

A user-identifiable description of the collection of items added by this raster type instance.

Product Availability

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

Parameters:

pOperationDescription - The pOperationDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOperationDescription

String getOperationDescription()
                               throws IOException,
                                      AutomationException

A user-identifiable description of the collection of items added by this raster type instance.

Product Availability

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

Returns:

The pOperationDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.