|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.geoprocessing.MdProcess
public class MdProcess
COM Class 'MdProcess'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'
Description 'Model process object that represents a specific invokation of a particular geoprocessing tool.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =
| Field Summary | |
|---|---|
static long |
serialVersionUID
|
| Fields inherited from interface com.esri.arcgis.system.IClone |
|---|
IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy |
| Fields inherited from interface com.esri.arcgis.geoprocessing.IMdElement |
|---|
IID, IIDbf5adcdd_a477_4cd5_936a_62c939c6d46a, xxDummy |
| Fields inherited from interface com.esri.arcgis.geoprocessing.IMdProcess |
|---|
IID, IID890d0dd1_0f70_4235_9d01_09de87ec949c, xxDummy |
| Fields inherited from interface com.esri.arcgis.system.IPersistStream |
|---|
IID, IID00000109_0000_0000_c000_000000000046, xxDummy |
| Fields inherited from interface com.esri.arcgis.system.IPersist |
|---|
IID0000010c_0000_0000_c000_000000000046 |
| Fields inherited from interface com.esri.arcgis.system.IXMLSerialize |
|---|
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy |
| Fields inherited from interface com.esri.arcgis.geoprocessing.IGPToolboxEvents |
|---|
IID, IID8ec7e8d8_749a_4e24_b539_0371d8266ee0, xxDummy |
| Constructor Summary | |
|---|---|
MdProcess()
Constructs a MdProcess using ArcGIS Engine. |
|
MdProcess(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. MdProcess theMdProcess = (MdProcess) obj; |
|
| Method Summary | |
|---|---|
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
void |
deserialize(IXMLSerializeData data)
Deserializes an object from XML. |
boolean |
equals(java.lang.Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
void |
execute(ITrackCancel trackCancel,
IGPEnvironmentManager pEnvMgr,
IGPMessages messages)
Executes the current tool associated with the process using the current parameter values. |
void |
getClassID(GUID[] pClassID)
getClassID |
static java.lang.String |
getClsid()
getClsid. |
IEnumMdElement |
getDependents(int direction,
int connectionType)
Returns an enumeration of model elements that are dependent on the model element in the given direction and of the given connection type. |
IGPEnvironmentManager |
getEnvironmentManager()
The set of overriding environment values used when validating/executing the process. |
int |
getID()
Unique identifier of the model element. |
IArray |
getInputParameters()
The collection of input parameter objects used when validating/executing the process. |
com.esri.arcgis.interop.Dispatch |
getJintegraDispatch()
Deprecated. Internal use only. |
IGPMessages |
getMessages()
Returns the messages returned from the last call to Validate(). |
IMdModel |
getModel()
The model the model element is contained within. |
java.lang.String |
getName()
Name of the model element. |
IArray |
getOutputParameters()
The collection of output parameter objects used when validating/executing the process. |
IMdParameter |
getParameter(java.lang.String name)
The parameter object with the specified name. |
IArray |
getParameters()
The collection of parameter objects used when validating/executing the process. |
IGPValue |
getParameterValue(java.lang.String name)
Returns the value of specified process parameter. |
IArray |
getPreconditions()
Collection of variables that must be executed prior to executing the process. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
int |
getState()
The state of the model element. |
IGPTool |
getTool()
The tool object currently associated with the model process. |
IGPToolName |
getToolName()
The tool name object of the tool currently associated with the model process. |
int |
hashCode()
the hashcode for this object |
boolean |
isAltered()
Indicates if the model element has been altered by the user. |
boolean |
isCurrent()
Indicates if the model element is current (i.e., has been created). |
boolean |
isDependentOn(IMdElement pMdElement,
int direction,
int connectionType)
Returns whether or not the model element is dependent on the given model element in the given direction of the given connection type. |
void |
isDirty()
isDirty |
boolean |
isEqual(IClone other)
Indicates if the receiver and other have the same properties. |
boolean |
isIdentical(IClone other)
Indicates if the receiver and other are the same object. |
boolean |
isMarked()
Indicates if the model element has been marked for validation/execution. |
boolean |
isToolValid()
Returns whether or not the current tool associated with the process is valid. |
boolean |
isValid()
Indicates if the model element is valid. |
void |
load(IStream pstm)
load |
boolean |
needsRepair()
Returns whether or not the current tool associated with the process needs to be repaired (e.g., the tool parameters have changed). |
void |
onToolAdded(IGPToolboxEventsOnToolAddedEvent theEvent)
Called when a tool is added to the toolbox. |
void |
onToolboxDeleted(IGPToolboxEventsOnToolboxDeletedEvent theEvent)
Called when the toolbox is deleted. |
void |
onToolboxRenamed(IGPToolboxEventsOnToolboxRenamedEvent theEvent)
Called when the toolbox is renamed. |
void |
onToolDeleted(IGPToolboxEventsOnToolDeletedEvent theEvent)
Called when a tool is deleted from the toolbox. |
void |
onToolStateChanged(IGPToolboxEventsOnToolStateChangedEvent theEvent)
Called when a tool's state has changed. |
void |
onToolStored(IGPToolboxEventsOnToolStoredEvent theEvent)
Called when a tool is stored to the toolbox. |
void |
readExternal(java.io.ObjectInput in)
|
void |
release()
Release a MdProcess. |
void |
repairParameters()
Updates/repairs the processes collection of parameters to match the tool currently associated with the process. |
void |
save(IStream pstm,
int fClearDirty)
save |
void |
serialize(IXMLSerializeData data)
Serializes an object to XML. |
void |
setAltered(boolean altered)
Indicates if the model element has been altered by the user. |
void |
setCurrent(boolean current)
Indicates if the model element is current (i.e., has been created). |
void |
setEnvironmentManagerByRef(IGPEnvironmentManager ppEnvMgr)
The set of overriding environment values used when validating/executing the process. |
void |
setID(int identifier)
Unique identifier of the model element. |
void |
setMarked(boolean marked)
Indicates if the model element has been marked for validation/execution. |
void |
setModelByRef(IMdModel model)
The model the model element is contained within. |
void |
setName(java.lang.String name)
Name of the model element. |
void |
setParameterValue(java.lang.String name,
IGPValue value)
Sets the value of specified process parameter. |
void |
setPreconditionsByRef(IArray ppValues)
Collection of variables that must be executed prior to executing the process. |
void |
setToolByRef(IGPTool tool)
The tool object currently associated with the model process. |
void |
setValid(boolean valid)
Indicates if the model element is valid. |
IGPMessages |
validate(boolean updateValues,
IGPEnvironmentManager pEnvMgr)
Validates the model element. |
void |
writeExternal(java.io.ObjectOutput out)
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final long serialVersionUID
| Constructor Detail |
|---|
public MdProcess()
throws java.io.IOException,
java.net.UnknownHostException
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems
public MdProcess(java.lang.Object obj)
throws java.io.IOException
MdProcess theMdProcess = (MdProcess) obj;
obj to MdProcess.
obj - an object returned from ArcGIS Engine or Server
java.io.IOException - if there are interop problems| Method Detail |
|---|
public static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRefpublic void release()
release in interface com.esri.arcgis.interop.RemoteObjRef
public IClone esri_clone()
throws java.io.IOException,
AutomationException
esri_clone in interface IClonejava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void assign(IClone src)
throws java.io.IOException,
AutomationException
assign in interface IClonesrc - A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isEqual(IClone other)
throws java.io.IOException,
AutomationException
isEqual in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isIdentical(IClone other)
throws java.io.IOException,
AutomationException
isIdentical in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getID()
throws java.io.IOException,
AutomationException
getID in interface IMdElementjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setID(int identifier)
throws java.io.IOException,
AutomationException
setID in interface IMdElementidentifier - The identifier (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getName()
throws java.io.IOException,
AutomationException
getName in interface IMdElementjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setName(java.lang.String name)
throws java.io.IOException,
AutomationException
setName in interface IMdElementname - The name (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isMarked()
throws java.io.IOException,
AutomationException
isMarked in interface IMdElementjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMarked(boolean marked)
throws java.io.IOException,
AutomationException
setMarked in interface IMdElementmarked - The marked (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isCurrent()
throws java.io.IOException,
AutomationException
isCurrent in interface IMdElementjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCurrent(boolean current)
throws java.io.IOException,
AutomationException
setCurrent in interface IMdElementcurrent - The current (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isValid()
throws java.io.IOException,
AutomationException
isValid in interface IMdElementjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setValid(boolean valid)
throws java.io.IOException,
AutomationException
setValid in interface IMdElementvalid - The valid (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IMdModel getModel()
throws java.io.IOException,
AutomationException
getModel in interface IMdElementjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setModelByRef(IMdModel model)
throws java.io.IOException,
AutomationException
setModelByRef in interface IMdElementmodel - A reference to a com.esri.arcgis.geoprocessing.IMdModel (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getState()
throws java.io.IOException,
AutomationException
getState in interface IMdElementjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumMdElement getDependents(int direction,
int connectionType)
throws java.io.IOException,
AutomationException
getDependents in interface IMdElementdirection - A com.esri.arcgis.geoprocessing.esriMdDirection constant (in)connectionType - A com.esri.arcgis.geoprocessing.esriMdConnectionType constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isDependentOn(IMdElement pMdElement,
int direction,
int connectionType)
throws java.io.IOException,
AutomationException
isDependentOn in interface IMdElementpMdElement - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)direction - A com.esri.arcgis.geoprocessing.esriMdDirection constant (in)connectionType - A com.esri.arcgis.geoprocessing.esriMdConnectionType constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGPMessages validate(boolean updateValues,
IGPEnvironmentManager pEnvMgr)
throws java.io.IOException,
AutomationException
validate in interface IMdElementupdateValues - The updateValues (in)pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGPMessages getMessages()
throws java.io.IOException,
AutomationException
getMessages in interface IMdElementjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isAltered()
throws java.io.IOException,
AutomationException
isAltered in interface IMdElementjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAltered(boolean altered)
throws java.io.IOException,
AutomationException
setAltered in interface IMdElementaltered - The altered (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGPToolName getToolName()
throws java.io.IOException,
AutomationException
getToolName in interface IMdProcessjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGPTool getTool()
throws java.io.IOException,
AutomationException
getTool in interface IMdProcessjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setToolByRef(IGPTool tool)
throws java.io.IOException,
AutomationException
setToolByRef in interface IMdProcesstool - A reference to a com.esri.arcgis.geoprocessing.IGPTool (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IArray getParameters()
throws java.io.IOException,
AutomationException
getParameters in interface IMdProcessjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IArray getInputParameters()
throws java.io.IOException,
AutomationException
getInputParameters in interface IMdProcessjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IArray getOutputParameters()
throws java.io.IOException,
AutomationException
getOutputParameters in interface IMdProcessjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IMdParameter getParameter(java.lang.String name)
throws java.io.IOException,
AutomationException
getParameter in interface IMdProcessname - The name (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGPEnvironmentManager getEnvironmentManager()
throws java.io.IOException,
AutomationException
getEnvironmentManager in interface IMdProcessjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setEnvironmentManagerByRef(IGPEnvironmentManager ppEnvMgr)
throws java.io.IOException,
AutomationException
setEnvironmentManagerByRef in interface IMdProcessppEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setParameterValue(java.lang.String name,
IGPValue value)
throws java.io.IOException,
AutomationException
setParameterValue in interface IMdProcessname - The name (in)value - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGPValue getParameterValue(java.lang.String name)
throws java.io.IOException,
AutomationException
getParameterValue in interface IMdProcessname - The name (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void execute(ITrackCancel trackCancel,
IGPEnvironmentManager pEnvMgr,
IGPMessages messages)
throws java.io.IOException,
AutomationException
execute in interface IMdProcesstrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isToolValid()
throws java.io.IOException,
AutomationException
isToolValid in interface IMdProcessjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean needsRepair()
throws java.io.IOException,
AutomationException
needsRepair in interface IMdProcessjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void repairParameters()
throws java.io.IOException,
AutomationException
repairParameters in interface IMdProcessjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IArray getPreconditions()
throws java.io.IOException,
AutomationException
getPreconditions in interface IMdProcessjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setPreconditionsByRef(IArray ppValues)
throws java.io.IOException,
AutomationException
setPreconditionsByRef in interface IMdProcessppValues - A reference to a com.esri.arcgis.system.IArray (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws java.io.IOException,
AutomationException
isDirty in interface IPersistStreamjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws java.io.IOException,
AutomationException
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
int fClearDirty)
throws java.io.IOException,
AutomationException
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws java.io.IOException,
AutomationException
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
throws java.io.IOException,
AutomationException
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void serialize(IXMLSerializeData data)
throws java.io.IOException,
AutomationException
serialize in interface IXMLSerializedata - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deserialize(IXMLSerializeData data)
throws java.io.IOException,
AutomationException
deserialize in interface IXMLSerializedata - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onToolboxDeleted(IGPToolboxEventsOnToolboxDeletedEvent theEvent)
throws java.io.IOException,
AutomationException
onToolboxDeleted in interface IGPToolboxEventstheEvent - The event
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onToolboxRenamed(IGPToolboxEventsOnToolboxRenamedEvent theEvent)
throws java.io.IOException,
AutomationException
onToolboxRenamed in interface IGPToolboxEventstheEvent - The event
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onToolAdded(IGPToolboxEventsOnToolAddedEvent theEvent)
throws java.io.IOException,
AutomationException
onToolAdded in interface IGPToolboxEventstheEvent - The event
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onToolDeleted(IGPToolboxEventsOnToolDeletedEvent theEvent)
throws java.io.IOException,
AutomationException
onToolDeleted in interface IGPToolboxEventstheEvent - The event
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onToolStored(IGPToolboxEventsOnToolStoredEvent theEvent)
throws java.io.IOException,
AutomationException
onToolStored in interface IGPToolboxEventstheEvent - The event
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onToolStateChanged(IGPToolboxEventsOnToolStateChangedEvent theEvent)
throws java.io.IOException,
AutomationException
onToolStateChanged in interface IGPToolboxEventstheEvent - The event
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(java.io.ObjectOutput out)
throws java.io.IOException
writeExternal in interface java.io.Externalizablejava.io.IOException
public void readExternal(java.io.ObjectInput in)
throws java.io.IOException,
java.lang.ClassNotFoundException
readExternal in interface java.io.Externalizablejava.io.IOException
java.lang.ClassNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||