Class ImageServerClass

Namespace
ESRI.ArcGIS.Carto
Assembly
ESRI.Server.Carto.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("BD60CB15-61D8-4CCD-AF4E-EA35F4069532")]
public class ImageServerClass : ImageServer, IImageServer, IImageServerEx, IImageServerInit, ITiledImageServer, IServerObject, IObjectConstruct, IRequestHandler, ILogSupport, IObjectActivate, IServerObjectExtensionManager, ISupportErrorInfo, IImageServerObjects, IRESTRequestHandler, IRasterFunctionTemplateMapper
Inheritance
ImageServerClass
Implements
Inherited Members

Constructors

ImageServerClass()

public ImageServerClass()

Explicit Interface Implementations

Activate()

Activates the object.

virtual void Activate()

Add(IRasterItemDescriptions)

Adds a list of raster items for sharing with other users (roles).

virtual IImageServerEditResults Add(IRasterItemDescriptions pItemDescriptions)

Parameters

pItemDescriptions IRasterItemDescriptions

Returns

IImageServerEditResults

ComputeHistograms(IGeometry, IMosaicRule, IPoint, IRenderingRule)

Computes histograms within an area of interest.

virtual IRasterHistograms ComputeHistograms(IGeometry pGeometry, IMosaicRule pMosaicRule, IPoint pCellsize, IRenderingRule pRenderingRule)

Parameters

pGeometry IGeometry
pMosaicRule IMosaicRule
pCellsize IPoint
pRenderingRule IRenderingRule

Returns

IRasterHistograms

ConfigurationName

Name of the server object configuration that defines the server object.

virtual string ConfigurationName { get; }

Returns

string

Construct(IPropertySet)

Two phase object construction.

virtual void Construct(IPropertySet props)

Parameters

props IPropertySet

Deactivate()

Deactivates the object.

virtual void Deactivate()

Delete(IFIDSet)

Deletes a given list of raster items (images).

virtual IImageServerEditResults Delete(IFIDSet pRIDs)

Parameters

pRIDs IFIDSet

Returns

IImageServerEditResults

Download(IFIDSet, IGeometry, string)

Clips images to a given geometry, and returns a list of downloadable files for a given set of catalog item IDs.

virtual IImageServerDownloadResults Download(IFIDSet pFIDs, IGeometry pGeometry, string Format)

Parameters

pFIDs IFIDSet
pGeometry IGeometry
Format string

Returns

IImageServerDownloadResults

ExecuteAISRequest(IAISRequest)

Executes an AIS request.

virtual string ExecuteAISRequest(IAISRequest pRequest)

Parameters

pRequest IAISRequest

Returns

string

ExportImage(IGeoImageDescription, IImageType)

Exports into a well-known image for a given image description.

virtual IImageResult ExportImage(IGeoImageDescription pImageDescription, IImageType pImageType)

Parameters

pImageDescription IGeoImageDescription
pImageType IImageType

Returns

IImageResult

Fields

The fields of the image catalog.

virtual IFields Fields { get; }

Returns

IFields

FindExtensionByCLSID(string)

Returns a server object extension found using a string representation of its class ID.

virtual IServerObjectExtension FindExtensionByCLSID(string CLSID)

Parameters

CLSID string

Returns

IServerObjectExtension

FindExtensionByTypeName(string)

Returns a server object extension found using its type name.

virtual IServerObjectExtension FindExtensionByTypeName(string Name)

Parameters

Name string

Returns

IServerObjectExtension

GenerateServiceInfo(IRenderingRule)

Generates the image service information as if a given rendering rule is applied.

virtual IImageServiceInfo GenerateServiceInfo(IRenderingRule pRenderingRule)

Parameters

pRenderingRule IRenderingRule

Returns

IImageServiceInfo

GetCacheControlInfo()

Gets the cache description information for a given map.

virtual ICacheControlInfo GetCacheControlInfo()

Returns

ICacheControlInfo

GetCacheDescriptionInfo()

Gets the cache description information for a given map.

virtual ICacheDescriptionInfo GetCacheDescriptionInfo()

Returns

ICacheDescriptionInfo

GetCacheStorageInfo()

Gets the cache storage information.

virtual ICacheStorageInfo GetCacheStorageInfo()

Returns

ICacheStorageInfo

GetCatalogItemCount(IQueryFilter)

Gets the catalog item count for a given query filter.

virtual int GetCatalogItemCount(IQueryFilter pFilter)

Parameters

pFilter IQueryFilter

Returns

int

GetCatalogItemIDs(IQueryFilter)

Gets the catalog item IDs for a given query filter.

virtual IFIDSet GetCatalogItemIDs(IQueryFilter pFilter)

Parameters

pFilter IQueryFilter

Returns

IFIDSet

GetCatalogItems(IQueryFilter)

Gets the catalog items for a given query filter.

virtual IRecordSet GetCatalogItems(IQueryFilter pFilter)

Parameters

pFilter IQueryFilter

Returns

IRecordSet

GetFile(IImageServerDownloadResult)

Get the URL to a given download result.

virtual string GetFile(IImageServerDownloadResult pFile)

Parameters

pFile IImageServerDownloadResult

Returns

string

GetImage(IGeoImageDescription)

Gets an image for a given image description.

virtual byte[] GetImage(IGeoImageDescription pImageDescription)

Parameters

pImageDescription IGeoImageDescription

Returns

byte[]

GetImageCoordinateSystem(int)

Gets the image coordinate system of a given raster.

virtual ISpatialReference GetImageCoordinateSystem(int RID)

Parameters

RID int

Returns

ISpatialReference

GetImageSupportData(int)

Gets the image support data.

virtual string GetImageSupportData(int RID)

Parameters

RID int

Returns

string

GetImageTile(int, int, int)

Gets a tile for a given tile location.

virtual byte[] GetImageTile(int Level, int Row, int Column)

Parameters

Level int
Row int
Column int

Returns

byte[]

GetKeyProperties(IRenderingRule)

Gets the service key properties based on a rendering rule.

virtual IPropertySet GetKeyProperties(IRenderingRule pRenderingRule)

Parameters

pRenderingRule IRenderingRule

Returns

IPropertySet

GetNativePixelBlock(int, int, int, int, int)

Gets a pixel block at a given block location for a specified raw source raster.

virtual byte[] GetNativePixelBlock(int RID, int IID, int tx, int ty, int Level)

Parameters

RID int
IID int
tx int
ty int
Level int

Returns

byte[]

GetNativeRasterInfo(int)

Gets raster information of all raw source rasters for a given raster catalog item.

virtual IRasterInfos GetNativeRasterInfo(int RID)

Parameters

RID int

Returns

IRasterInfos

GetPixelBlock(int, int, int, int)

Gets a pixel block at a given block location.

virtual byte[] GetPixelBlock(int RID, int tx, int ty, int Level)

Parameters

RID int
tx int
ty int
Level int

Returns

byte[]

GetRasterInfo(int)

Gets the image information of a given raster catalog item.

virtual IRasterInfo GetRasterInfo(int RID)

Parameters

RID int

Returns

IRasterInfo

GetRasterKeyProperties(int)

The key properties for a given raster catalog item.

virtual IPropertySet GetRasterKeyProperties(int RID)

Parameters

RID int

Returns

IPropertySet

GetRasterMetadata(int)

Gets the metadata of a given raster catalog item.

virtual string GetRasterMetadata(int RID)

Parameters

RID int

Returns

string

GetSchema()

Obtains REST request schema.

virtual string GetSchema()

Returns

string

GetSensorProperties(int)

Gets the image coordinate system of a given raster.

virtual IPropertySet GetSensorProperties(int RID)

Parameters

RID int

Returns

IPropertySet

GetThumbnail(int)

Gets the thumbnail image of a given raster catalog item.

virtual IImageResult GetThumbnail(int RID)

Parameters

RID int

Returns

IImageResult

GetTileCacheInfo()

Gets the cache configuration.

virtual ITileCacheInfo GetTileCacheInfo()

Returns

ITileCacheInfo

GetTileImageInfo()

Gets the cache tile image information.

virtual ITileImageInfo GetTileImageInfo()

Returns

ITileImageInfo

GetVirtualCacheDirectory()

Gets the virtual cache directory for a given layer within a map.

virtual string GetVirtualCacheDirectory()

Returns

string

HandleBinaryRequest(ref byte[])

Handles a binary request.

virtual byte[] HandleBinaryRequest(ref byte[] request)

Parameters

request byte[]

Returns

byte[]

HandleRESTRequest(string, string, string, string, string, string, out string)

Handles REST request for SO or SOE.

virtual byte[] HandleRESTRequest(string Capabilities, string resourceName, string operationName, string operationInput, string outputFormat, string requestProperties, out string responseProperties)

Parameters

Capabilities string
resourceName string
operationName string
operationInput string
outputFormat string
requestProperties string
responseProperties string

Returns

byte[]

HandleStringRequest(string, string)

Handles a SOAP string request.

virtual string HandleStringRequest(string Capabilities, string request)

Parameters

Capabilities string
request string

Returns

string

IImageServerEx_Add(IRasterItemDescriptions)

Adds a list of raster items for sharing with other users (roles).

virtual IImageServerEditResults IImageServerEx_Add(IRasterItemDescriptions pItemDescriptions)

Parameters

pItemDescriptions IRasterItemDescriptions

Returns

IImageServerEditResults

IImageServerEx_ComputeHistograms(IGeometry, IMosaicRule, IPoint, IRenderingRule)

Computes histograms within an area of interest.

virtual IRasterHistograms IImageServerEx_ComputeHistograms(IGeometry pGeometry, IMosaicRule pMosaicRule, IPoint pCellsize, IRenderingRule pRenderingRule)

Parameters

pGeometry IGeometry
pMosaicRule IMosaicRule
pCellsize IPoint
pRenderingRule IRenderingRule

Returns

IRasterHistograms

IImageServerEx_Delete(IFIDSet)

Deletes a given list of raster items (images).

virtual IImageServerEditResults IImageServerEx_Delete(IFIDSet pRIDs)

Parameters

pRIDs IFIDSet

Returns

IImageServerEditResults

IImageServerEx_Download(IFIDSet, IGeometry, string)

Clips images to a given geometry, and returns a list of downloadable files for a given set of catalog item IDs.

virtual IImageServerDownloadResults IImageServerEx_Download(IFIDSet pFIDs, IGeometry pGeometry, string Format)

Parameters

pFIDs IFIDSet
pGeometry IGeometry
Format string

Returns

IImageServerDownloadResults

IImageServerEx_ExecuteAISRequest(IAISRequest)

Executes an AIS request.

virtual string IImageServerEx_ExecuteAISRequest(IAISRequest pRequest)

Parameters

pRequest IAISRequest

Returns

string

IImageServerEx_ExportImage(IGeoImageDescription, IImageType)

Exports into a well-known image for a given image description.

virtual IImageResult IImageServerEx_ExportImage(IGeoImageDescription pImageDescription, IImageType pImageType)

Parameters

pImageDescription IGeoImageDescription
pImageType IImageType

Returns

IImageResult

IImageServerEx_Fields

The fields of the image catalog.

virtual IFields IImageServerEx_Fields { get; }

Returns

IFields

IImageServerEx_GenerateServiceInfo(IRenderingRule)

Generates the image service information as if a given rendering rule is applied.

virtual IImageServiceInfo IImageServerEx_GenerateServiceInfo(IRenderingRule pRenderingRule)

Parameters

pRenderingRule IRenderingRule

Returns

IImageServiceInfo

IImageServerEx_GetCatalogItemCount(IQueryFilter)

Gets the catalog item count for a given query filter.

virtual int IImageServerEx_GetCatalogItemCount(IQueryFilter pFilter)

Parameters

pFilter IQueryFilter

Returns

int

IImageServerEx_GetCatalogItemIDs(IQueryFilter)

Gets the catalog item IDs for a given query filter.

virtual IFIDSet IImageServerEx_GetCatalogItemIDs(IQueryFilter pFilter)

Parameters

pFilter IQueryFilter

Returns

IFIDSet

IImageServerEx_GetCatalogItems(IQueryFilter)

Gets the catalog items for a given query filter.

virtual IRecordSet IImageServerEx_GetCatalogItems(IQueryFilter pFilter)

Parameters

pFilter IQueryFilter

Returns

IRecordSet

IImageServerEx_GetFile(IImageServerDownloadResult)

Get the URL to a given download result.

virtual string IImageServerEx_GetFile(IImageServerDownloadResult pFile)

Parameters

pFile IImageServerDownloadResult

Returns

string

IImageServerEx_GetImage(IGeoImageDescription)

Gets an image for a given image description.

virtual byte[] IImageServerEx_GetImage(IGeoImageDescription pImageDescription)

Parameters

pImageDescription IGeoImageDescription

Returns

byte[]

IImageServerEx_GetImageCoordinateSystem(int)

Gets the image coordinate system of a given raster.

virtual ISpatialReference IImageServerEx_GetImageCoordinateSystem(int RID)

Parameters

RID int

Returns

ISpatialReference

IImageServerEx_GetImageSupportData(int)

Gets the image support data.

virtual string IImageServerEx_GetImageSupportData(int RID)

Parameters

RID int

Returns

string

IImageServerEx_GetKeyProperties(IRenderingRule)

Gets the service key properties based on a rendering rule.

virtual IPropertySet IImageServerEx_GetKeyProperties(IRenderingRule pRenderingRule)

Parameters

pRenderingRule IRenderingRule

Returns

IPropertySet

IImageServerEx_GetNativePixelBlock(int, int, int, int, int)

Gets a pixel block at a given block location for a specified raw source raster.

virtual byte[] IImageServerEx_GetNativePixelBlock(int RID, int IID, int tx, int ty, int Level)

Parameters

RID int
IID int
tx int
ty int
Level int

Returns

byte[]

IImageServerEx_GetNativeRasterInfo(int)

Gets raster information of all raw source rasters for a given raster catalog item.

virtual IRasterInfos IImageServerEx_GetNativeRasterInfo(int RID)

Parameters

RID int

Returns

IRasterInfos

IImageServerEx_GetPixelBlock(int, int, int, int)

Gets a pixel block at a given block location.

virtual byte[] IImageServerEx_GetPixelBlock(int RID, int tx, int ty, int Level)

Parameters

RID int
tx int
ty int
Level int

Returns

byte[]

IImageServerEx_GetRasterInfo(int)

Gets the image information of a given raster catalog item.

virtual IRasterInfo IImageServerEx_GetRasterInfo(int RID)

Parameters

RID int

Returns

IRasterInfo

IImageServerEx_GetRasterKeyProperties(int)

The key properties for a given raster catalog item.

virtual IPropertySet IImageServerEx_GetRasterKeyProperties(int RID)

Parameters

RID int

Returns

IPropertySet

IImageServerEx_GetRasterMetadata(int)

Gets the metadata of a given raster catalog item.

virtual string IImageServerEx_GetRasterMetadata(int RID)

Parameters

RID int

Returns

string

IImageServerEx_GetSensorProperties(int)

Gets the image coordinate system of a given raster.

virtual IPropertySet IImageServerEx_GetSensorProperties(int RID)

Parameters

RID int

Returns

IPropertySet

IImageServerEx_GetThumbnail(int)

Gets the thumbnail image of a given raster catalog item.

virtual IImageResult IImageServerEx_GetThumbnail(int RID)

Parameters

RID int

Returns

IImageResult

IImageServerEx_Identify(IGeometry, IMosaicRule, IPoint)

Identifies the pixel value and catalog items at the given location.

virtual IImageServerIdentifyResult IImageServerEx_Identify(IGeometry pLocation, IMosaicRule pMosaicRule, IPoint pCellsize)

Parameters

pLocation IGeometry
pMosaicRule IMosaicRule
pCellsize IPoint

Returns

IImageServerIdentifyResult

IImageServerEx_IdentifyAll(IGeometry, IMosaicRule, IPoint, IRenderingRule, string)

Identifies the pixel values and all catalog items at the given one or more locations.

virtual IImageServerIdentifyResults IImageServerEx_IdentifyAll(IGeometry pLocations, IMosaicRule pMosaicRule, IPoint pCellsize, IRenderingRule pRenderingRule, string options)

Parameters

pLocations IGeometry
pMosaicRule IMosaicRule
pCellsize IPoint
pRenderingRule IRenderingRule
options string

Returns

IImageServerIdentifyResults

IImageServerEx_KeyProperties

The image service key properties.

virtual IPropertySet IImageServerEx_KeyProperties { get; }

Returns

IPropertySet

IImageServerEx_Measure(IGeometry, IGeometry, IMosaicRule, IPoint, esriMensurationOperation)

Measures distance, angle, area, perimeter, and height.

virtual IImageServerMeasureResult IImageServerEx_Measure(IGeometry pFrom, IGeometry pTo, IMosaicRule pMosaicRule, IPoint pCellsize, esriMensurationOperation operation)

Parameters

pFrom IGeometry
pTo IGeometry
pMosaicRule IMosaicRule
pCellsize IPoint
operation esriMensurationOperation

Returns

IImageServerMeasureResult

IImageServerEx_Metadata

The image service metadata.

virtual string IImageServerEx_Metadata { get; }

Returns

string

IImageServerEx_MultidimensionalInfo

The image service multidimensional info.

virtual IMultidimensionalInfo IImageServerEx_MultidimensionalInfo { get; }

Returns

IMultidimensionalInfo

IImageServerEx_RasterAttributeTable

The raster attribute table.

virtual IRecordSet IImageServerEx_RasterAttributeTable { get; }

Returns

IRecordSet

IImageServerEx_ServiceInfo

The properties of the image service provided.

virtual IImageServiceInfo IImageServerEx_ServiceInfo { get; }

Returns

IImageServiceInfo

IImageServerEx_Update(IFIDSet, IRasterItemDescriptions)

Updates a given list of raster items (images).

virtual IImageServerEditResults IImageServerEx_Update(IFIDSet pRIDs, IRasterItemDescriptions pItemDescriptions)

Parameters

pRIDs IFIDSet
pItemDescriptions IRasterItemDescriptions

Returns

IImageServerEditResults

IImageServerEx_Version

The Image Server version number.

virtual float IImageServerEx_Version { get; }

Returns

float

Identify(IGeometry, IMosaicRule, IPoint)

Identifies the pixel value and catalog items at the given location.

virtual IImageServerIdentifyResult Identify(IGeometry pLocation, IMosaicRule pMosaicRule, IPoint pCellsize)

Parameters

pLocation IGeometry
pMosaicRule IMosaicRule
pCellsize IPoint

Returns

IImageServerIdentifyResult

IdentifyAll(IGeometry, IMosaicRule, IPoint, IRenderingRule, string)

Identifies the pixel values and all catalog items at the given one or more locations.

virtual IImageServerIdentifyResults IdentifyAll(IGeometry pLocations, IMosaicRule pMosaicRule, IPoint pCellsize, IRenderingRule pRenderingRule, string options)

Parameters

pLocations IGeometry
pMosaicRule IMosaicRule
pCellsize IPoint
pRenderingRule IRenderingRule
options string

Returns

IImageServerIdentifyResults

ImageDataSourceName

The image server data source name.

virtual IName ImageDataSourceName { get; set; }

Returns

IName

InitLogging(ILog)

Initializes an object with a log.

virtual void InitLogging(ILog Log)

Parameters

Log ILog

Initialize(string)

Initializes this image server from a fullname to a dataset.

virtual void Initialize(string FullName)

Parameters

FullName string

InitializeFromDataset(IRasterDataset)

Initializes this image server from a Raster Dataset.

virtual void InitializeFromDataset(IRasterDataset pDataset)

Parameters

pDataset IRasterDataset

InitializeFromServiceURL(string)

Initializes this image server from an AIS service URL (ImageService://<host>:<port>/<service>).

virtual void InitializeFromServiceURL(string ServiceURL)

Parameters

ServiceURL string

InterfaceSupportsErrorInfo(ref Guid)

virtual void InterfaceSupportsErrorInfo(ref Guid riid)

Parameters

riid Guid

IsFixedScaleImage()

Indicates if it is fixed scale image.

virtual bool IsFixedScaleImage()

Returns

bool

KeyProperties

The image service key properties.

virtual IPropertySet KeyProperties { get; }

Returns

IPropertySet

Measure(IGeometry, IGeometry, IMosaicRule, IPoint, esriMensurationOperation)

Measures distance, angle, area, perimeter, and height.

virtual IImageServerMeasureResult Measure(IGeometry pFrom, IGeometry pTo, IMosaicRule pMosaicRule, IPoint pCellsize, esriMensurationOperation operation)

Parameters

pFrom IGeometry
pTo IGeometry
pMosaicRule IMosaicRule
pCellsize IPoint
operation esriMensurationOperation

Returns

IImageServerMeasureResult

Metadata

The image service metadata.

virtual string Metadata { get; }

Returns

string

MosaicDataset

The mosaic dataset.

virtual IMosaicDataset MosaicDataset { get; }

Returns

IMosaicDataset

MultidimensionalInfo

The image service multidimensional info.

virtual IMultidimensionalInfo MultidimensionalInfo { get; }

Returns

IMultidimensionalInfo

PhysicalCacheDirectory

The physical directory for cache files.

virtual string PhysicalCacheDirectory { get; }

Returns

string

PhysicalOutputDirectory

The physical directory for output files.

virtual string PhysicalOutputDirectory { get; }

Returns

string

Raster

The raster.

virtual IRaster Raster { get; }

Returns

IRaster

RasterAttributeTable

The raster attribute table.

virtual IRecordSet RasterAttributeTable { get; }

Returns

IRecordSet

RasterDataset

The raster dataset.

virtual IRasterDataset RasterDataset { get; }

Returns

IRasterDataset

ServiceInfo

The properties of the image service provided.

virtual IImageServiceInfo ServiceInfo { get; }

Returns

IImageServiceInfo

ToRasterFunctionTemplate(string)

Constructs a raster function template from a known template name.

virtual IRasterFunctionTemplate ToRasterFunctionTemplate(string Name)

Parameters

Name string

Returns

IRasterFunctionTemplate

TypeName

Type of the server object (MapServer or GeocodeServer).

virtual string TypeName { get; }

Returns

string

Update(IFIDSet, IRasterItemDescriptions)

Updates a given list of raster items (images).

virtual IImageServerEditResults Update(IFIDSet pRIDs, IRasterItemDescriptions pItemDescriptions)

Parameters

pRIDs IFIDSet
pItemDescriptions IRasterItemDescriptions

Returns

IImageServerEditResults

Version

The Image Server version number.

virtual float Version { get; }

Returns

float

VirtualOutputDirectory

The virtual directory for output files.

virtual string VirtualOutputDirectory { get; }

Returns

string