Class ImageServerClass
[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
pItemDescriptionsIRasterItemDescriptions
Returns
ComputeHistograms(IGeometry, IMosaicRule, IPoint, IRenderingRule)
Computes histograms within an area of interest.
virtual IRasterHistograms ComputeHistograms(IGeometry pGeometry, IMosaicRule pMosaicRule, IPoint pCellsize, IRenderingRule pRenderingRule)
Parameters
pGeometryIGeometrypMosaicRuleIMosaicRulepCellsizeIPointpRenderingRuleIRenderingRule
Returns
ConfigurationName
Name of the server object configuration that defines the server object.
virtual string ConfigurationName { get; }
Returns
Construct(IPropertySet)
Two phase object construction.
virtual void Construct(IPropertySet props)
Parameters
propsIPropertySet
Deactivate()
Deactivates the object.
virtual void Deactivate()
Delete(IFIDSet)
Deletes a given list of raster items (images).
virtual IImageServerEditResults Delete(IFIDSet pRIDs)
Parameters
pRIDsIFIDSet
Returns
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
Returns
ExecuteAISRequest(IAISRequest)
Executes an AIS request.
virtual string ExecuteAISRequest(IAISRequest pRequest)
Parameters
pRequestIAISRequest
Returns
ExportImage(IGeoImageDescription, IImageType)
Exports into a well-known image for a given image description.
virtual IImageResult ExportImage(IGeoImageDescription pImageDescription, IImageType pImageType)
Parameters
pImageDescriptionIGeoImageDescriptionpImageTypeIImageType
Returns
Fields
The fields of the image catalog.
virtual IFields Fields { get; }
Returns
FindExtensionByCLSID(string)
Returns a server object extension found using a string representation of its class ID.
virtual IServerObjectExtension FindExtensionByCLSID(string CLSID)
Parameters
CLSIDstring
Returns
FindExtensionByTypeName(string)
Returns a server object extension found using its type name.
virtual IServerObjectExtension FindExtensionByTypeName(string Name)
Parameters
Namestring
Returns
GenerateServiceInfo(IRenderingRule)
Generates the image service information as if a given rendering rule is applied.
virtual IImageServiceInfo GenerateServiceInfo(IRenderingRule pRenderingRule)
Parameters
pRenderingRuleIRenderingRule
Returns
GetCacheControlInfo()
Gets the cache description information for a given map.
virtual ICacheControlInfo GetCacheControlInfo()
Returns
GetCacheDescriptionInfo()
Gets the cache description information for a given map.
virtual ICacheDescriptionInfo GetCacheDescriptionInfo()
Returns
GetCacheStorageInfo()
Gets the cache storage information.
virtual ICacheStorageInfo GetCacheStorageInfo()
Returns
GetCatalogItemCount(IQueryFilter)
Gets the catalog item count for a given query filter.
virtual int GetCatalogItemCount(IQueryFilter pFilter)
Parameters
pFilterIQueryFilter
Returns
GetCatalogItemIDs(IQueryFilter)
Gets the catalog item IDs for a given query filter.
virtual IFIDSet GetCatalogItemIDs(IQueryFilter pFilter)
Parameters
pFilterIQueryFilter
Returns
GetCatalogItems(IQueryFilter)
Gets the catalog items for a given query filter.
virtual IRecordSet GetCatalogItems(IQueryFilter pFilter)
Parameters
pFilterIQueryFilter
Returns
GetFile(IImageServerDownloadResult)
Get the URL to a given download result.
virtual string GetFile(IImageServerDownloadResult pFile)
Parameters
Returns
GetImage(IGeoImageDescription)
Gets an image for a given image description.
virtual byte[] GetImage(IGeoImageDescription pImageDescription)
Parameters
pImageDescriptionIGeoImageDescription
Returns
- byte[]
GetImageCoordinateSystem(int)
Gets the image coordinate system of a given raster.
virtual ISpatialReference GetImageCoordinateSystem(int RID)
Parameters
RIDint
Returns
GetImageSupportData(int)
Gets the image support data.
virtual string GetImageSupportData(int RID)
Parameters
RIDint
Returns
GetImageTile(int, int, int)
Gets a tile for a given tile location.
virtual byte[] GetImageTile(int Level, int Row, int Column)
Parameters
Returns
- byte[]
GetKeyProperties(IRenderingRule)
Gets the service key properties based on a rendering rule.
virtual IPropertySet GetKeyProperties(IRenderingRule pRenderingRule)
Parameters
pRenderingRuleIRenderingRule
Returns
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
Returns
- byte[]
GetNativeRasterInfo(int)
Gets raster information of all raw source rasters for a given raster catalog item.
virtual IRasterInfos GetNativeRasterInfo(int RID)
Parameters
RIDint
Returns
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
Returns
- byte[]
GetRasterInfo(int)
Gets the image information of a given raster catalog item.
virtual IRasterInfo GetRasterInfo(int RID)
Parameters
RIDint
Returns
GetRasterKeyProperties(int)
The key properties for a given raster catalog item.
virtual IPropertySet GetRasterKeyProperties(int RID)
Parameters
RIDint
Returns
GetRasterMetadata(int)
Gets the metadata of a given raster catalog item.
virtual string GetRasterMetadata(int RID)
Parameters
RIDint
Returns
GetSchema()
Obtains REST request schema.
virtual string GetSchema()
Returns
GetSensorProperties(int)
Gets the image coordinate system of a given raster.
virtual IPropertySet GetSensorProperties(int RID)
Parameters
RIDint
Returns
GetThumbnail(int)
Gets the thumbnail image of a given raster catalog item.
virtual IImageResult GetThumbnail(int RID)
Parameters
RIDint
Returns
GetTileCacheInfo()
Gets the cache configuration.
virtual ITileCacheInfo GetTileCacheInfo()
Returns
GetTileImageInfo()
Gets the cache tile image information.
virtual ITileImageInfo GetTileImageInfo()
Returns
GetVirtualCacheDirectory()
Gets the virtual cache directory for a given layer within a map.
virtual string GetVirtualCacheDirectory()
Returns
HandleBinaryRequest(ref byte[])
Handles a binary request.
virtual byte[] HandleBinaryRequest(ref byte[] request)
Parameters
requestbyte[]
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
CapabilitiesstringresourceNamestringoperationNamestringoperationInputstringoutputFormatstringrequestPropertiesstringresponsePropertiesstring
Returns
- byte[]
HandleStringRequest(string, string)
Handles a SOAP string request.
virtual string HandleStringRequest(string Capabilities, string request)
Parameters
Returns
IImageServerEx_Add(IRasterItemDescriptions)
Adds a list of raster items for sharing with other users (roles).
virtual IImageServerEditResults IImageServerEx_Add(IRasterItemDescriptions pItemDescriptions)
Parameters
pItemDescriptionsIRasterItemDescriptions
Returns
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
pGeometryIGeometrypMosaicRuleIMosaicRulepCellsizeIPointpRenderingRuleIRenderingRule
Returns
IImageServerEx_Delete(IFIDSet)
Deletes a given list of raster items (images).
virtual IImageServerEditResults IImageServerEx_Delete(IFIDSet pRIDs)
Parameters
pRIDsIFIDSet
Returns
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
Returns
IImageServerEx_ExecuteAISRequest(IAISRequest)
Executes an AIS request.
virtual string IImageServerEx_ExecuteAISRequest(IAISRequest pRequest)
Parameters
pRequestIAISRequest
Returns
IImageServerEx_ExportImage(IGeoImageDescription, IImageType)
Exports into a well-known image for a given image description.
virtual IImageResult IImageServerEx_ExportImage(IGeoImageDescription pImageDescription, IImageType pImageType)
Parameters
pImageDescriptionIGeoImageDescriptionpImageTypeIImageType
Returns
IImageServerEx_Fields
The fields of the image catalog.
virtual IFields IImageServerEx_Fields { get; }
Returns
IImageServerEx_GenerateServiceInfo(IRenderingRule)
Generates the image service information as if a given rendering rule is applied.
virtual IImageServiceInfo IImageServerEx_GenerateServiceInfo(IRenderingRule pRenderingRule)
Parameters
pRenderingRuleIRenderingRule
Returns
IImageServerEx_GetCatalogItemCount(IQueryFilter)
Gets the catalog item count for a given query filter.
virtual int IImageServerEx_GetCatalogItemCount(IQueryFilter pFilter)
Parameters
pFilterIQueryFilter
Returns
IImageServerEx_GetCatalogItemIDs(IQueryFilter)
Gets the catalog item IDs for a given query filter.
virtual IFIDSet IImageServerEx_GetCatalogItemIDs(IQueryFilter pFilter)
Parameters
pFilterIQueryFilter
Returns
IImageServerEx_GetCatalogItems(IQueryFilter)
Gets the catalog items for a given query filter.
virtual IRecordSet IImageServerEx_GetCatalogItems(IQueryFilter pFilter)
Parameters
pFilterIQueryFilter
Returns
IImageServerEx_GetFile(IImageServerDownloadResult)
Get the URL to a given download result.
virtual string IImageServerEx_GetFile(IImageServerDownloadResult pFile)
Parameters
Returns
IImageServerEx_GetImage(IGeoImageDescription)
Gets an image for a given image description.
virtual byte[] IImageServerEx_GetImage(IGeoImageDescription pImageDescription)
Parameters
pImageDescriptionIGeoImageDescription
Returns
- byte[]
IImageServerEx_GetImageCoordinateSystem(int)
Gets the image coordinate system of a given raster.
virtual ISpatialReference IImageServerEx_GetImageCoordinateSystem(int RID)
Parameters
RIDint
Returns
IImageServerEx_GetImageSupportData(int)
Gets the image support data.
virtual string IImageServerEx_GetImageSupportData(int RID)
Parameters
RIDint
Returns
IImageServerEx_GetKeyProperties(IRenderingRule)
Gets the service key properties based on a rendering rule.
virtual IPropertySet IImageServerEx_GetKeyProperties(IRenderingRule pRenderingRule)
Parameters
pRenderingRuleIRenderingRule
Returns
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
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
RIDint
Returns
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
Returns
- byte[]
IImageServerEx_GetRasterInfo(int)
Gets the image information of a given raster catalog item.
virtual IRasterInfo IImageServerEx_GetRasterInfo(int RID)
Parameters
RIDint
Returns
IImageServerEx_GetRasterKeyProperties(int)
The key properties for a given raster catalog item.
virtual IPropertySet IImageServerEx_GetRasterKeyProperties(int RID)
Parameters
RIDint
Returns
IImageServerEx_GetRasterMetadata(int)
Gets the metadata of a given raster catalog item.
virtual string IImageServerEx_GetRasterMetadata(int RID)
Parameters
RIDint
Returns
IImageServerEx_GetSensorProperties(int)
Gets the image coordinate system of a given raster.
virtual IPropertySet IImageServerEx_GetSensorProperties(int RID)
Parameters
RIDint
Returns
IImageServerEx_GetThumbnail(int)
Gets the thumbnail image of a given raster catalog item.
virtual IImageResult IImageServerEx_GetThumbnail(int RID)
Parameters
RIDint
Returns
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
pLocationIGeometrypMosaicRuleIMosaicRulepCellsizeIPoint
Returns
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
pLocationsIGeometrypMosaicRuleIMosaicRulepCellsizeIPointpRenderingRuleIRenderingRuleoptionsstring
Returns
IImageServerEx_KeyProperties
The image service key properties.
virtual IPropertySet IImageServerEx_KeyProperties { get; }
Returns
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
pFromIGeometrypToIGeometrypMosaicRuleIMosaicRulepCellsizeIPointoperationesriMensurationOperation
Returns
IImageServerEx_Metadata
The image service metadata.
virtual string IImageServerEx_Metadata { get; }
Returns
IImageServerEx_MultidimensionalInfo
The image service multidimensional info.
virtual IMultidimensionalInfo IImageServerEx_MultidimensionalInfo { get; }
Returns
IImageServerEx_RasterAttributeTable
The raster attribute table.
virtual IRecordSet IImageServerEx_RasterAttributeTable { get; }
Returns
IImageServerEx_ServiceInfo
The properties of the image service provided.
virtual IImageServiceInfo IImageServerEx_ServiceInfo { get; }
Returns
IImageServerEx_Update(IFIDSet, IRasterItemDescriptions)
Updates a given list of raster items (images).
virtual IImageServerEditResults IImageServerEx_Update(IFIDSet pRIDs, IRasterItemDescriptions pItemDescriptions)
Parameters
pRIDsIFIDSetpItemDescriptionsIRasterItemDescriptions
Returns
IImageServerEx_Version
The Image Server version number.
virtual float IImageServerEx_Version { get; }
Returns
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
pLocationIGeometrypMosaicRuleIMosaicRulepCellsizeIPoint
Returns
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
pLocationsIGeometrypMosaicRuleIMosaicRulepCellsizeIPointpRenderingRuleIRenderingRuleoptionsstring
Returns
ImageDataSourceName
The image server data source name.
virtual IName ImageDataSourceName { get; set; }
Returns
InitLogging(ILog)
Initializes an object with a log.
virtual void InitLogging(ILog Log)
Parameters
LogILog
Initialize(string)
Initializes this image server from a fullname to a dataset.
virtual void Initialize(string FullName)
Parameters
FullNamestring
InitializeFromDataset(IRasterDataset)
Initializes this image server from a Raster Dataset.
virtual void InitializeFromDataset(IRasterDataset pDataset)
Parameters
pDatasetIRasterDataset
InitializeFromServiceURL(string)
Initializes this image server from an AIS service URL (ImageService://<host>:<port>/<service>).
virtual void InitializeFromServiceURL(string ServiceURL)
Parameters
ServiceURLstring
InterfaceSupportsErrorInfo(ref Guid)
virtual void InterfaceSupportsErrorInfo(ref Guid riid)
Parameters
riidGuid
IsFixedScaleImage()
Indicates if it is fixed scale image.
virtual bool IsFixedScaleImage()
Returns
KeyProperties
The image service key properties.
virtual IPropertySet KeyProperties { get; }
Returns
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
pFromIGeometrypToIGeometrypMosaicRuleIMosaicRulepCellsizeIPointoperationesriMensurationOperation
Returns
Metadata
The image service metadata.
virtual string Metadata { get; }
Returns
MosaicDataset
The mosaic dataset.
virtual IMosaicDataset MosaicDataset { get; }
Returns
MultidimensionalInfo
The image service multidimensional info.
virtual IMultidimensionalInfo MultidimensionalInfo { get; }
Returns
PhysicalCacheDirectory
The physical directory for cache files.
virtual string PhysicalCacheDirectory { get; }
Returns
PhysicalOutputDirectory
The physical directory for output files.
virtual string PhysicalOutputDirectory { get; }
Returns
Raster
The raster.
virtual IRaster Raster { get; }
Returns
RasterAttributeTable
The raster attribute table.
virtual IRecordSet RasterAttributeTable { get; }
Returns
RasterDataset
The raster dataset.
virtual IRasterDataset RasterDataset { get; }
Returns
ServiceInfo
The properties of the image service provided.
virtual IImageServiceInfo ServiceInfo { get; }
Returns
ToRasterFunctionTemplate(string)
Constructs a raster function template from a known template name.
virtual IRasterFunctionTemplate ToRasterFunctionTemplate(string Name)
Parameters
Namestring
Returns
TypeName
Type of the server object (MapServer or GeocodeServer).
virtual string TypeName { get; }
Returns
Update(IFIDSet, IRasterItemDescriptions)
Updates a given list of raster items (images).
virtual IImageServerEditResults Update(IFIDSet pRIDs, IRasterItemDescriptions pItemDescriptions)
Parameters
pRIDsIFIDSetpItemDescriptionsIRasterItemDescriptions
Returns
Version
The Image Server version number.
virtual float Version { get; }
Returns
VirtualOutputDirectory
The virtual directory for output files.
virtual string VirtualOutputDirectory { get; }