com.esri.arcgis.carto
Interface IImageServiceInfo

All Superinterfaces:

Serializable

All Known Subinterfaces:

IImageServiceInfo2

All Known Implementing Classes:

ImageServiceInfo

public interface IImageServiceInfo
extends Serializable

Provides access to the properties of an image service.

Superseded By

IImageServiceInfo2

Description

This interface is new at ArcGIS 9.3.

Remarks

IImageServiceInfo allows you to access the properties of an image service. The properties include description, spatial reference, extent, pixel type, dimension, etc. There is no colormap, histogram or attribute table.

Product Availability

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

Method Summary

int	getBandCount() The number of bands.
String	getCopyrightText() Copyright information associated with the image service.
String	getDefaultServiceProperties() The default service properties.
String	getDescription() The description of the image service.
IEnvelope	getExtent() The extent of the image service.
double	getMaximumPixelSize() The maximum visible pixel size.
int	getMaxNCols() The maximum number of colums this service supports.
int	getMaxNRows() The maximum number of rows this service supports.
double	getMinimumPixelSize() The minimum visible pixel size.
String	getName() The name of the image service.
Object	getNoData() The NoData (background) value of the image service.
void	getPixelSize(double[] pDx, double[] pDy) Gets the pxiel size of the image service, in its native units.
int	getPixelType() The pixel type of the image service.
int	getServiceDataType() The data type of the image service.
int	getServiceSourceType() The image service data source type.
ISpatialReference	getSpatialReference() The spatial reference of the image service.
void	getStatistics(int iBand, double[] pMin, double[] pMax, double[] pMean, double[] pStdv) Gets the statistics of a given band.
void	setCopyrightText(String pCopyright) Copyright information associated with the image service.
void	setDefaultServiceProperties(String pServiceProperties) The default service properties.
void	setServiceDataType(int pDataType) The data type of the image service.
void	setServiceSourceType(int pServiceSourceType) The image service data source type.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name of the image service.

Product Availability

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

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

The description of the image service.

Product Availability

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

Returns:

The pDescrition

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference of the image service.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the image service.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelSize

void getPixelSize(double[] pDx,
                  double[] pDy)
                  throws IOException,
                         AutomationException

Gets the pxiel size of the image service, in its native units.

Product Availability

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

Parameters:

pDx - The pDx (out: use single element array)

pDy - The pDy (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatistics

void getStatistics(int iBand,
                   double[] pMin,
                   double[] pMax,
                   double[] pMean,
                   double[] pStdv)
                   throws IOException,
                          AutomationException

Gets the statistics of a given band.

Product Availability

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

Parameters:

iBand - The iBand (in)

pMin - The pMin (out: use single element array)

pMax - The pMax (out: use single element array)

pMean - The pMean (out: use single element array)

pStdv - The pStdv (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBandCount

int getBandCount()
                 throws IOException,
                        AutomationException

The number of bands.

Product Availability

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

Returns:

The pBandCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelType

int getPixelType()
                 throws IOException,
                        AutomationException

The pixel type of the image service.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.rstPixelType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNoData

Object getNoData()
                 throws IOException,
                        AutomationException

The NoData (background) value of the image service.

Remarks

The NoData (background) value of the image service. The variant data type does not have to match the pixel type. It can be empty or outside the pixel value range. This indicates the service does not have a predefined NoData value, and will not fill NoData pixels with a predefined value.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumPixelSize

double getMaximumPixelSize()
                           throws IOException,
                                  AutomationException

The maximum visible pixel size.

Product Availability

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

Returns:

The pMaxPixelSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumPixelSize

double getMinimumPixelSize()
                           throws IOException,
                                  AutomationException

The minimum visible pixel size.

Product Availability

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

Returns:

The pMinPixelSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCopyrightText

String getCopyrightText()
                        throws IOException,
                               AutomationException

Copyright information associated with the image service.

Product Availability

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

Returns:

The pCopyright

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCopyrightText

void setCopyrightText(String pCopyright)
                      throws IOException,
                             AutomationException

Copyright information associated with the image service.

Product Availability

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

Parameters:

pCopyright - The pCopyright (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceDataType

int getServiceDataType()
                       throws IOException,
                              AutomationException

The data type of the image service.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriImageServiceDataType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServiceDataType

void setServiceDataType(int pDataType)
                        throws IOException,
                               AutomationException

The data type of the image service.

Product Availability

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

Parameters:

pDataType - A com.esri.arcgis.carto.esriImageServiceDataType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultServiceProperties

void setDefaultServiceProperties(String pServiceProperties)
                                 throws IOException,
                                        AutomationException

The default service properties.

Product Availability

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

Parameters:

pServiceProperties - The pServiceProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultServiceProperties

String getDefaultServiceProperties()
                                   throws IOException,
                                          AutomationException

The default service properties.

Product Availability

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

Returns:

The pServiceProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxNCols

int getMaxNCols()
                throws IOException,
                       AutomationException

The maximum number of colums this service supports.

Product Availability

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

Returns:

The pMaxNCols

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxNRows

int getMaxNRows()
                throws IOException,
                       AutomationException

The maximum number of rows this service supports.

Product Availability

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

Returns:

The pMaxNRows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceSourceType

int getServiceSourceType()
                         throws IOException,
                                AutomationException

The image service data source type.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriImageServiceSourceType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServiceSourceType

void setServiceSourceType(int pServiceSourceType)
                          throws IOException,
                                 AutomationException

The image service data source type.

Product Availability

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

Parameters:

pServiceSourceType - A com.esri.arcgis.carto.esriImageServiceSourceType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.