|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.geoprocessing.GPEnvironmentManager
public class GPEnvironmentManager
COM Class 'GPEnvironmentManager'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'
Description 'Environment Manager.' 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.geoprocessing.IGPEnvironmentManager |
|---|
IID, IID91c2edf4_6e2c_43f5_b526_e1a94f6615aa, xxDummy |
| Fields inherited from interface com.esri.arcgis.geoprocessing.IGPDefaultNameList |
|---|
IID, IID6d214b1d_d469_4ee1_8837_6427c2ffeb14, xxDummy |
| Fields inherited from interface com.esri.arcgis.geoprocessing.IGeoProcessorSettings |
|---|
IID, IIDe6a5b1c0_c8be_4f8a_93f7_ea90324b5b33, xxDummy |
| Fields inherited from interface com.esri.arcgis.system.IClone |
|---|
IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, 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.IGPVariableManager |
|---|
IID, IIDfa365292_db48_438a_860c_3cc58bf5b43a, xxDummy |
| Constructor Summary | |
|---|---|
GPEnvironmentManager()
Constructs a GPEnvironmentManager using ArcGIS Engine. |
|
GPEnvironmentManager(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. GPEnvironmentManager theGPEnvironmentManager = (GPEnvironmentManager) obj; |
|
| Method Summary | |
|---|---|
void |
add(IGPVariable pVariable)
Adds a variable. |
void |
addEnvironment(IGPEnvironment env)
Adds the given geoprocessing environment to the environment manager. |
void |
addOutputName(java.lang.String name)
Adds the given name to the list. |
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
boolean |
checkOutputName(java.lang.String name)
Returns whether or not the given name exists within the list. |
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. |
IGPVariable |
find(java.lang.String name)
Finds a variable. |
IGPEnvironment |
findEnvironment(java.lang.String name)
Locates and returns the environment with the specified name. |
void |
getClassID(GUID[] pClassID)
getClassID |
static java.lang.String |
getClsid()
getClsid. |
IArray |
getEnvironments()
Returns the environments of the environment manager as an array. |
java.lang.Object |
getEnvVariant(IGPEnvironment env)
Returns the value of the given environment as a variant. |
com.esri.arcgis.interop.Dispatch |
getJintegraDispatch()
Deprecated. Internal use only. |
IArray |
getLocalEnvironments()
Returns an array of the environments that have been updated locally. |
IGPEnvironmentManager |
getParent()
Returns the parent environment manager. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
IArray |
getVariables()
Returns an array of all of the variables. |
int |
hashCode()
the hashcode for this object |
boolean |
isAddOutputsToMap()
Indicates whether resulting output datasets should be added to the application display. |
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 |
isLogHistory()
Indicates whether or not to log the execution of geoprocessing tools. |
boolean |
isOverwriteOutput()
Indicates whether output datasets should be overwritten when executing geoprocessing tools. |
boolean |
isShowModelBuilderPrompts()
Indicates whether to prompt the user when connecting elements in ModelBuilder if there is more than one possible connection. |
boolean |
isTemporaryMapLayers()
Indicates whether new map layers are temporary by default. |
void |
load(IStream pstm)
load |
void |
putEnvVariant(IGPEnvironment env,
java.lang.Object value)
Sets the value of the given environment to the given variant. |
void |
readExternal(java.io.ObjectInput in)
|
void |
release()
Release a GPEnvironmentManager. |
void |
remove(java.lang.String name)
Removes a variable. |
void |
removeAll()
Removes all variables. |
void |
removeAllOutputNames()
Removes all names from the list. |
void |
removeEnvironment(IGPEnvironment env)
Removes the given geoprocessing environment from the environment manager. |
void |
removeEnvironments()
Removes all environments from the environment manager. |
void |
removeOutputName(java.lang.String name)
Removes the specified name from the list. |
void |
save(IStream pstm,
int fClearDirty)
save |
void |
serialize(IXMLSerializeData data)
Serializes an object to XML. |
void |
setAddOutputsToMap(boolean addToMap)
Indicates whether resulting output datasets should be added to the application display. |
void |
setLogHistory(boolean logHistory)
Indicates whether or not to log the execution of geoprocessing tools. |
void |
setOverwriteOutput(boolean overwriteOutput)
Indicates whether output datasets should be overwritten when executing geoprocessing tools. |
void |
setParentByRef(IGPEnvironmentManager parent)
Returns the parent environment manager. |
void |
setPersistAll(boolean rhs1)
Indicates whether all environments or only local environments are persisted. |
void |
setShowModelBuilderPrompts(boolean showPrompts)
Indicates whether to prompt the user when connecting elements in ModelBuilder if there is more than one possible connection. |
void |
setTemporaryMapLayers(boolean temporaryMapLayers)
Indicates whether new map layers are temporary by default. |
void |
substituteEnvironments(IArray pParams)
Substitues the values of the given array of parameters with the current environment values. |
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 GPEnvironmentManager()
throws java.io.IOException,
java.net.UnknownHostException
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems
public GPEnvironmentManager(java.lang.Object obj)
throws java.io.IOException
GPEnvironmentManager theGPEnvironmentManager = (GPEnvironmentManager) obj;
obj to GPEnvironmentManager.
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 IGPEnvironmentManager getParent()
throws java.io.IOException,
AutomationException
getParent in interface IGPEnvironmentManagerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setParentByRef(IGPEnvironmentManager parent)
throws java.io.IOException,
AutomationException
setParentByRef in interface IGPEnvironmentManagerparent - 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 addEnvironment(IGPEnvironment env)
throws java.io.IOException,
AutomationException
addEnvironment in interface IGPEnvironmentManagerenv - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironment (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void removeEnvironment(IGPEnvironment env)
throws java.io.IOException,
AutomationException
removeEnvironment in interface IGPEnvironmentManagerenv - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironment (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void substituteEnvironments(IArray pParams)
throws java.io.IOException,
AutomationException
substituteEnvironments in interface IGPEnvironmentManagerpParams - 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 removeEnvironments()
throws java.io.IOException,
AutomationException
removeEnvironments in interface IGPEnvironmentManagerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IArray getEnvironments()
throws java.io.IOException,
AutomationException
getEnvironments in interface IGPEnvironmentManagerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IArray getLocalEnvironments()
throws java.io.IOException,
AutomationException
getLocalEnvironments in interface IGPEnvironmentManagerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGPEnvironment findEnvironment(java.lang.String name)
throws java.io.IOException,
AutomationException
findEnvironment in interface IGPEnvironmentManagername - The name (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void putEnvVariant(IGPEnvironment env,
java.lang.Object value)
throws java.io.IOException,
AutomationException
putEnvVariant in interface IGPEnvironmentManagerenv - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironment (in)value - A Variant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.Object getEnvVariant(IGPEnvironment env)
throws java.io.IOException,
AutomationException
getEnvVariant in interface IGPEnvironmentManagerenv - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironment (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setPersistAll(boolean rhs1)
throws java.io.IOException,
AutomationException
setPersistAll in interface IGPEnvironmentManagerrhs1 - The rhs1 (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void removeAllOutputNames()
throws java.io.IOException,
AutomationException
removeAllOutputNames in interface IGPDefaultNameListjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addOutputName(java.lang.String name)
throws java.io.IOException,
AutomationException
addOutputName in interface IGPDefaultNameListname - The name (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void removeOutputName(java.lang.String name)
throws java.io.IOException,
AutomationException
removeOutputName in interface IGPDefaultNameListname - The name (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean checkOutputName(java.lang.String name)
throws java.io.IOException,
AutomationException
checkOutputName in interface IGPDefaultNameListname - The name (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAddOutputsToMap(boolean addToMap)
throws java.io.IOException,
AutomationException
setAddOutputsToMap in interface IGeoProcessorSettingsaddToMap - The addToMap (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isAddOutputsToMap()
throws java.io.IOException,
AutomationException
isAddOutputsToMap in interface IGeoProcessorSettingsjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setOverwriteOutput(boolean overwriteOutput)
throws java.io.IOException,
AutomationException
setOverwriteOutput in interface IGeoProcessorSettingsoverwriteOutput - The overwriteOutput (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isOverwriteOutput()
throws java.io.IOException,
AutomationException
isOverwriteOutput in interface IGeoProcessorSettingsjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTemporaryMapLayers(boolean temporaryMapLayers)
throws java.io.IOException,
AutomationException
setTemporaryMapLayers in interface IGeoProcessorSettingstemporaryMapLayers - The temporaryMapLayers (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isTemporaryMapLayers()
throws java.io.IOException,
AutomationException
isTemporaryMapLayers in interface IGeoProcessorSettingsjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setShowModelBuilderPrompts(boolean showPrompts)
throws java.io.IOException,
AutomationException
setShowModelBuilderPrompts in interface IGeoProcessorSettingsshowPrompts - The showPrompts (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isShowModelBuilderPrompts()
throws java.io.IOException,
AutomationException
isShowModelBuilderPrompts in interface IGeoProcessorSettingsjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setLogHistory(boolean logHistory)
throws java.io.IOException,
AutomationException
setLogHistory in interface IGeoProcessorSettingslogHistory - The logHistory (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isLogHistory()
throws java.io.IOException,
AutomationException
isLogHistory in interface IGeoProcessorSettingsjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
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 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 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 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 add(IGPVariable pVariable)
throws java.io.IOException,
AutomationException
add in interface IGPVariableManagerpVariable - A reference to a com.esri.arcgis.geodatabase.IGPVariable (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void remove(java.lang.String name)
throws java.io.IOException,
AutomationException
remove in interface IGPVariableManagername - The name (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void removeAll()
throws java.io.IOException,
AutomationException
removeAll in interface IGPVariableManagerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGPVariable find(java.lang.String name)
throws java.io.IOException,
AutomationException
find in interface IGPVariableManagername - The name (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IArray getVariables()
throws java.io.IOException,
AutomationException
getVariables in interface IGPVariableManagerjava.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 | ||||||||