Changeset 65

Show
Ignore:
Timestamp:
05/01/07 11:52:24 (6 years ago)
Author:
jjr8
Message:

Partial fix for ArcGIS 9.2 support (#51):

* GeoprocessorManager?.GetGeoprocessor? does not return a weakref to the object returned by arcgisscripting.create(). That fails because the object does not have a weakref attribute.

* The methods of the object returned by arcgisscripting.create() cannot be inspected with Python's inspect module, because they are builtin functions. Changed _ArcGISObjectWrapper.getattr to assueme these are prototyped as func(*args) instead of using inspect.

* Changed GeoEco?.ArcGIS module to pass Unicode to the geoprocessor object returned by win32com and 8-bit strings to the object returned by arcgisscripting.create(). The caller still always passes in Unicode and receives it back.

* Changed the handling of the OverwriteOutput? environment variable to expect a bool from the geoprocessor object returned by win32com and an int from the object returned by arcgisscripting.create().

Also fixed #50: Renamed OverriddenByArcGISGeoprocessorVariable to InitializeToArcGISGeoprocessorVariable. Changed the design such that any parameter flagged with that is only initialized to the specified variable when the method is invoked as an ArcGIS tool. In all other circumstances (e.g. Python, COM) the caller is responsible for setting the variable explicitly.

Location:
MGET/Trunk
Files:
38 modified

Legend:

Unmodified
Added
Removed
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Copy.html

    r61 r65  
    55            td.metadataValue { padding-left: 0.5em; } 
    66          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="ArcGISRaster Class" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="ArcGISRaster Class" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="CopyToDirectory Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.CopyToDirectory.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster Class</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.CopyToDirectory.html?format=raw">CopyToDirectory Method</a> </div><hr /></div></div><h1><tt class="member">Copy</tt> Method</h1><p>Copies an ArcGIS raster. Does not crash ArcGIS when many rasters are stored in a single directory.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue">Recommended for external callers</td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.ArcGISRaster.Copy.html?format=raw">Copy</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.ArcGISRaster.html?format=raw">GeoEco.ArcGISRaster</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/ArcGISRaster.Copy.html?format=raw">Copy Raster</a> geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method">ArcGISRaster.Copy</tt></b>(</td><td><var>sourceRaster</var><var>, destinationRaster</var><big>[</big><var>, overwriteExisting</var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>sourceRaster</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">Yes</td></tr></table><p>Raster to copy.</p></dd></dl><dl><dt><var>destinationRaster</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Copy to create.</p><p>If this is a file system path, missing directories in the path will be created 
    7 if they do not exist.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the destination raster will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the destination raster exists.</p><p>If the GeoEco GeoprocessorManager class is holding an instance of the ArcGIS 
    8 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    9 property determines whether destination rasters will be overwritten. This will 
    10 usually occur if this method is called from an ArcGIS geoprocessing script or 
    11 model. You can still control overwrite behavior by setting that property of the 
    12 geoprocessor to the desired value, either programmatically or from the 
    13 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="ArcGISRaster Class" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="ArcGISRaster Class" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="CopyToDirectory Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.CopyToDirectory.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster Class</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.CopyToDirectory.html?format=raw">CopyToDirectory Method</a> </div></div></div></body></html> 
     7if they do not exist.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the destination raster will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the destination raster exists.</p></dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="ArcGISRaster Class" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="ArcGISRaster Class" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="CopyToDirectory Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.CopyToDirectory.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster Class</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.CopyToDirectory.html?format=raw">CopyToDirectory Method</a> </div></div></div></body></html> 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.CopyToDirectory.html

    r61 r65  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Copy Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Copy.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="ArcGISRaster Class" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="CreateTemporaryRastersToPreventArcGISCrash Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.CreateTemporaryRastersToPreventArcGISCrash.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Copy.html?format=raw">Copy Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.CreateTemporaryRastersToPreventArcGISCrash.html?format=raw">CreateTemporaryRastersToPreventArcGISCrash Method</a> </div><hr /></div></div><h1><tt class="member">CopyToDirectory</tt> Method</h1><p>Copies an ArcGIS raster to a directory. Does not crash ArcGIS when many rasters are stored in the directory.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue">Recommended for external callers</td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.ArcGISRaster.CopyToDirectory.html?format=raw">CopyToDirectory</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.ArcGISRaster.html?format=raw">GeoEco.ArcGISRaster</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/ArcGISRaster.CopyToDirectory.html?format=raw">Copy Raster To Directory</a> geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>destinationRaster</var> = <b><tt class="method">ArcGISRaster.CopyToDirectory</tt></b>(</td><td><var>sourceRaster</var><var>, destinationDirectory</var><big>[</big><var>, overwriteExisting</var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>sourceRaster</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">Yes</td></tr></table><p>Raster to copy.</p></dd></dl><dl><dt><var>destinationDirectory</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Directory to receive the raster.</p><p>The directory will be created if it does not already exist.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the destination raster will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the destination raster exists.</p><p>If the GeoEco GeoprocessorManager class is holding an instance of the ArcGIS 
    7 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    8 property determines whether destination rasters will be overwritten. This will 
    9 usually occur if this method is called from an ArcGIS geoprocessing script or 
    10 model. You can still control overwrite behavior by setting that property of the 
    11 geoprocessor to the desired value, either programmatically or from the 
    12 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><h3>Returns</h3><dl><dt><var>destinationRaster</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Path to the newly-created raster.</p></dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Copy Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Copy.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="ArcGISRaster Class" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="CreateTemporaryRastersToPreventArcGISCrash Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.CreateTemporaryRastersToPreventArcGISCrash.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Copy.html?format=raw">Copy Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.CreateTemporaryRastersToPreventArcGISCrash.html?format=raw">CreateTemporaryRastersToPreventArcGISCrash Method</a> </div></div></div></body></html> 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Copy Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Copy.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="ArcGISRaster Class" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="CreateTemporaryRastersToPreventArcGISCrash Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.CreateTemporaryRastersToPreventArcGISCrash.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Copy.html?format=raw">Copy Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.CreateTemporaryRastersToPreventArcGISCrash.html?format=raw">CreateTemporaryRastersToPreventArcGISCrash Method</a> </div><hr /></div></div><h1><tt class="member">CopyToDirectory</tt> Method</h1><p>Copies an ArcGIS raster to a directory. Does not crash ArcGIS when many rasters are stored in the directory.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue">Recommended for external callers</td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.ArcGISRaster.CopyToDirectory.html?format=raw">CopyToDirectory</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.ArcGISRaster.html?format=raw">GeoEco.ArcGISRaster</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/ArcGISRaster.CopyToDirectory.html?format=raw">Copy Raster To Directory</a> geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>destinationRaster</var> = <b><tt class="method">ArcGISRaster.CopyToDirectory</tt></b>(</td><td><var>sourceRaster</var><var>, destinationDirectory</var><big>[</big><var>, overwriteExisting</var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>sourceRaster</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">Yes</td></tr></table><p>Raster to copy.</p></dd></dl><dl><dt><var>destinationDirectory</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Directory to receive the raster.</p><p>The directory will be created if it does not already exist.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the destination raster will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the destination raster exists.</p></dd></dl><h3>Returns</h3><dl><dt><var>destinationRaster</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Path to the newly-created raster.</p></dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Copy Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Copy.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="ArcGISRaster Class" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="CreateTemporaryRastersToPreventArcGISCrash Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.CreateTemporaryRastersToPreventArcGISCrash.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Copy.html?format=raw">Copy Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.CreateTemporaryRastersToPreventArcGISCrash.html?format=raw">CreateTemporaryRastersToPreventArcGISCrash Method</a> </div></div></div></body></html> 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Move.html

    r61 r65  
    55            td.metadataValue { padding-left: 0.5em; } 
    66          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="DeleteTemporaryRastersThatPreventedArcGISCrash Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.DeleteTemporaryRastersThatPreventedArcGISCrash.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="ArcGISRaster Class" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="MoveToDirectory Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.MoveToDirectory.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.DeleteTemporaryRastersThatPreventedArcGISCrash.html?format=raw">DeleteTemporaryRastersThatPreventedArcGISCrash Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.MoveToDirectory.html?format=raw">MoveToDirectory Method</a> </div><hr /></div></div><h1><tt class="member">Move</tt> Method</h1><p>Moves an ArcGIS raster. Does not crash ArcGIS when many rasters are stored in a single directory.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue">Recommended for external callers</td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.ArcGISRaster.Move.html?format=raw">Move</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.ArcGISRaster.html?format=raw">GeoEco.ArcGISRaster</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/ArcGISRaster.Move.html?format=raw">Move Raster</a> geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method">ArcGISRaster.Move</tt></b>(</td><td><var>sourceRaster</var><var>, destinationRaster</var><big>[</big><var>, overwriteExisting</var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>sourceRaster</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">Yes</td></tr></table><p>Raster to move.</p></dd></dl><dl><dt><var>destinationRaster</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>New path for the raster.</p><p>If this is a file system path, missing directories in the path will be created 
    7 if they do not exist.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the destination raster will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the destination raster exists.</p><p>If the GeoEco GeoprocessorManager class is holding an instance of the ArcGIS 
    8 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    9 property determines whether destination rasters will be overwritten. This will 
    10 usually occur if this method is called from an ArcGIS geoprocessing script or 
    11 model. You can still control overwrite behavior by setting that property of the 
    12 geoprocessor to the desired value, either programmatically or from the 
    13 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="DeleteTemporaryRastersThatPreventedArcGISCrash Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.DeleteTemporaryRastersThatPreventedArcGISCrash.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="ArcGISRaster Class" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="MoveToDirectory Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.MoveToDirectory.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.DeleteTemporaryRastersThatPreventedArcGISCrash.html?format=raw">DeleteTemporaryRastersThatPreventedArcGISCrash Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.MoveToDirectory.html?format=raw">MoveToDirectory Method</a> </div></div></div></body></html> 
     7if they do not exist.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the destination raster will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the destination raster exists.</p></dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="DeleteTemporaryRastersThatPreventedArcGISCrash Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.DeleteTemporaryRastersThatPreventedArcGISCrash.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="ArcGISRaster Class" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="MoveToDirectory Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.MoveToDirectory.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.DeleteTemporaryRastersThatPreventedArcGISCrash.html?format=raw">DeleteTemporaryRastersThatPreventedArcGISCrash Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.MoveToDirectory.html?format=raw">MoveToDirectory Method</a> </div></div></div></body></html> 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.MoveToDirectory.html

    r61 r65  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Move Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Move.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="ArcGISRaster Class" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.DataManagement.BinaryRasters Module" href="Module_GeoEco.DataManagement.BinaryRasters.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Move.html?format=raw">Move Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.DataManagement.BinaryRasters.html?format=raw">GeoEco.DataManagement.BinaryRasters Module</a> </div><hr /></div></div><h1><tt class="member">MoveToDirectory</tt> Method</h1><p>Moves an ArcGIS raster to a directory. Does not crash ArcGIS when many rasters are stored in the directory.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue">Recommended for external callers</td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.ArcGISRaster.MoveToDirectory.html?format=raw">MoveToDirectory</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.ArcGISRaster.html?format=raw">GeoEco.ArcGISRaster</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/ArcGISRaster.MoveToDirectory.html?format=raw">Move Raster To Directory</a> geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>destinationRaster</var> = <b><tt class="method">ArcGISRaster.MoveToDirectory</tt></b>(</td><td><var>sourceRaster</var><var>, destinationDirectory</var><big>[</big><var>, overwriteExisting</var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>sourceRaster</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">Yes</td></tr></table><p>Raster to move.</p></dd></dl><dl><dt><var>destinationDirectory</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Directory to receive the raster.</p><p>Missing directories in this path will be created if they do not exist.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the destination raster will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the destination raster exists.</p><p>If the GeoEco GeoprocessorManager class is holding an instance of the ArcGIS 
    7 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    8 property determines whether destination rasters will be overwritten. This will 
    9 usually occur if this method is called from an ArcGIS geoprocessing script or 
    10 model. You can still control overwrite behavior by setting that property of the 
    11 geoprocessor to the desired value, either programmatically or from the 
    12 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><h3>Returns</h3><dl><dt><var>destinationRaster</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Path to the destination raster.</p></dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Move Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Move.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="ArcGISRaster Class" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.DataManagement.BinaryRasters Module" href="Module_GeoEco.DataManagement.BinaryRasters.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Move.html?format=raw">Move Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.DataManagement.BinaryRasters.html?format=raw">GeoEco.DataManagement.BinaryRasters Module</a> </div></div></div></body></html> 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Move Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Move.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="ArcGISRaster Class" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.DataManagement.BinaryRasters Module" href="Module_GeoEco.DataManagement.BinaryRasters.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Move.html?format=raw">Move Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.DataManagement.BinaryRasters.html?format=raw">GeoEco.DataManagement.BinaryRasters Module</a> </div><hr /></div></div><h1><tt class="member">MoveToDirectory</tt> Method</h1><p>Moves an ArcGIS raster to a directory. Does not crash ArcGIS when many rasters are stored in the directory.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue">Recommended for external callers</td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.ArcGISRaster.MoveToDirectory.html?format=raw">MoveToDirectory</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.ArcGISRaster.html?format=raw">GeoEco.ArcGISRaster</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/ArcGISRaster.MoveToDirectory.html?format=raw">Move Raster To Directory</a> geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>destinationRaster</var> = <b><tt class="method">ArcGISRaster.MoveToDirectory</tt></b>(</td><td><var>sourceRaster</var><var>, destinationDirectory</var><big>[</big><var>, overwriteExisting</var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>sourceRaster</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">Yes</td></tr></table><p>Raster to move.</p></dd></dl><dl><dt><var>destinationDirectory</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Directory to receive the raster.</p><p>Missing directories in this path will be created if they do not exist.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the destination raster will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the destination raster exists.</p></dd></dl><h3>Returns</h3><dl><dt><var>destinationRaster</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Path to the destination raster.</p></dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Move Method" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Move.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="ArcGISRaster Class" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.DataManagement.BinaryRasters Module" href="Module_GeoEco.DataManagement.BinaryRasters.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.Move.html?format=raw">Move Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.ArcGISRasters.ArcGISRaster.html?format=raw">ArcGISRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.DataManagement.BinaryRasters.html?format=raw">GeoEco.DataManagement.BinaryRasters Module</a> </div></div></div></body></html> 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.SwapBytes.html

    r61 r65  
    1010platform), 4 bytes (often called "int" or "long"), or 8 bytes (sometimes called 
    1111"longlong" or "qword").</p><p>Floating-point numbers are usually 4 bytes (often called "float" or "single") 
    12 or 8 bytes (usually called "double").</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the output file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the output file exists.</p><p>If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    13 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    14 property determines whether output files will be overwritten. This will usually 
    15 occur if this method is called from an ArcGIS geoprocessing script or model. You 
    16 can still control overwrite behavior by setting that property of the 
    17 geoprocessor to the desired value, either programmatically or from the 
    18 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><h3>Remarks</h3><p>This function is useful for converting binary raster data produced on 
     12or 8 bytes (usually called "double").</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the output file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the output file exists.</p></dd></dl><h3>Remarks</h3><p>This function is useful for converting binary raster data produced on 
    1913systems with different processor architectures. For example, you might use this 
    2014function to convert data produced by a Sun SPARC processor, which uses "big 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.ToArcGISRaster.html

    r61 r65  
    6161Sun SPARC processor, which uses "big endian" byte ordering.</p></dd></dl><dl><dt><var>coordinateSystem</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Coordinate system to define for the output raster.</p><p>If a value is not provided, the coordinate system of the output raster will 
    6262remain undefined.</p></dd></dl><dl><dt><var>buildPyramids</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, pyramids will be built for the output raster, which will help 
    63 improve its display speed in the ArcGIS user interface.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the output raster will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the output raster exists.</p><p>If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    64 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    65 property determines whether output rasters will be overwritten. This will usually 
    66 occur if this method is called from an ArcGIS geoprocessing script or model. You 
    67 can still control overwrite behavior by setting that property of the 
    68 geoprocessor to the desired value, either programmatically or from the 
    69 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="SwapBytes Method" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.SwapBytes.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="BinaryRaster Class" href="Class_GeoEco.DataManagement.BinaryRasters.BinaryRaster.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="ToArcInfoASCIIGrid Method" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.ToArcInfoASCIIGrid.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.SwapBytes.html?format=raw">SwapBytes Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.BinaryRasters.BinaryRaster.html?format=raw">BinaryRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.ToArcInfoASCIIGrid.html?format=raw">ToArcInfoASCIIGrid Method</a> </div></div></div></body></html> 
     63improve its display speed in the ArcGIS user interface.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the output raster will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the output raster exists.</p></dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="SwapBytes Method" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.SwapBytes.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="BinaryRaster Class" href="Class_GeoEco.DataManagement.BinaryRasters.BinaryRaster.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="ToArcInfoASCIIGrid Method" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.ToArcInfoASCIIGrid.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.SwapBytes.html?format=raw">SwapBytes Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.BinaryRasters.BinaryRaster.html?format=raw">BinaryRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.ToArcInfoASCIIGrid.html?format=raw">ToArcInfoASCIIGrid Method</a> </div></div></div></body></html> 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.ToArcInfoASCIIGrid.html

    r61 r65  
    5757For example, if you are running on an Intel x86 processor, which uses "little 
    5858endian" byte ordering, you might use this option to process data produced by a 
    59 Sun SPARC processor, which uses "big endian" byte ordering.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the output file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the output file exists.</p><p>If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    60 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    61 property determines whether output files will be overwritten. This will usually 
    62 occur if this method is called from an ArcGIS geoprocessing script or model. You 
    63 can still control overwrite behavior by setting that property of the 
    64 geoprocessor to the desired value, either programmatically or from the 
    65 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><h3>Remarks</h3><p>Search the internet for "ASCII grid format" for more information on the 
     59Sun SPARC processor, which uses "big endian" byte ordering.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the output file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the output file exists.</p></dd></dl><h3>Remarks</h3><p>Search the internet for "ASCII grid format" for more information on the 
    6660format of the output file.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="ToArcGISRaster Method" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.ToArcGISRaster.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="BinaryRaster Class" href="Class_GeoEco.DataManagement.BinaryRasters.BinaryRaster.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.DataManagement.Directories Module" href="Module_GeoEco.DataManagement.Directories.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.ToArcGISRaster.html?format=raw">ToArcGISRaster Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.BinaryRasters.BinaryRaster.html?format=raw">BinaryRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.DataManagement.Directories.html?format=raw">GeoEco.DataManagement.Directories Module</a> </div></div></div></body></html> 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.Directories.Directory.Copy.html

    r61 r65  
    1010copied into the existing directory structure of the destination directory.</p></dd></dl><dl><dt><var>overwriteExistingFiles</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, destination files will be overwritten, if they exist.</p><p>If False, a ValueError will be raised if any destination file exists.</p><p>This parameter is ignored if the deleteExistingDestinationDirectory 
    1111parameter is True, since that parameter will cause any existing files to be 
    12 deleted.</p><p>If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    13 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    14 property determines whether destination files will be overwritten. This will 
    15 usually occur if this method is called from an ArcGIS geoprocessing script or 
    16 model. You can still control overwrite behavior by setting that property of the 
    17 geoprocessor to the desired value, either programmatically or from the 
    18 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the directory is copied.</p><p>The ArcGIS geoprocessing system interacts with the file system through the 
     12deleted.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the directory is copied.</p><p>The ArcGIS geoprocessing system interacts with the file system through the 
    1913ArcGIS catalog, a cached view of the files and directories on the computer. It 
    2014is important that the catalog be "refreshed" after any changes are made to files 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.Directories.Directory.CopyToDirectory.html

    r61 r65  
    1212copied into the existing directory structure of the destination directory.</p></dd></dl><dl><dt><var>overwriteExistingFiles</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, destination files will be overwritten, if they exist.</p><p>If False, a ValueError will be raised if any destination file exists.</p><p>This parameter is ignored if the deleteExistingDestinationDirectory 
    1313parameter is True, since that parameter will cause any existing files to be 
    14 deleted.</p><p>If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    15 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    16 property determines whether destination files will be overwritten. This will 
    17 usually occur if this method is called from an ArcGIS geoprocessing script or 
    18 model. You can still control overwrite behavior by setting that property of the 
    19 geoprocessor to the desired value, either programmatically or from the 
    20 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the directory is copied.</p><p>The ArcGIS geoprocessing system interacts with the file system through the 
     14deleted.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the directory is copied.</p><p>The ArcGIS geoprocessing system interacts with the file system through the 
    2115ArcGIS catalog, a cached view of the files and directories on the computer. It 
    2216is important that the catalog be "refreshed" after any changes are made to files 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.Directories.Directory.Move.html

    r61 r65  
    1313moved into the existing directory structure of the destination directory.</p></dd></dl><dl><dt><var>overwriteExistingFiles</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, destination files will be overwritten, if they exist.</p><p>If False, a ValueError will be raised if any destination file exists.</p><p>This parameter is ignored if the deleteExistingDestinationDirectory 
    1414parameter is True, since that parameter will cause any existing files to be 
    15 deleted.</p><p>If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    16 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    17 property determines whether destination files will be overwritten. This will 
    18 usually occur if this method is called from an ArcGIS geoprocessing script or 
    19 model. You can still control overwrite behavior by setting that property of the 
    20 geoprocessor to the desired value, either programmatically or from the 
    21 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the directory is moved.</p><p>The ArcGIS geoprocessing system interacts with the file system through the 
     15deleted.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the directory is moved.</p><p>The ArcGIS geoprocessing system interacts with the file system through the 
    2216ArcGIS catalog, a cached view of the files and directories on the computer. It 
    2317is important that the catalog be "refreshed" after any changes are made to files 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.Directories.Directory.MoveToDirectory.html

    r61 r65  
    1313moved into the existing directory structure of the destination directory.</p></dd></dl><dl><dt><var>overwriteExistingFiles</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, destination files will be overwritten, if they exist.</p><p>If False, a ValueError will be raised if any destination file exists.</p><p>This parameter is ignored if the deleteExistingDestinationDirectory 
    1414parameter is True, since that parameter will cause any existing files to be 
    15 deleted.</p><p>If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    16 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    17 property determines whether destination files will be overwritten. This will 
    18 usually occur if this method is called from an ArcGIS geoprocessing script or 
    19 model. You can still control overwrite behavior by setting that property of the 
    20 geoprocessor to the desired value, either programmatically or from the 
    21 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the directory is moved.</p><p>The ArcGIS geoprocessing system interacts with the file system through the 
     15deleted.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the directory is moved.</p><p>The ArcGIS geoprocessing system interacts with the file system through the 
    2216ArcGIS catalog, a cached view of the files and directories on the computer. It 
    2317is important that the catalog be "refreshed" after any changes are made to files 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.Files.File.Copy.html

    r61 r65  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="File Class" href="Class_GeoEco.DataManagement.Files.File.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="File Class" href="Class_GeoEco.DataManagement.Files.File.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="CopyToDirectory Method" href="Method_GeoEco.DataManagement.Files.File.CopyToDirectory.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Class_GeoEco.DataManagement.Files.File.html?format=raw">File Class</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.Files.File.html?format=raw">File Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.Files.File.CopyToDirectory.html?format=raw">CopyToDirectory Method</a> </div><hr /></div></div><h1><tt class="member">Copy</tt> Method</h1><p>Copies a file.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DataManagement.Files.File.html?format=raw">File</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue">Recommended for external callers</td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.File.Copy.html?format=raw">Copy</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.File.html?format=raw">GeoEco.File</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/File.Copy.html?format=raw">Copy File</a> geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method">File.Copy</tt></b>(</td><td><var>sourceFile</var><var>, destinationFile</var><big>[</big><var>, overwriteExisting</var><big>[</big><var>, refreshArcGISCatalog</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>sourceFile</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">Yes</td></tr></table><p>File to copy.</p></dd></dl><dl><dt><var>destinationFile</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Copy to create.</p><p>Missing directories in this path will be created if they do not exist.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the destination file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the destination file exists.</p><p>If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    7 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    8 property determines whether destination files will be overwritten. This will 
    9 usually occur if this method is called from an ArcGIS geoprocessing script or 
    10 model. You can still control overwrite behavior by setting that property of the 
    11 geoprocessor to the desired value, either programmatically or from the 
    12 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the file is copied.</p><p>The ArcGIS geoprocessing system interacts with the file system through the 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="File Class" href="Class_GeoEco.DataManagement.Files.File.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="File Class" href="Class_GeoEco.DataManagement.Files.File.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="CopyToDirectory Method" href="Method_GeoEco.DataManagement.Files.File.CopyToDirectory.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Class_GeoEco.DataManagement.Files.File.html?format=raw">File Class</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.Files.File.html?format=raw">File Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.Files.File.CopyToDirectory.html?format=raw">CopyToDirectory Method</a> </div><hr /></div></div><h1><tt class="member">Copy</tt> Method</h1><p>Copies a file.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DataManagement.Files.File.html?format=raw">File</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue">Recommended for external callers</td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.File.Copy.html?format=raw">Copy</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.File.html?format=raw">GeoEco.File</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/File.Copy.html?format=raw">Copy File</a> geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method">File.Copy</tt></b>(</td><td><var>sourceFile</var><var>, destinationFile</var><big>[</big><var>, overwriteExisting</var><big>[</big><var>, refreshArcGISCatalog</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>sourceFile</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">Yes</td></tr></table><p>File to copy.</p></dd></dl><dl><dt><var>destinationFile</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Copy to create.</p><p>Missing directories in this path will be created if they do not exist.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the destination file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the destination file exists.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the file is copied.</p><p>The ArcGIS geoprocessing system interacts with the file system through the 
    137ArcGIS catalog, a cached view of the files and directories on the computer. It 
    148is important that the catalog be "refreshed" after any changes are made to files 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.Files.File.CopyToDirectory.html

    r61 r65  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Copy Method" href="Method_GeoEco.DataManagement.Files.File.Copy.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="File Class" href="Class_GeoEco.DataManagement.Files.File.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="Decompress Method" href="Method_GeoEco.DataManagement.Files.File.Decompress.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.Files.File.Copy.html?format=raw">Copy Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.Files.File.html?format=raw">File Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.Files.File.Decompress.html?format=raw">Decompress Method</a> </div><hr /></div></div><h1><tt class="member">CopyToDirectory</tt> Method</h1><p>Copies a file to a directory.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DataManagement.Files.File.html?format=raw">File</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue">Recommended for external callers</td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.File.CopyToDirectory.html?format=raw">CopyToDirectory</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.File.html?format=raw">GeoEco.File</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/File.CopyToDirectory.html?format=raw">Copy File To Directory</a> geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>destinationFile</var> = <b><tt class="method">File.CopyToDirectory</tt></b>(</td><td><var>sourceFile</var><var>, destinationDirectory</var><big>[</big><var>, overwriteExisting</var><big>[</big><var>, refreshArcGISCatalog</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>sourceFile</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">Yes</td></tr></table><p>File to copy.</p></dd></dl><dl><dt><var>destinationDirectory</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Directory to receive the file.</p><p>The directory will be created if it does not already exist.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the destination file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the destination file exists.</p><p>If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    7 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    8 property determines whether destination files will be overwritten. This will 
    9 usually occur if this method is called from an ArcGIS geoprocessing script or 
    10 model. You can still control overwrite behavior by setting that property of the 
    11 geoprocessor to the desired value, either programmatically or from the 
    12 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the file is copied.</p><p>The ArcGIS geoprocessing system interacts with the file system through the 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Copy Method" href="Method_GeoEco.DataManagement.Files.File.Copy.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="File Class" href="Class_GeoEco.DataManagement.Files.File.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="Decompress Method" href="Method_GeoEco.DataManagement.Files.File.Decompress.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.Files.File.Copy.html?format=raw">Copy Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.Files.File.html?format=raw">File Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.Files.File.Decompress.html?format=raw">Decompress Method</a> </div><hr /></div></div><h1><tt class="member">CopyToDirectory</tt> Method</h1><p>Copies a file to a directory.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DataManagement.Files.File.html?format=raw">File</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue">Recommended for external callers</td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.File.CopyToDirectory.html?format=raw">CopyToDirectory</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.File.html?format=raw">GeoEco.File</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/File.CopyToDirectory.html?format=raw">Copy File To Directory</a> geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>destinationFile</var> = <b><tt class="method">File.CopyToDirectory</tt></b>(</td><td><var>sourceFile</var><var>, destinationDirectory</var><big>[</big><var>, overwriteExisting</var><big>[</big><var>, refreshArcGISCatalog</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>sourceFile</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">Yes</td></tr></table><p>File to copy.</p></dd></dl><dl><dt><var>destinationDirectory</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Directory to receive the file.</p><p>The directory will be created if it does not already exist.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the destination file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the destination file exists.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the file is copied.</p><p>The ArcGIS geoprocessing system interacts with the file system through the 
    137ArcGIS catalog, a cached view of the files and directories on the computer. It 
    148is important that the catalog be "refreshed" after any changes are made to files 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.Files.File.Decompress.html

    r61 r65  
    77supported are:</p><ul><li>.bz2 - a single file compressed in <a href="http://www.bzip.org">bzip2</a> format</li><li>.gz - a single file compressed in <a href="http://www.gzip.org">gzip</a> format</li><li>.tar - one or more files archived in UNIX tar format</li><li>.zip - one or more files archived and compressed in <a href="http://www.pkware.com">PK Zip</a> format</li><li>.Z - a single file compressed in UNIX "compress" format</li></ul><p>tar files that are compressed in bzip2 (.tar.bz2), gzip (.tar.gz) or compress 
    88format (.tar.Z) are automatically handled.</p></dd></dl><dl><dt><var>destinationDirectory</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Directory to receive the decompressed files.</p><p>The directory will be created if it does not already exist.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the extracted destination files will be overwritten, if they 
    9 already exist.</p><p>If False, a ValueError will be raised if any destination files already exist.</p><p>If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    10 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    11 property determines whether destination files will be overwritten. This will 
    12 usually occur if this method is called from an ArcGIS geoprocessing script or 
    13 model. You can still control overwrite behavior by setting that property of the 
    14 geoprocessor to the desired value, either programmatically or from the 
    15 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the file is 
     9already exist.</p><p>If False, a ValueError will be raised if any destination files already exist.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the file is 
    1610decompressed.</p><p>The ArcGIS geoprocessing system interacts with the file system through the 
    1711ArcGIS catalog, a cached view of the files and directories on the computer. It 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.Files.File.Move.html

    r61 r65  
    66          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="IsDecompressible Method" href="Method_GeoEco.DataManagement.Files.File.IsDecompressible.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="File Class" href="Class_GeoEco.DataManagement.Files.File.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="MoveToDirectory Method" href="Method_GeoEco.DataManagement.Files.File.MoveToDirectory.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.Files.File.IsDecompressible.html?format=raw">IsDecompressible Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.Files.File.html?format=raw">File Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.Files.File.MoveToDirectory.html?format=raw">MoveToDirectory Method</a> </div><hr /></div></div><h1><tt class="member">Move</tt> Method</h1><p>Moves a file.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DataManagement.Files.File.html?format=raw">File</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue">Recommended for external callers</td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.File.Move.html?format=raw">Move</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.File.html?format=raw">GeoEco.File</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/File.Move.html?format=raw">Move File</a> geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method">File.Move</tt></b>(</td><td><var>sourceFile</var><var>, destinationFile</var><big>[</big><var>, overwriteExisting</var><big>[</big><var>, refreshArcGISCatalog</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>sourceFile</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">Yes</td></tr></table><p>File to move.</p></dd></dl><dl><dt><var>destinationFile</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>New path for the file.</p><p>Missing directories in this path will be created if they do not exist.</p><p>If the destination file is on the same drive or file system as the source file, 
    77the source file will simply be renamed to the destination file.</p><p>If the destination file is on a different drive or file system, the source file 
    8 will be copied to the destination file and then deleted.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the destination file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the destination file exists.</p><p>If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    9 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    10 property determines whether destination files will be overwritten. This will 
    11 usually occur if this method is called from an ArcGIS geoprocessing script or 
    12 model. You can still control overwrite behavior by setting that property of the 
    13 geoprocessor to the desired value, either programmatically or from the 
    14 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the file is moved.</p><p>The ArcGIS geoprocessing system interacts with the file system through the 
     8will be copied to the destination file and then deleted.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the destination file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the destination file exists.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the file is moved.</p><p>The ArcGIS geoprocessing system interacts with the file system through the 
    159ArcGIS catalog, a cached view of the files and directories on the computer. It 
    1610is important that the catalog be "refreshed" after any changes are made to files 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.Files.File.MoveToDirectory.html

    r61 r65  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Move Method" href="Method_GeoEco.DataManagement.Files.File.Move.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="File Class" href="Class_GeoEco.DataManagement.Files.File.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.DataManagement.HDFs Module" href="Module_GeoEco.DataManagement.HDFs.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.Files.File.Move.html?format=raw">Move Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.Files.File.html?format=raw">File Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.DataManagement.HDFs.html?format=raw">GeoEco.DataManagement.HDFs Module</a> </div><hr /></div></div><h1><tt class="member">MoveToDirectory</tt> Method</h1><p>Moves a file to a directory.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DataManagement.Files.File.html?format=raw">File</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue">Recommended for external callers</td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.File.MoveToDirectory.html?format=raw">MoveToDirectory</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.File.html?format=raw">GeoEco.File</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/File.MoveToDirectory.html?format=raw">Move File To Directory</a> geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>destinationFile</var> = <b><tt class="method">File.MoveToDirectory</tt></b>(</td><td><var>sourceFile</var><var>, destinationDirectory</var><big>[</big><var>, overwriteExisting</var><big>[</big><var>, refreshArcGISCatalog</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>sourceFile</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">Yes</td></tr></table><p>File to move.</p></dd></dl><dl><dt><var>destinationDirectory</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Directory to receive the file.</p><p>Missing directories in this path will be created if they do not exist.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the destination file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the destination file exists.</p><p>If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    7 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    8 property determines whether destination files will be overwritten. This will 
    9 usually occur if this method is called from an ArcGIS geoprocessing script or 
    10 model. You can still control overwrite behavior by setting that property of the 
    11 geoprocessor to the desired value, either programmatically or from the 
    12 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the file is moved.</p><p>The ArcGIS geoprocessing system interacts with the file system through the 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Move Method" href="Method_GeoEco.DataManagement.Files.File.Move.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="File Class" href="Class_GeoEco.DataManagement.Files.File.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.DataManagement.HDFs Module" href="Module_GeoEco.DataManagement.HDFs.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.Files.File.Move.html?format=raw">Move Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.Files.File.html?format=raw">File Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.DataManagement.HDFs.html?format=raw">GeoEco.DataManagement.HDFs Module</a> </div><hr /></div></div><h1><tt class="member">MoveToDirectory</tt> Method</h1><p>Moves a file to a directory.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DataManagement.Files.File.html?format=raw">File</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue">Recommended for external callers</td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.File.MoveToDirectory.html?format=raw">MoveToDirectory</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.File.html?format=raw">GeoEco.File</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/File.MoveToDirectory.html?format=raw">Move File To Directory</a> geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>destinationFile</var> = <b><tt class="method">File.MoveToDirectory</tt></b>(</td><td><var>sourceFile</var><var>, destinationDirectory</var><big>[</big><var>, overwriteExisting</var><big>[</big><var>, refreshArcGISCatalog</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>sourceFile</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">Yes</td></tr></table><p>File to move.</p></dd></dl><dl><dt><var>destinationDirectory</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Directory to receive the file.</p><p>Missing directories in this path will be created if they do not exist.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the destination file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the destination file exists.</p></dd></dl><dl><dt><var>refreshArcGISCatalog</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>True</code></td></tr></table><p>If True, the ArcGIS catalog will be refreshed after the file is moved.</p><p>The ArcGIS geoprocessing system interacts with the file system through the 
    137ArcGIS catalog, a cached view of the files and directories on the computer. It 
    148is important that the catalog be "refreshed" after any changes are made to files 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.HDFs.HDF.ExtractHeader.html

    r61 r65  
    1010be automatically decompressed. If it is an archive (e.g. .zip or .tar), it must 
    1111contain exactly one file, which must not be in a subdirectory.</p></dd></dl><dl><dt><var>outputFile</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Output text file.</p><p>This function invokes NCSA's hdp program with the "dumpsds -h" options and 
    12 writes the results to the text file.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the output file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the output file exists.</p><p>If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    13 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    14 property determines whether output files will be overwritten. This will usually 
    15 occur if this method is called from an ArcGIS geoprocessing script or model. You 
    16 can still control overwrite behavior by setting that property of the 
    17 geoprocessor to the desired value, either programmatically or from the 
    18 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><h3>Remarks</h3><p>At the time this function was written, two major versions of HDF were under 
     12writes the results to the text file.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the output file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the output file exists.</p></dd></dl><h3>Remarks</h3><p>At the time this function was written, two major versions of HDF were under 
    1913continuing development: HDF, which was at release 4.2r1, and HDF5, which was at 
    2014release 5-1.6.5. This function can process HDF files but not HDF5 files. It can 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.HDFs.HDF.SDSToArcGISRaster.html

    r61 r65  
    104104specify a cell size for each dimension.</p></dd></dl><dl><dt><var>nodataValue</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">float</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>Value that indicates a cell has no data.</p></dd></dl><dl><dt><var>coordinateSystem</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Coordinate system to define for the output raster.</p><p>If a value is not provided, the coordinate system of the output raster will 
    105105remain undefined.</p></dd></dl><dl><dt><var>buildPyramids</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, pyramids will be built for the output raster, which will help 
    106 improve its display speed in the ArcGIS user interface.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the output file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the output file exists.</p><p>If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    107 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    108 property determines whether output files will be overwritten. This will usually 
    109 occur if this method is called from an ArcGIS geoprocessing script or model. You 
    110 can still control overwrite behavior by setting that property of the 
    111 geoprocessor to the desired value, either programmatically or from the 
    112 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><h3>Remarks</h3><p>At the time this function was written, two major versions of HDF were under 
     106improve its display speed in the ArcGIS user interface.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the output file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the output file exists.</p></dd></dl><h3>Remarks</h3><p>At the time this function was written, two major versions of HDF were under 
    113107continuing development: HDF, which was at release 4.2r1, and HDF5, which was at 
    114108release 5-1.6.5. This function can process HDF files but not HDF5 files. It can 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.HDFs.HDF.SDSToArcInfoASCIIGrid.html

    r61 r65  
    7373720 columns and 360 rows, it would have a cell size of 0.5, corresponding to 
    74741/2 of a geographic degree.</p><p>The underlying data format requires the cells be square. It is not possible to 
    75 specify a cell size for each dimension.</p></dd></dl><dl><dt><var>nodataValue</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">float</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>Value that indicates a cell has no data.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the output file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the output file exists.</p><p>If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    76 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    77 property determines whether output files will be overwritten. This will usually 
    78 occur if this method is called from an ArcGIS geoprocessing script or model. You 
    79 can still control overwrite behavior by setting that property of the 
    80 geoprocessor to the desired value, either programmatically or from the 
    81 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><h3>Remarks</h3><p>At the time this function was written, two major versions of HDF were under 
     75specify a cell size for each dimension.</p></dd></dl><dl><dt><var>nodataValue</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">float</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>Value that indicates a cell has no data.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the output file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the output file exists.</p></dd></dl><h3>Remarks</h3><p>At the time this function was written, two major versions of HDF were under 
    8276continuing development: HDF, which was at release 4.2r1, and HDF5, which was at 
    8377release 5-1.6.5. This function can process HDF files but not HDF5 files. It can 
  • MGET/Trunk/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.HDFs.HDF.SDSToBinaryRaster.html

    r61 r65  
    6464                 Type = 32-bit signed integer 
    6565                 Count= 2 
    66                  Value = 0 2</pre></div></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the output file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the output file exists.</p><p>If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    67 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    68 property determines whether output files will be overwritten. This will usually 
    69 occur if this method is called from an ArcGIS geoprocessing script or model. You 
    70 can still control overwrite behavior by setting that property of the 
    71 geoprocessor to the desired value, either programmatically or from the 
    72 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog.</p></dd></dl><h3>Remarks</h3><p>At the time this function was written, two major versions of HDF were under 
     66                 Value = 0 2</pre></div></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, the output file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the output file exists.</p></dd></dl><h3>Remarks</h3><p>At the time this function was written, two major versions of HDF were under 
    7367continuing development: HDF, which was at release 4.2r1, and HDF5, which was at 
    7468release 5-1.6.5. This function can process HDF files but not HDF5 files. It can 
  • MGET/Trunk/PythonPackage/src/GeoEco/ArcGIS.py

    r56 r65  
    3232from GeoEco.Exceptions import GeoEcoError 
    3333from GeoEco.Logging import Logger 
    34 from GeoEco.Internationalization import _ 
     34from GeoEco.Internationalization import _, UnicodeToUserPreferredEncoding, UserPreferredEncodingToUnicode 
    3535from GeoEco.Metadata import ClassMetadata, MethodMetadata, TypeMetadata 
    3636 
     
    6565    def GetGeoprocessor(cls): 
    6666         
    67         # For safety, return a weak reference ot the geoprocessor, so that the 
    68         # caller cannot accidentally hold on to a strong reference and thereby 
    69         # prevent the geoprocessor from being released properly when the module 
    70         # unloads. 
     67        # Try to return a weak reference to the geoprocessor, so that the caller 
     68        # cannot accidentally hold on to a strong reference and thereby prevent 
     69        # the geoprocessor from being released properly when the module unloads. 
     70        # 
     71        # If it is ArcGIS 9.2 or later, we cannot return a weak reference 
     72        # because the geoprocessor object returned by arcgisscripting.create() 
     73        # does not have a __weakref__ member, which apparently is required to 
     74        # create weak references to an object. In this case we just return the 
     75        # object itself. 
    7176         
    7277        if globals()['_Geoprocessor'] is not None: 
    73             return weakref.proxy(globals()['_Geoprocessor']) 
     78            try: 
     79                return weakref.proxy(globals()['_Geoprocessor']) 
     80            except: 
     81                pass 
     82            return globals()['_Geoprocessor'] 
    7483        return None 
    7584 
     
    499508                assert isinstance(methodMetadata.Arguments[i].ArcGISDisplayName, types.UnicodeType), u'%s.%s.__doc__.Obj.Arguments[%i].ArcGISDisplayName must be a unicode string.' % (className, methodName, i) 
    500509                assert methodMetadata.Arguments[i].Type.CanBeArcGISInputParameter, u'%s.%s.__doc__.Obj.Arguments[%i].Type.CanBeArcGISInputParameter must be True' % (className, methodName, i) 
     510                assert methodMetadata.Arguments[i].InitializeToArcGISGeoprocessorVariable is None, u'Argument %i of %s.%s cannot have a value for ArcGISDisplayName when InitializeToArcGISGeoprocessorVariable is True. Either the argument can have an ArcGISDisplayName, in which case the argument is exposed as an ArcGIS parameter, or it can have InitializeToArcGISGeoprocessorVariable set to True, in which case the argument is not exposed in ArcGIS but is initialized to a geoprocessor variable.' % (i, className, methodName) 
    501511                if methodMetadata.Arguments[i].ArcGISParameterDependencies is not None: 
    502512                    for param in methodMetadata.Arguments[i].ArcGISParameterDependencies: 
     
    504514                        assert param in args, u'%s.%s.__doc__.Obj.Arguments[%i].ArcGISParameterDependencies must declare dependencies on existing arguments. The argument \'%s\' does not exist.' % (className, methodName, i, param) 
    505515            else: 
    506                 assert methodMetadata.Arguments[i].HasDefault, u'Argument %i of %s.%s must have a default value because the method is designated for exposure as an ArcGIS tool but the argument itself is not (its ArcGISDisplayName is None).' % (i, className, methodName) 
     516                assert methodMetadata.Arguments[i].HasDefault or methodMetadata.Arguments[i].InitializeToArcGISGeoprocessorVariable is not None, u'Argument %i of %s.%s must have a default value, or its metadata must specify that it should be initialized to an ArcGIS geoprocessor variable, because the method is designated for exposure as an ArcGIS tool but the argument itself is not (its ArcGISDisplayName is None).' % (i, className, methodName) 
    507517                 
    508518        # Validate the metadata for the method's results.         
     
    538548 
    539549        argsToPass = [] 
     550        argsFromCmdLine = [] 
     551        argsFromGPVars = [] 
    540552        for i in range(1, len(methodMetadata.Arguments)):                       # methodMetadata.Arguments[0] is the "self" or "cls" parameter, so we skip it. 
     553 
    541554            if methodMetadata.Arguments[i].ArcGISDisplayName is not None: 
     555                argsFromCmdLine.append(methodMetadata.Arguments[i]) 
     556                argsToPass.append(methodMetadata.Arguments[i]) 
     557 
     558            elif methodMetadata.Arguments[i].InitializeToArcGISGeoprocessorVariable is not None: 
     559                argsFromGPVars.append(methodMetadata.Arguments[i]) 
    542560                argsToPass.append(methodMetadata.Arguments[i]) 
    543561 
     
    558576        # least in Arc 9.1. 
    559577 
    560         expectedParamCount = len(argsToPass) + len(methodMetadata.Results) 
     578        expectedParamCount = len(argsFromCmdLine) + len(methodMetadata.Results) 
    561579        geoprocessor = GeoprocessorManager.GetWrappedGeoprocessor() 
    562580        if geoprocessor.ParameterCount == expectedParamCount: 
     
    576594        # should be used. 
    577595 
    578         for i in range(len(argsToPass)):         
     596        for i in range(len(argsFromCmdLine)): 
    579597            if useSysArgv: 
    580598                value = sys.argv[i + 1] 
     
    582600                value = geoprocessor.GetParameterAsText(i) 
    583601            if value == '#' or len(value) <= 0: 
    584                 if argsToPass[i].Type.CanBeNone: 
    585                     exec '%s_value = None' % argsToPass[i].Name in globals(), locals() 
     602                if argsFromCmdLine[i].Type.CanBeNone: 
     603                    exec '%s_value = None' % argsFromCmdLine[i].Name in globals(), locals() 
    586604                else: 
    587                     Logger.RaiseException(ValueError(_(u'The %s parameter (called "%s" in the ArcGIS toolbox) is required. Please provide a value.') % (argsToPass[i].Name, argsToPass[i].ArcGISDisplayName))) 
     605                    Logger.RaiseException(ValueError(_(u'The %s parameter (called "%s" in the ArcGIS toolbox) is required. Please provide a value.') % (argsFromCmdLine[i].Name, argsFromCmdLine[i].ArcGISDisplayName))) 
    588606            else: 
    589                 exec '%s_value = argsToPass[i].Type.ParseValueFromArcGISInputParameterString(value, argsToPass[i].ArcGISDisplayName, i+1)' % argsToPass[i].Name in globals(), locals() 
    590             Logger.Debug(_(u'%s = %s') % (argsToPass[i].Name, repr(locals()[argsToPass[i].Name + '_value']))) 
     607                exec '%s_value = argsFromCmdLine[i].Type.ParseValueFromArcGISInputParameterString(value, argsFromCmdLine[i].ArcGISDisplayName, i+1)' % argsFromCmdLine[i].Name in globals(), locals() 
     608            Logger.Debug(_(u'Parameter %s = %s') % (argsFromCmdLine[i].Name, repr(locals()[argsFromCmdLine[i].Name + '_value']))) 
     609 
     610        # Obtain the values of geoprocessor variables that will be passed to the 
     611        # method as arguments. 
     612 
     613        for i in range(len(argsFromGPVars)): 
     614            exec '%s_value = geoprocessor.%s' % (argsFromGPVars[i].Name, argsFromGPVars[i].InitializeToArcGISGeoprocessorVariable) in globals(), locals() 
     615 
     616            # ArcGIS 9.1/9.2 compatibility hack: In 9.1, the OverwriteOutput 
     617            # variable was a boolean. In 9.2, it is an integer, at least if you 
     618            # obtain the geoprocessor using the recommended technique (import 
     619            # arcgisscripting). We handle this so the tool developer does not 
     620            # have to. 
     621 
     622            if sys.modules.has_key('arcgisscripting') and argsFromGPVars[i].InitializeToArcGISGeoprocessorVariable.lower() == u'overwriteoutput': 
     623                exec '%s_value = bool(%s_value)' % (argsFromGPVars[i].Name, argsFromGPVars[i].Name) in globals(), locals() 
     624 
     625            Logger.Debug(_(u'Parameter %s = %s') % (argsFromGPVars[i].Name, repr(locals()[argsFromGPVars[i].Name + '_value']))) 
    591626 
    592627        # Execute the method. 
     
    613648        for i in range(len(methodMetadata.Results)): 
    614649            if locals()[u'ret%s' % i] is not None: 
    615                 geoprocessor.SetParameterAsText(len(argsToPass) + i, unicode(locals()[u'ret%s' % i])) 
     650                geoprocessor.SetParameterAsText(len(argsFromCmdLine) + i, unicode(locals()[u'ret%s' % i])) 
    616651            else: 
    617                 geoprocessor.SetParameterAsText(len(argsToPass) + i, u'') 
     652                geoprocessor.SetParameterAsText(len(argsFromCmdLine) + i, u'') 
    618653 
    619654    # If we caught an exception, log it as an error. Run a garbage collection to 
     
    798833        # wrapped methods, and return the wrapper. 
    799834 
    800         if isinstance(value, types.MethodType): 
    801             (args, varargs, varkw, defaults) = inspect.getargspec(value) 
    802             sourceCode = 'def %s%s:\n' % (str(name), inspect.formatargspec(args, varargs, varkw, defaults)) 
     835        if isinstance(value, (types.MethodType, types.BuiltinFunctionType, types.BuiltinMethodType)): 
     836 
     837            # Write the methods's definition. 
     838            # 
     839            # In ArcGIS 9.1, we obtained the geoprocessor object through 
     840            # win32com. This object is a Python class with normal methods, and 
     841            # we can obtain their signatures through inspect.getargspec. 
     842            # 
     843            # In ArcGIS 9.2 and later, we obtained the geoprocessor object 
     844            # through arcgisscripting.create(). This returns an object that is 
     845            # not a class but that has attributes that are "builtin" functions. 
     846            # These methods cannot be inspected so we cannot determine their 
     847            # signatures. In this case, we just assume the signature is 
     848            # func(*args). This should work fine because our callers will not be 
     849            # passing in named formal parameters, nor will they be passing in 
     850            # keyword dictionaries. 
     851 
     852            if isinstance(value, types.MethodType): 
     853                (args, varargs, varkw, defaults) = inspect.getargspec(value) 
     854                sourceCode = 'def %s%s:\n' % (str(name), inspect.formatargspec(args, varargs, varkw, defaults)) 
     855            else: 
     856                sourceCode = 'def %s(self, *args):\n' % str(name) 
     857 
     858            # Write the method's body. 
     859             
    803860            sourceCode = sourceCode + '    return self._InvokeMethod(self._Object.%s)\n' % name 
     861 
     862            # Compile the method. 
     863             
    804864            _locals = {} 
    805865            exec sourceCode in globals(), _locals 
     866 
     867            # Add it to our dictionary of wrapped methods. 
     868             
    806869            self._WrappedMethods[name.lower()] = _locals[name] 
     870 
     871            # Return it to the caller. 
     872             
    807873            return new.instancemethod(_locals[name], self, _ArcGISObjectWrapper) 
    808874 
     
    810876        # it in _ArcGISObjectWrapper. 
    811877 
    812         if not isinstance(value, (types.BooleanType, types.FloatType, types.IntType, types.ListType, types.LongType, types.NoneType, basestring)): 
     878        elif not isinstance(value, (types.BooleanType, types.FloatType, types.IntType, types.ListType, types.LongType, types.NoneType, basestring)): 
    813879            wrap = False 
    814880            objName = self._LookupReturnedObjectName(name) 
     
    821887                value = _ArcGISObjectWrapper(value, objName) 
    822888 
     889        # As of ArcGIS 9.2, when the geoprocessor is obtained through the 
     890        # arcgisscripting Python module, it returns 8-bit strings, but if we 
     891        # obtain it through COM Automation, it returns Unicode strings. The 
     892        # caller should always be expecting Unicode, so we need to convert it. 
     893 
     894        elif isinstance(value, types.StringType): 
     895            value = UserPreferredEncodingToUnicode(value) 
     896 
    823897        # Log the returned attribute value. 
    824898 
     
    844918        if name.startswith(u'_'): 
    845919            return object.__setattr__(self, name, value) 
     920 
     921        # As of ArcGIS 9.2, when the geoprocessor is obtained through the 
     922        # arcgisscripting Python module, it requires we give it 8-bit strings, 
     923        # but if we obtain it through COM Automation, it requires Unicode 
     924        # strings. The caller should always be passing in Unicode, so we need 
     925        # to convert it if arcgisscripting is loaded. 
     926 
     927        if sys.modules.has_key(u'arcgisscripting'): 
     928            value = UnicodeToUserPreferredEncoding(value) 
    846929 
    847930        # The caller wants to set an attribute of the wrapped object. Set it. 
     
    909992 
    910993        # Build the source code needed to invoke the method. 
    911          
     994        # 
     995        # As of ArcGIS 9.2, when the geoprocessor is obtained through the 
     996        # arcgisscripting Python module, it requires we give it 8-bit strings, 
     997        # but if we obtain it through COM Automation, it requires Unicode 
     998        # strings. The caller should always be passing in Unicode, so we need 
     999        # to convert it to 8-bit if arcgisscripting is loaded. 
     1000 
    9121001        sourceCode = 'self._Object.%s(' % method.__name__ 
    9131002        for argName in _args: 
    9141003            if not sourceCode.endswith('('): 
    9151004                sourceCode = sourceCode + ', ' 
    916             sourceCode = sourceCode + '%s=_locals[\'%s\']' % (argName, argName) 
     1005            if sys.modules.has_key(u'arcgisscripting'): 
     1006                sourceCode = sourceCode + '%s=UnicodeToUserPreferredEncoding(_locals[\'%s\'])' % (argName, argName) 
     1007            else: 
     1008                sourceCode = sourceCode + '%s=UserPreferredEncodingToUnicode(_locals[\'%s\'])' % (argName, argName) 
    9171009        if _varargs is not None: 
    9181010            if not sourceCode.endswith('('): 
    9191011                sourceCode = sourceCode + ', ' 
    920             sourceCode = sourceCode + '*_locals[\'%s\'] ' % _varargs 
    921         if _varkw is not None: 
    922             if not sourceCode.endswith('('): 
    923                 sourceCode = sourceCode + ', ' 
    924             sourceCode = sourceCode + '**(_locals[\'%s\']) ' % _varkw 
     1012            if sys.modules.has_key(u'arcgisscripting'): 
     1013                sourceCode = sourceCode + '*UnicodeToUserPreferredEncoding(_locals[\'%s\']) ' % _varargs 
     1014            else: 
     1015                sourceCode = sourceCode + '*UserPreferredEncodingToUnicode(_locals[\'%s\']) ' % _varargs 
    9251016        sourceCode = sourceCode + ')' 
    9261017 
     
    9501041            else: 
    9511042                _retval = eval(sourceCode, globals(), locals()) 
     1043 
     1044            # Convert the returned value to Unicode. 
     1045 
     1046            _retval = UserPreferredEncodingToUnicode(_retval)             
    9521047 
    9531048        # If we catch ArcGISError here, it is the com_error we just caught. 
  • MGET/Trunk/PythonPackage/src/GeoEco/DataManagement/ArcGISRasters.py

    r56 r65  
    233233u"""If True, the destination raster will be overwritten, if it exists. 
    234234 
    235 If False, a ValueError will be raised if the destination raster exists. 
    236  
    237 If the GeoEco GeoprocessorManager class is holding an instance of the ArcGIS 
    238 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    239 property determines whether destination rasters will be overwritten. This will 
    240 usually occur if this method is called from an ArcGIS geoprocessing script or 
    241 model. You can still control overwrite behavior by setting that property of the 
    242 geoprocessor to the desired value, either programmatically or from the 
    243 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog."""), 
    244     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     235If False, a ValueError will be raised if the destination raster exists."""), 
     236    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    245237 
    246238# Public method: ArcGISRaster.CopyToDirectory 
     
    275267    typeMetadata=BooleanTypeMetadata(), 
    276268    description=ArcGISRaster.Copy.__doc__.Obj.Arguments[3].Description, 
    277     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     269    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    278270 
    279271AddResultMetadata(ArcGISRaster.CopyToDirectory, u'destinationRaster', 
     
    400392    typeMetadata=BooleanTypeMetadata(), 
    401393    description=ArcGISRaster.Copy.__doc__.Obj.Arguments[3].Description, 
    402     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     394    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    403395 
    404396# Public method: ArcGISRaster.MoveToDirectory 
     
    433425    typeMetadata=BooleanTypeMetadata(), 
    434426    description=ArcGISRaster.Move.__doc__.Obj.Arguments[3].Description, 
    435     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     427    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    436428 
    437429AddResultMetadata(ArcGISRaster.MoveToDirectory, u'destinationRaster', 
  • MGET/Trunk/PythonPackage/src/GeoEco/DataManagement/BinaryRasters.py

    r56 r65  
    260260u"""If True, the output file will be overwritten, if it exists. 
    261261 
    262 If False, a ValueError will be raised if the output file exists. 
    263  
    264 If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    265 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    266 property determines whether output files will be overwritten. This will usually 
    267 occur if this method is called from an ArcGIS geoprocessing script or model. You 
    268 can still control overwrite behavior by setting that property of the 
    269 geoprocessor to the desired value, either programmatically or from the 
    270 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog."""), 
    271     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     262If False, a ValueError will be raised if the output file exists."""), 
     263    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    272264 
    273265# Public method: BinaryRaster.ToArcInfoASCIIGrid 
     
    458450u"""If True, the output file will be overwritten, if it exists. 
    459451 
    460 If False, a ValueError will be raised if the output file exists. 
    461  
    462 If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    463 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    464 property determines whether output files will be overwritten. This will usually 
    465 occur if this method is called from an ArcGIS geoprocessing script or model. You 
    466 can still control overwrite behavior by setting that property of the 
    467 geoprocessor to the desired value, either programmatically or from the 
    468 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog."""), 
    469     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     452If False, a ValueError will be raised if the output file exists."""), 
     453    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    470454 
    471455# Public method: BinaryRaster.ToArcGISRaster 
     
    643627u"""If True, the output raster will be overwritten, if it exists. 
    644628 
    645 If False, a ValueError will be raised if the output raster exists. 
    646  
    647 If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    648 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    649 property determines whether output rasters will be overwritten. This will usually 
    650 occur if this method is called from an ArcGIS geoprocessing script or model. You 
    651 can still control overwrite behavior by setting that property of the 
    652 geoprocessor to the desired value, either programmatically or from the 
    653 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog."""), 
    654     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     629If False, a ValueError will be raised if the output raster exists."""), 
     630    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    655631 
    656632 
  • MGET/Trunk/PythonPackage/src/GeoEco/DataManagement/Directories.py

    r56 r65  
    459459This parameter is ignored if the deleteExistingDestinationDirectory 
    460460parameter is True, since that parameter will cause any existing files to be 
    461 deleted. 
    462  
    463 If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    464 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    465 property determines whether destination files will be overwritten. This will 
    466 usually occur if this method is called from an ArcGIS geoprocessing script or 
    467 model. You can still control overwrite behavior by setting that property of the 
    468 geoprocessor to the desired value, either programmatically or from the 
    469 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog."""), 
    470     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     461deleted."""), 
     462    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    471463 
    472464AddArgumentMetadata(Directory.Copy, u'refreshArcGISCatalog', 
     
    531523    typeMetadata=BooleanTypeMetadata(), 
    532524    description=Directory.Copy.__doc__.Obj.Arguments[4].Description, 
    533     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     525    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    534526 
    535527AddArgumentMetadata(Directory.CopyToDirectory, u'refreshArcGISCatalog', 
     
    781773    typeMetadata=BooleanTypeMetadata(), 
    782774    description=Directory.Copy.__doc__.Obj.Arguments[4].Description, 
    783     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     775    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    784776 
    785777AddArgumentMetadata(Directory.Move, u'refreshArcGISCatalog', 
     
    847839    typeMetadata=BooleanTypeMetadata(), 
    848840    description=Directory.Move.__doc__.Obj.Arguments[4].Description, 
    849     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     841    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    850842 
    851843AddArgumentMetadata(Directory.MoveToDirectory, u'refreshArcGISCatalog', 
  • MGET/Trunk/PythonPackage/src/GeoEco/DataManagement/Files.py

    r56 r65  
    399399u"""If True, the destination file will be overwritten, if it exists. 
    400400 
    401 If False, a ValueError will be raised if the destination file exists. 
    402  
    403 If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    404 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    405 property determines whether destination files will be overwritten. This will 
    406 usually occur if this method is called from an ArcGIS geoprocessing script or 
    407 model. You can still control overwrite behavior by setting that property of the 
    408 geoprocessor to the desired value, either programmatically or from the 
    409 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog."""), 
    410     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     401If False, a ValueError will be raised if the destination file exists."""), 
     402    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    411403 
    412404AddArgumentMetadata(File.Copy, u'refreshArcGISCatalog', 
     
    465457    typeMetadata=BooleanTypeMetadata(), 
    466458    description=File.Copy.__doc__.Obj.Arguments[3].Description, 
    467     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     459    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    468460 
    469461AddArgumentMetadata(File.CopyToDirectory, u'refreshArcGISCatalog', 
     
    522514already exist. 
    523515 
    524 If False, a ValueError will be raised if any destination files already exist. 
    525  
    526 If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    527 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    528 property determines whether destination files will be overwritten. This will 
    529 usually occur if this method is called from an ArcGIS geoprocessing script or 
    530 model. You can still control overwrite behavior by setting that property of the 
    531 geoprocessor to the desired value, either programmatically or from the 
    532 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog."""), 
    533     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     516If False, a ValueError will be raised if any destination files already exist."""), 
     517    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    534518 
    535519AddArgumentMetadata(File.Decompress, u'refreshArcGISCatalog', 
     
    759743    typeMetadata=BooleanTypeMetadata(), 
    760744    description=File.Copy.__doc__.Obj.Arguments[3].Description, 
    761     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     745    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    762746 
    763747AddArgumentMetadata(File.Move, u'refreshArcGISCatalog', 
     
    816800    typeMetadata=BooleanTypeMetadata(), 
    817801    description=File.Move.__doc__.Obj.Arguments[3].Description, 
    818     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     802    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    819803 
    820804AddArgumentMetadata(File.MoveToDirectory, u'refreshArcGISCatalog', 
  • MGET/Trunk/PythonPackage/src/GeoEco/DataManagement/HDFs.py

    r56 r65  
    528528u"""If True, the output file will be overwritten, if it exists. 
    529529 
    530 If False, a ValueError will be raised if the output file exists. 
    531  
    532 If the GeoEco Geoprocessor Manager class is holding an instance of the ArcGIS 
    533 geoprocessor, this parameter is ignored and the geoprocessor's OverwriteOutput 
    534 property determines whether output files will be overwritten. This will usually 
    535 occur if this method is called from an ArcGIS geoprocessing script or model. You 
    536 can still control overwrite behavior by setting that property of the 
    537 geoprocessor to the desired value, either programmatically or from the 
    538 Geoprocessing tab of the Options dialog under the Tools menu in ArcCatalog."""), 
    539     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     530If False, a ValueError will be raised if the output file exists."""), 
     531    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    540532 
    541533# Public method: HDF.SDSToArcGISRaster 
     
    684676    typeMetadata=BooleanTypeMetadata(), 
    685677    description=HDF.ExtractHeader.__doc__.Obj.Arguments[3].Description, 
    686     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     678    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    687679 
    688680# Public method: HDF.SDSToArcInfoASCIIGrid 
     
    740732    typeMetadata=BooleanTypeMetadata(), 
    741733    description=HDF.ExtractHeader.__doc__.Obj.Arguments[3].Description, 
    742     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     734    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    743735 
    744736# Public method: HDF.SDSToBinaryRaster 
     
    776768    typeMetadata=BooleanTypeMetadata(), 
    777769    description=HDF.ExtractHeader.__doc__.Obj.Arguments[3].Description, 
    778     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     770    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    779771 
    780772 
  • MGET/Trunk/PythonPackage/src/GeoEco/DataManagement/Shapefiles.py

    r56 r65  
    179179For more information about shapefiles, see `ESRI Shapefile Technical Description 
    180180<http://www.esri.com/library/whitepapers/pdfs/shapefile.pdf>`_."""), 
    181     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     181    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    182182 
    183183# Public method: Shapefile.CopyToDirectory 
     
    208208    typeMetadata=BooleanTypeMetadata(), 
    209209    description=Shapefile.Copy.__doc__.Obj.Arguments[3].Description, 
    210     overriddenByArcGISGeoprocessorVariable=u'OverwriteOutput') 
     210    initializeToArcGISGeoprocessorVariable=u'OverwriteOutput') 
    211211 
    212212AddResultMetadata(Shapefile.CopyToDirectory, u'destinationShapefile', 
  • MGET/Trunk/PythonPackage/src/GeoEco/Internationalization.py

    r42 r65  
    1919# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA. 
    2020 
     21import codecs 
    2122import locale 
    2223import gettext 
     
    2526import os.path 
    2627import sys 
     28import types 
    2729 
    2830def _InitializeTranslationsClass(): 
     
    7981    _ = _gettext 
    8082 
     83_UserPreferredEncoder = None 
     84 
     85def UnicodeToUserPreferredEncoding(obj): 
     86    if isinstance(obj, types.ListType): 
     87        return _EncodeList(obj) 
     88    if isinstance(obj, types.TupleType): 
     89        l = list(obj) 
     90        l = _EncodeList(l) 
     91        return tuple(l) 
     92    if not isinstance(obj, types.UnicodeType): 
     93        return obj 
     94    if globals()['_UserPreferredEncoder'] is None: 
     95        try: 
     96            globals()['_UserPreferredEncoder'] = codecs.getencoder(locale.getpreferredencoding(do_setlocale=False)) 
     97        except: 
     98            globals()['_UserPreferredEncoder'] = codecs.getencoder('ascii') 
     99    return globals()['_UserPreferredEncoder'](obj, 'strict')[0] 
     100 
     101def _EncodeList(obj): 
     102    for i in range(len(obj)): 
     103        obj[i] = UnicodeToUserPreferredEncoding(obj[i]) 
     104    return obj 
     105 
     106_UserPreferredDecoder = None 
     107 
     108def UserPreferredEncodingToUnicode(obj): 
     109    if isinstance(obj, types.ListType): 
     110        return _DecodeList(obj) 
     111    if isinstance(obj, types.TupleType): 
     112        l = list(obj) 
     113        l = _DecodeList(l) 
     114        return tuple(l) 
     115    if not isinstance(obj, types.StringType): 
     116        return obj 
     117    if globals()['_UserPreferredDecoder'] is None: 
     118        try: 
     119            globals()['_UserPreferredDecoder'] = codecs.getdecoder(locale.getpreferredencoding(do_setlocale=False)) 
     120        except: 
     121            globals()['_UserPreferredDecoder'] = codecs.getdecoder('ascii') 
     122    return globals()['_UserPreferredDecoder'](obj, 'strict')[0] 
     123 
     124def _DecodeList(obj): 
     125    for i in range(len(obj)): 
     126        obj[i] = UserPreferredEncodingToUnicode(obj[i]) 
     127    return obj 
     128         
    81129 
    82130############################################################################### 
     
    84132############################################################################### 
    85133 
    86 __all__ = ['_'] 
     134__all__ = ['_', 'UnicodeToUserPreferredEncoding', 'UserPreferredEncodingToUnicode'] 
  • MGET/Trunk/PythonPackage/src/GeoEco/Logging.py

    r56 r65  
    2727 
    2828from GeoEco.DynamicDocString import DynamicDocString 
    29 from GeoEco.Internationalization import _ 
     29from GeoEco.Internationalization import _, UnicodeToUserPreferredEncoding, UserPreferredEncodingToUnicode 
    3030 
    3131 
     
    420420            from GeoEco.ArcGIS import GeoprocessorManager 
    421421            message = self.format(record) 
     422            if sys.modules.has_key(u'arcgisscripting'): 
     423                message = UnicodeToUserPreferredEncoding(message) 
     424            else: 
     425                message = UserPreferredEncodingToUnicode(message) 
    422426            if record.levelno >= logging.ERROR: 
    423427                GeoprocessorManager.GetGeoprocessor().AddError(message) 
  • MGET/Trunk/PythonPackage/src/GeoEco/Metadata.py

    r56 r65  
    594594                d.Initialize() 
    595595 
    596             # Override any of the caller's values with values from ArcGIS 
    597             # geoprocessor variables. 
    598  
    599             import GeoEco.MetadataUtils 
    600  
    601             for i in range(len(args)):         
    602                 argMetadata = methodMetadata.Arguments[i] 
    603                 if argMetadata.OverriddenByArcGISGeoprocessorVariable is not None: 
    604                     from GeoEco.ArcGIS import GeoprocessorManager 
    605                     gp = GeoprocessorManager.GetWrappedGeoprocessor() 
    606                     if gp is not None: 
    607                         parentFrame.f_locals[argMetadata.Name] = getattr(gp, argMetadata.OverriddenByArcGISGeoprocessorVariable) 
    608                         GeoEco.MetadataUtils.SaveChangesToFrameLocals(parentFrame) 
    609  
    610596            # Validate the value of each argument. The validation code may 
    611597            # change the values. 
     598 
     599            import GeoEco.MetadataUtils 
    612600 
    613601            for i in range(len(args)):         
     
    966954class ArgumentMetadata(object): 
    967955 
    968     def __init__(self, name, methodMetadata, typeMetadata, description=None, direction=u'Input', overriddenByArcGISGeoprocessorVariable=None, arcGISDisplayName=None, arcGISCategory=None, arcGISParameterDependencies=None): 
     956    def __init__(self, name, methodMetadata, typeMetadata, description=None, direction=u'Input', initializeToArcGISGeoprocessorVariable=None, arcGISDisplayName=None, arcGISCategory=None, arcGISParameterDependencies=None): 
    969957        assert isinstance(name, types.UnicodeType), u'name must be a unicode string.' 
    970958        self._Name = name 
     
    982970        self.Description = description 
    983971        self.Direction = direction 
    984         self.OverriddenByArcGISGeoprocessorVariable = overriddenByArcGISGeoprocessorVariable 
     972        self.InitializeToArcGISGeoprocessorVariable = initializeToArcGISGeoprocessorVariable 
    985973        self.ArcGISDisplayName = arcGISDisplayName 
    986974        self.ArcGISCategory = arcGISCategory 
     
    10271015    Direction = property(_GetDirection, _SetDirection, doc=DynamicDocString()) 
    10281016 
    1029     def _GetOverriddenByArcGISGeoprocessorVariable(self): 
    1030         return self._OverriddenByArcGISGeoprocessorVariable 
    1031      
    1032     def _SetOverriddenByArcGISGeoprocessorVariable(self, value): 
    1033         assert isinstance(value, (types.NoneType, types.UnicodeType)), u'OverriddenByArcGISGeoprocessorVariable must be a unicode string, or None.' 
    1034         assert self.IsFormalParameter or value is None, u'OverriddenByArcGISGeoprocessorVariable may only be specified for formal parameters. It must remain None for the arbitrary argument list (varargs) and keywords dictionary (varkw) parameters.' 
     1017    def _GetInitializeToArcGISGeoprocessorVariable(self): 
     1018        return self._InitializeToArcGISGeoprocessorVariable 
     1019     
     1020    def _SetInitializeToArcGISGeoprocessorVariable(self, value): 
     1021        assert isinstance(value, (types.NoneType, types.UnicodeType)), u'InitializeToArcGISGeoprocessorVariable must be a unicode string, or None.' 
     1022        assert self.IsFormalParameter or value is None, u'InitializeToArcGISGeoprocessorVariable may only be specified for formal parameters. It must remain None for the arbitrary argument list (varargs) and keywords dictionary (varkw) parameters.' 
    10351023        if value is not None: 
    1036             self._OverriddenByArcGISGeoprocessorVariable = value.strip() 
     1024            self._InitializeToArcGISGeoprocessorVariable = value.strip() 
    10371025        else: 
    1038             self._OverriddenByArcGISGeoprocessorVariable = value 
    1039          
    1040     OverriddenByArcGISGeoprocessorVariable = property(_GetOverriddenByArcGISGeoprocessorVariable, _SetOverriddenByArcGISGeoprocessorVariable, doc=DynamicDocString()) 
     1026            self._InitializeToArcGISGeoprocessorVariable = value 
     1027         
     1028    InitializeToArcGISGeoprocessorVariable = property(_GetInitializeToArcGISGeoprocessorVariable, _SetInitializeToArcGISGeoprocessorVariable, doc=DynamicDocString()) 
    10411029 
    10421030    def _GetArcGISDisplayName(self): 
     
    11291117        Metadata.AppendPropertyDocutilsXMLNodes(self, u'Description', node, document) 
    11301118        Metadata.AppendPropertyXMLNode(self, u'Direction', node, document) 
    1131         Metadata.AppendPropertyXMLNode(self, u'OverriddenByArcGISGeoprocessorVariable', node, document) 
     1119        Metadata.AppendPropertyXMLNode(self, u'InitializeToArcGISGeoprocessorVariable', node, document) 
    11321120        Metadata.AppendPropertyXMLNode(self, u'ArcGISDisplayName', node, document) 
    11331121        Metadata.AppendPropertyXMLNode(self, u'ArcGISCategory', node, document) 
     
    15311519    method.__doc__.Obj = MethodMetadata(unicode(method.__name__), cls.__doc__.Obj, shortDescription, longDescription, isExposedToPythonCallers, isExposedByCOM, isExposedAsArcGISTool, arcGISDisplayName, arcGISToolCategory, dependencies) 
    15321520 
    1533 def AddArgumentMetadata(method, argumentName, typeMetadata, description=None, direction=u'Input', overriddenByArcGISGeoprocessorVariable=None, arcGISDisplayName=None, arcGISCategory=None, arcGISParameterDependencies=None, cls=None, module=None): 
     1521def AddArgumentMetadata(method, argumentName, typeMetadata, description=None, direction=u'Input', initializeToArcGISGeoprocessorVariable=None, arcGISDisplayName=None, arcGISCategory=None, arcGISParameterDependencies=None, cls=None, module=None): 
    15341522    module = _GetModuleObject(module) 
    15351523    if cls is not None: 
     
    15381526    assert isinstance(method.__doc__, DynamicDocString) and isinstance(method.__doc__.Obj, MethodMetadata), u'The %s.%s.__doc__ must be an instance of GeoEco.Metadata.DynamicDocString, and %s.%s.__doc__.Obj must be an instance of GeoEco.Metadata.MethodMetadata. Before calling GeoEco.Metadata.AddArgumentMetadata, use GeoEco.Metadata.AddMethodMetadata to add MethodMetadata to %s.%s.' % (cls.__name__, method.__name__, cls.__name__, method.__name__, cls.__name__, method.__name__) 
    15391527    assert method.__doc__.Obj.GetArgumentByName(unicode(argumentName)) is None, u'%s.%s.__doc__.Obj.Arguments already has ArgumentMetadata for the %s argument. Do not call AddArgumentMetadata for arguments that already have metadata.' % (cls.__name__, method.__name__, argumentName) 
    1540     method.__doc__.Obj.Arguments.append(ArgumentMetadata(unicode(argumentName), method.__doc__.Obj, typeMetadata, description, direction, overriddenByArcGISGeoprocessorVariable, arcGISDisplayName, arcGISCategory, arcGISParameterDependencies)) 
     1528    method.__doc__.Obj.Arguments.append(ArgumentMetadata(unicode(argumentName), method.__doc__.Obj, typeMetadata, description, direction, initializeToArcGISGeoprocessorVariable, arcGISDisplayName, arcGISCategory, arcGISParameterDependencies)) 
    15411529 
    15421530 
  • MGET/Trunk/VisualStudioSolutions/CreateArcGISToolbox/Program.cs

    r56 r65  
    151151        public XmlElement Description; 
    152152        public string Direction; 
    153         public string OverriddenByArcGISGeoprocessorVariable; 
     153        public string InitializeToArcGISGeoprocessorVariable; 
    154154        public string ArcGISDisplayName; 
    155155        public string ArcGISCategory; 
  • MGET/Trunk/VisualStudioSolutions/RegisterToolboxWithArcCatalog/RegisterToolboxWithArcCatalog.csproj

    r11 r65  
    2929  </PropertyGroup> 
    3030  <ItemGroup> 
    31     <Reference Include="ESRI.ArcGIS.ArcCatalog, Version=9.1.0.722, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86" /> 
    32     <Reference Include="ESRI.ArcGIS.ArcMapUI, Version=9.1.0.722, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86" /> 
    33     <Reference Include="ESRI.ArcGIS.Display, Version=9.1.0.722, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86" /> 
    34     <Reference Include="ESRI.ArcGIS.Framework, Version=9.1.0.722, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86" /> 
    35     <Reference Include="ESRI.ArcGIS.Geodatabase, Version=9.1.0.722, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86" /> 
    36     <Reference Include="ESRI.ArcGIS.Geoprocessing, Version=9.1.0.722, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86" /> 
    37     <Reference Include="ESRI.ArcGIS.GeoprocessingUI, Version=9.1.0.722, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86" /> 
    38     <Reference Include="ESRI.ArcGIS.System, Version=9.1.0.722, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86" /> 
     31    <Reference Include="ESRI.ArcGIS.ArcCatalog, Version=9.1.0.722, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86"> 
     32      <SpecificVersion>False</SpecificVersion> 
     33    </Reference> 
     34    <Reference Include="ESRI.ArcGIS.ArcMapUI, Version=9.1.0.722, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86"> 
     35      <SpecificVersion>False</SpecificVersion> 
     36    </Reference> 
     37    <Reference Include="ESRI.ArcGIS.Display, Version=9.1.0.722, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86"> 
     38      <SpecificVersion>False</SpecificVersion> 
     39    </Reference> 
     40    <Reference Include="ESRI.ArcGIS.Framework, Version=9.1.0.722, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86"> 
     41      <SpecificVersion>False</SpecificVersion> 
     42    </Reference> 
     43    <Reference Include="ESRI.ArcGIS.Geodatabase, Version=9.1.0.722, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86"> 
     44      <SpecificVersion>False</SpecificVersion> 
     45    </Reference> 
     46    <Reference Include="ESRI.ArcGIS.Geoprocessing, Version=9.1.0.722, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86"> 
     47      <SpecificVersion>False</SpecificVersion> 
     48    </Reference> 
     49    <Reference Include="ESRI.ArcGIS.GeoprocessingUI, Version=9.1.0.722, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86"> 
     50      <SpecificVersion>False</SpecificVersion> 
     51    </Reference> 
     52    <Reference Include="ESRI.ArcGIS.System, Version=9.1.0.722, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86"> 
     53      <SpecificVersion>False</SpecificVersion> 
     54    </Reference> 
    3955    <Reference Include="System" /> 
    4056  </ItemGroup>