|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.globecore.GPDeleteGlobeCache
public class GPDeleteGlobeCache
Delete pre-rendered tile cache for the GlobeServer.
Constructor Summary | |
---|---|
GPDeleteGlobeCache()
Constructs a GPDeleteGlobeCache using ArcGIS Engine. |
|
GPDeleteGlobeCache(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. GPDeleteGlobeCache theGPDeleteGlobeCache = (GPDeleteGlobeCache) obj; |
Method Summary | |
---|---|
boolean |
equals(Object o)
Compare this object with another |
void |
execute(IArray paramvalues,
ITrackCancel trackCancel,
IGPEnvironmentManager envMgr,
IGPMessages message)
Executes the geoprocessing function using the given array of parameter values. |
static String |
getClsid()
getClsid. |
IUID |
getDialogCLSID()
The class identifier (CLSID) of the custom dialog object to use when invoking the geoprocessing function. |
String |
getDisplayName()
Displayed name of the geoprocessing function. |
IName |
getFullName()
The function name object of the geoprocessing function. |
int |
getHelpContext()
The context identifier of the topic within the help file for this function object. |
String |
getHelpFile()
Name of the (CHM) file containing help information for this function object. |
String |
getMetadataFile()
Name of the (XML) file containing the default metadata for this function object. |
String |
getName()
Name of the geoprocessing function. |
IArray |
getParameterInfo()
The list of parameters accepted by the geoprocessing function. |
Object |
getRenderer(IGPParameter pParam)
Returns the custom renderer to use for the specified parameter. |
int |
hashCode()
the hashcode for this object |
boolean |
isLicensed()
Returns whether the geoprocessing function has all necessary licenses in order to execute. |
IGPMessages |
validate(IArray paramvalues,
boolean updateValues,
IGPEnvironmentManager envMgr)
Validates the given array of parameter values. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public GPDeleteGlobeCache() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic GPDeleteGlobeCache(Object obj) throws IOException
GPDeleteGlobeCache theGPDeleteGlobeCache = (GPDeleteGlobeCache) obj;
obj
to GPDeleteGlobeCache
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public String getName() throws IOException, AutomationException
The Name property sets the name of a function tool. This name appears when using the function tool at the command line or in scripting. It must be unique within a given toolbox and must not contain any spaces.
getName
in interface IGPFunction
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getDisplayName() throws IOException, AutomationException
The DisplayName property sets the user-friendly name of a function tool. It is displayed in the graphic user interface of the ArcToolbox window. The DisplayName can be internationalized.
getDisplayName
in interface IGPFunction
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray getParameterInfo() throws IOException, AutomationException
The ParameterInfo property is the place where a function tool's parameters are defined. It returns an IArray of parameter objects (IGPParameter); these objects define the characteristics of the input and output parameters.
getParameterInfo
in interface IGPFunction
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IUID getDialogCLSID() throws IOException, AutomationException
The DialogCLSID property is used to overwrite the default system tool dialog's look and feel. By default, Toolbox creates a dialog based upon the parameters returned by the ParameterInfo property.
getDialogCLSID
in interface IGPFunction
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IName getFullName() throws IOException, AutomationException
The FullName property is the function name object for the GPFunction. It is created and returned by the GPFunctionFactory. The GPFunctionFactory must first be created before the FullName property can be implemented. Refer to IGPFunctionFactory for more detail.
getFullName
in interface IGPFunction
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getHelpFile() throws IOException, AutomationException
The HelpFile porperty stores the path to a .chm file which contains a description of the tool parameters and explains the tool's operation and usage.
getHelpFile
in interface IGPFunction
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getHelpContext() throws IOException, AutomationException
The HelpContext property is a unique ID for the help topic from a HelpFile.
getHelpContext
in interface IGPFunction
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getMetadataFile() throws IOException, AutomationException
The MetadataFile property stores the name of a .xml file with the default metadata for a function tool. The .xml file supplies parameter descriptions in the help panel of a tool dialog. If no .chm file is provided through the HelpFile property, a tool's help is based on the .xml file's content.
getMetadataFile
in interface IGPFunction
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isLicensed() throws IOException, AutomationException
The IsLicensed property is used to check if a function tool is licensed to execute in the active application.
isLicensed
in interface IGPFunction
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getRenderer(IGPParameter pParam) throws IOException, AutomationException
The GetRenderer property is used to set a custom renderer for a function tool's output.
getRenderer
in interface IGPFunction
pParam
- A reference to a com.esri.arcgis.geoprocessing.IGPParameter (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGPMessages validate(IArray paramvalues, boolean updateValues, IGPEnvironmentManager envMgr) throws IOException, AutomationException
The Validate method checks that a function tool's set of parameter values are of the expected number, data type, and value.
validate
in interface IGPFunction
paramvalues
- A reference to a com.esri.arcgis.system.IArray (in)updateValues
- The updateValues (in)envMgr
- A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void execute(IArray paramvalues, ITrackCancel trackCancel, IGPEnvironmentManager envMgr, IGPMessages message) throws IOException, AutomationException
execute
in interface IGPFunction
paramvalues
- A reference to a com.esri.arcgis.system.IArray (in)trackcancel
- A reference to a com.esri.arcgis.system.ITrackCancel (in)envMgr
- A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)message
- A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |