IRPDefGenerator interface

Applies To: Custom Raster Type

The RPDefGenerator Interface

All object that implement a custom raster type must implement the IRPDefGenerator Interface.

[Visual Basic 6.0]

Dim myObject As ESRI.ImageServer.RPDefGenerator.IRPDefGenerator

Properties

Name

Description

Name

[Read-only, String] Name of the raster type. Typically, it’s the same name as passed by the RPDef Generator Factory to the RPDef Generator object after reading the value from the RPDefGen file.

AddDataParameters

[String] The add data parameters which the RPDef Generator uses while finding matching items or generating RPDefs. This property should also be internally set by the ShowAddDataDialog Method.

ProcessParameters

[String] The process parameters that the RPDef Generator uses while finding matching items or generating RPDefs. This property should also be internally set by the ShowProcessParametersDialog Method.

GeneratedRPDefs

[Read-only, Array of RPDefEntry] Array of entries for which generation of RPDefs was attempted.

Status

[Read-only, String] An XML string that informs the application about the status of the last operation performed by the object.

Methods

Name

Description

Init

Initializes the RPDef Generator object. Invoked by the RPDef Generator Factory prior to returning the object to the application.

ShowAddDataDialog

Image Service Editor uses this function to shows the first UI form after a user double-clicks on the Raster Type entry. Here, you are typically presented with a form allowing them to select files, folder, or any criteria that helps in find matching source items for which RPDef generation may be attempted.

ShowProcessParametersDialog

Image Service Editor uses this function to shows an optional second UI form after a user double-clicks on the Raster Type entry. Here, you are typically presented with a form allowing them to specify additional parameters that might help in RPDef generation.

FindItemsToAdd

This function is invoked by Image Service Editor after the user has successfully dismissed the two forms. The RPDef Generator object is expected to proceed with identifying and listing the source items for which RPDef generation should be attempted.

GetItemsToAdd

The application calls this method after a successful call to the FindItemsToAdd function. This function is expected to return an Array of RPDefEntry structure containing names of source items for which RPDef Generation will soon be attempted.

GenerateRPDefs

This is the call to the object indicating that it begin RPDef Generation for each of the RPDefEntry in the Array that’s provided as an argument to this function.

GetProperty

Generic function that allows access to a recognized property.

SetProperty

Generic function that allows updates to a recognized property.

Requirements

Platform

32 bit Windows OS (WinXP)

Environment

.NET Framework

Dependency

ESRI.ImageServer.RPDefGenerator.dll (.NET Framework)