com.esri.arcgis.datasourcesraster
Interface IRasterTypeProperties2

All Superinterfaces:

IRasterTypeProperties, Serializable

All Known Implementing Classes:

RasterType

public interface IRasterTypeProperties2
extends IRasterTypeProperties, Serializable

Provides access to members that control raster type properties.

Product Availability

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

Method Summary

IStringArray	getAliases() All the names, in addition to the primary name, by which the raster type may be referenced.
IUID	getFactoryCLSID() The CLSID of the raster type factory that created the raster type.
int	getMissingBandAction() Indicates how the raster type behaves when a band requested by the mosaic dataset's band definition is not found in the input raster.
int	getVersion() The version number associated with the raster type.
boolean	isAllowSimplification() Indicates whether the function raster datasets generated by the raster type should be simplified before being added to the mosaic dataset by 'AddRasters' or 'SynchronizeItems' operations.
boolean	isSensorRasterType() Indicates whether the raster type processes sensor data sources (as opposed to regular raster data sources).
boolean	isSupportsColorCorrection() Indicates whether the raster type supports color correction.
void	setAliasesByRef(IStringArray ppAliases) All the names, in addition to the primary name, by which the raster type may be referenced.
void	setAllowSimplification(boolean pbAllowSimplification) Indicates whether the function raster datasets generated by the raster type should be simplified before being added to the mosaic dataset by 'AddRasters' or 'SynchronizeItems' operations.
void	setFactoryCLSIDByRef(IUID ppFactoryClsid) The CLSID of the raster type factory that created the raster type.
void	setIsSensorRasterType(boolean pbIsSensorRasterType) Indicates whether the raster type processes sensor data sources (as opposed to regular raster data sources).
void	setMissingBandAction(int pMissingBandAction) Indicates how the raster type behaves when a band requested by the mosaic dataset's band definition is not found in the input raster.
void	setSupportsColorCorrection(boolean pbSupportsColorCorrection) Indicates whether the raster type supports color correction.
void	setVersion(int pVersion) The version number associated with the raster type.

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

getAddRastersParameters, getDataSourceFilter, getDescription, getFirstAddTimeStamp, getInputDataSourceTypes, getLastAddTimeStamp, getLastSyncTimeStamp, getName, getOperationDescription, getOrthorectificationParameters, getSupportedURIFilters, getSynchronizeParameters, isEnableClipToFootprint, isSupportsOrthorectification, isSupportsSeamline, isSupportsStereo, setAddRastersParameters, setDataSourceFilter, setDescription, setEnableClipToFootprint, setFirstAddTimeStamp, setInputDataSourceTypes, setLastAddTimeStamp, setLastSyncTimeStamp, setName, setOperationDescription, setOrthorectificationParametersByRef, setSupportedURIFiltersByRef, setSupportsOrthorectification, setSupportsSeamline, setSupportsStereo, setSynchronizeParameters

Method Detail

setIsSensorRasterType

void setIsSensorRasterType(boolean pbIsSensorRasterType)
                           throws IOException,
                                  AutomationException

Indicates whether the raster type processes sensor data sources (as opposed to regular raster data sources).

Product Availability

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

Parameters:

pbIsSensorRasterType - The pbIsSensorRasterType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSensorRasterType

boolean isSensorRasterType()
                           throws IOException,
                                  AutomationException

Indicates whether the raster type processes sensor data sources (as opposed to regular raster data sources).

Product Availability

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

Returns:

The pbIsSensorRasterType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAliasesByRef

void setAliasesByRef(IStringArray ppAliases)
                     throws IOException,
                            AutomationException

All the names, in addition to the primary name, by which the raster type may be referenced.

Product Availability

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

Parameters:

ppAliases - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAliases

IStringArray getAliases()
                        throws IOException,
                               AutomationException

All the names, in addition to the primary name, by which the raster type may be referenced.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllowSimplification

void setAllowSimplification(boolean pbAllowSimplification)
                            throws IOException,
                                   AutomationException

Indicates whether the function raster datasets generated by the raster type should be simplified before being added to the mosaic dataset by 'AddRasters' or 'SynchronizeItems' operations.

Product Availability

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

Parameters:

pbAllowSimplification - The pbAllowSimplification (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAllowSimplification

boolean isAllowSimplification()
                              throws IOException,
                                     AutomationException

Indicates whether the function raster datasets generated by the raster type should be simplified before being added to the mosaic dataset by 'AddRasters' or 'SynchronizeItems' operations.

Product Availability

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

Returns:

The pbAllowSimplification

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVersion

void setVersion(int pVersion)
                throws IOException,
                       AutomationException

The version number associated with the raster type.

Product Availability

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

Parameters:

pVersion - The pVersion (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVersion

int getVersion()
               throws IOException,
                      AutomationException

The version number associated with the raster type.

Product Availability

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

Returns:

The pVersion

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMissingBandAction

int getMissingBandAction()
                         throws IOException,
                                AutomationException

Indicates how the raster type behaves when a band requested by the mosaic dataset's band definition is not found in the input raster.

Product Availability

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

Returns:

A com.esri.arcgis.datasourcesraster.esriMissingBandAction constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMissingBandAction

void setMissingBandAction(int pMissingBandAction)
                          throws IOException,
                                 AutomationException

Indicates how the raster type behaves when a band requested by the mosaic dataset's band definition is not found in the input raster.

Product Availability

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

Parameters:

pMissingBandAction - A com.esri.arcgis.datasourcesraster.esriMissingBandAction constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFactoryCLSIDByRef

void setFactoryCLSIDByRef(IUID ppFactoryClsid)
                          throws IOException,
                                 AutomationException

The CLSID of the raster type factory that created the raster type.

Product Availability

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

Parameters:

ppFactoryClsid - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFactoryCLSID

IUID getFactoryCLSID()
                     throws IOException,
                            AutomationException

The CLSID of the raster type factory that created the raster type.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsColorCorrection

void setSupportsColorCorrection(boolean pbSupportsColorCorrection)
                                throws IOException,
                                       AutomationException

Indicates whether the raster type supports color correction.

Product Availability

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

Parameters:

pbSupportsColorCorrection - The pbSupportsColorCorrection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsColorCorrection

boolean isSupportsColorCorrection()
                                  throws IOException,
                                         AutomationException

Indicates whether the raster type supports color correction.

Product Availability

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

Returns:

The pbSupportsColorCorrection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.