com.esri.arcgis.datasourcesraster
Interface IItemTemplate2

All Superinterfaces:

IItemTemplate, Serializable

All Known Implementing Classes:

ItemTemplate

public interface IItemTemplate2
extends IItemTemplate, Serializable

Provides access to members that control an item template.

Product Availability

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

Method Summary

void	addAncillaryDataset(String sOutputDatasetTag, String sFunctionTemplateName, String sPrimaryChainConnectorVariable) Adds additional outgoing tags for non-primary datasets that can be built using this item template.
void	enableEnhancement(boolean bEnableEnhancement) Enable or disable functions that enhance a dataset.
void	getAncillaryDatasets(IStringArray[] ppOutputDatasetTags, IStringArray[] ppFunctionTemplateNames, IStringArray[] ppPrimaryChainConnectorVariables) Returns a collection of tags and associated function template names and connector variables of all non-primary datasets built by the item template.
IGeoTransformationHelper	getGeoTransformationHelper() The geographic tranformation helper object, set by the calling application, that enables the item template to install geotransformation method in to the system's GeoTransformationOperationSet.
boolean	isEnhancementEnabled() Indicates whether the item template will enhance datasets.
boolean	isSensorTemplate() Indicates whether the item template can be used to build sensor data sources (as opposed to regular raster data sources).
boolean	isSupportsEnhancement() Indicates whether the item template contains functions that enhance a dataset.
void	setGeoTransformationHelperByRef(IGeoTransformationHelper ppGeoTransformationHelper) The geographic tranformation helper object, set by the calling application, that enables the item template to install geotransformation method in to the system's GeoTransformationOperationSet.
void	setIsSensorTemplate(boolean pbIsSensorTemplate) Indicates whether the item template can be used to build sensor data sources (as opposed to regular raster data sources).
void	setSupportsEnhancement(boolean pbSupportsEnhancement) Indicates whether the item template contains functions that enhance a dataset.

Methods inherited from interface com.esri.arcgis.datasourcesraster.IItemTemplate

getName, getOutputDatasetTag, getPrimaryInputDatasetTag, getRasterFunctionTemplate, isEnabled, isIntersectFootprints, setEnabled, setIntersectFootprints, setName, setOutputDatasetTag, setPrimaryInputDatasetTag, setRasterFunctionTemplateByRef

Method Detail

setSupportsEnhancement

void setSupportsEnhancement(boolean pbSupportsEnhancement)
                            throws IOException,
                                   AutomationException

Indicates whether the item template contains functions that enhance a dataset.

Product Availability

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

Parameters:

pbSupportsEnhancement - The pbSupportsEnhancement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsEnhancement

boolean isSupportsEnhancement()
                              throws IOException,
                                     AutomationException

Indicates whether the item template contains functions that enhance a dataset.

Product Availability

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

Returns:

The pbSupportsEnhancement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enableEnhancement

void enableEnhancement(boolean bEnableEnhancement)
                       throws IOException,
                              AutomationException

Enable or disable functions that enhance a dataset.

Product Availability

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

Parameters:

bEnableEnhancement - The bEnableEnhancement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnhancementEnabled

boolean isEnhancementEnabled()
                             throws IOException,
                                    AutomationException

Indicates whether the item template will enhance datasets.

Product Availability

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

Returns:

The pbEnable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsSensorTemplate

void setIsSensorTemplate(boolean pbIsSensorTemplate)
                         throws IOException,
                                AutomationException

Indicates whether the item template can be used to build sensor data sources (as opposed to regular raster data sources).

Product Availability

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

Parameters:

pbIsSensorTemplate - The pbIsSensorTemplate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSensorTemplate

boolean isSensorTemplate()
                         throws IOException,
                                AutomationException

Indicates whether the item template can be used to build sensor data sources (as opposed to regular raster data sources).

Product Availability

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

Returns:

The pbIsSensorTemplate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeoTransformationHelperByRef

void setGeoTransformationHelperByRef(IGeoTransformationHelper ppGeoTransformationHelper)
                                     throws IOException,
                                            AutomationException

The geographic tranformation helper object, set by the calling application, that enables the item template to install geotransformation method in to the system's GeoTransformationOperationSet.

Product Availability

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

Parameters:

ppGeoTransformationHelper - A reference to a com.esri.arcgis.datasourcesraster.IGeoTransformationHelper (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeoTransformationHelper

IGeoTransformationHelper getGeoTransformationHelper()
                                                    throws IOException,
                                                           AutomationException

The geographic tranformation helper object, set by the calling application, that enables the item template to install geotransformation method in to the system's GeoTransformationOperationSet.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addAncillaryDataset

void addAncillaryDataset(String sOutputDatasetTag,
                         String sFunctionTemplateName,
                         String sPrimaryChainConnectorVariable)
                         throws IOException,
                                AutomationException

Adds additional outgoing tags for non-primary datasets that can be built using this item template. This method also accepts an optional name of a template function that resides within the primary raster function template associated within this item template wh????&

Product Availability

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

Parameters:

sOutputDatasetTag - The sOutputDatasetTag (in)

sFunctionTemplateName - The sFunctionTemplateName (in)

sPrimaryChainConnectorVariable - The sPrimaryChainConnectorVariable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAncillaryDatasets

void getAncillaryDatasets(IStringArray[] ppOutputDatasetTags,
                          IStringArray[] ppFunctionTemplateNames,
                          IStringArray[] ppPrimaryChainConnectorVariables)
                          throws IOException,
                                 AutomationException

Returns a collection of tags and associated function template names and connector variables of all non-primary datasets built by the item template.

Product Availability

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

Parameters:

ppOutputDatasetTags - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

ppFunctionTemplateNames - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

ppPrimaryChainConnectorVariables - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.