pytecplot 1.3.0__zip → 1.3.1__zip

{pytecplot-1.3.0 → pytecplot-1.3.1r110473}/docs/html/api/tecplot.macros.html

@@ -1,19 +1,20 @@
 
 <!DOCTYPE html>
 
-<html xmlns="http://www.w3.org/1999/xhtml">
+<html>
   <head>
     <meta charset="utf-8" />
-    <title>Macros &#8212; PyTecplot 1.3.0 documentation</title>
-    <link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Macros &#8212; PyTecplot 1.3.1 documentation</title>
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" />
     
     <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
     <script src="../_static/jquery.js"></script>
     <script src="../_static/underscore.js"></script>
     <script src="../_static/doctools.js"></script>
     <script src="../_static/language_data.js"></script>
-    <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
+    <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
     
     <script src="../_static/sidebar.js"></script>
     
@@ -51,6 +52,7 @@
     
 
           <li class="nav-item nav-item-1"><a href="../reference.html" accesskey="U">Reference</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Macros</a></li>
     <li class="right">
         
 
@@ -90,13 +92,13 @@
 </div>
 <div class="section" id="macro-execute-command">
 <h2><a class="toc-backref" href="#id2">macro.execute_command()</a><a class="headerlink" href="#macro-execute-command" title="Permalink to this headline">¶</a></h2>
-<dl class="function">
+<dl class="py function">
 <dt id="tecplot.macro.execute_command">
-<code class="sig-prename descclassname">tecplot.macro.</code><code class="sig-name descname">execute_command</code><span class="sig-paren">(</span><em class="sig-param">command</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/tecplot/macro.html#execute_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tecplot.macro.execute_command" title="Permalink to this definition">¶</a></dt>
+<code class="sig-prename descclassname">tecplot.macro.</code><code class="sig-name descname">execute_command</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">command</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/tecplot/macro.html#execute_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tecplot.macro.execute_command" title="Permalink to this definition">¶</a></dt>
 <dd><p>Runs a series of tecplot macro commands.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><p><strong>command</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a>) – The macro commands to be run.</p>
+<dd class="field-odd"><p><strong>command</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a>) – The macro commands to be run.</p>
 </dd>
 </dl>
 <div class="admonition warning">
@@ -145,14 +147,14 @@ and intrinsic variables.</p>
 </div>
 <div class="section" id="macro-execute-extended-command">
 <h2><a class="toc-backref" href="#id3">macro.execute_extended_command()</a><a class="headerlink" href="#macro-execute-extended-command" title="Permalink to this headline">¶</a></h2>
-<dl class="function">
+<dl class="py function">
 <dt id="tecplot.macro.execute_extended_command">
-<code class="sig-prename descclassname">tecplot.macro.</code><code class="sig-name descname">execute_extended_command</code><span class="sig-paren">(</span><em class="sig-param">command_processor_id</em>, <em class="sig-param">command</em>, <em class="sig-param">raw_data=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/tecplot/macro.html#execute_extended_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tecplot.macro.execute_extended_command" title="Permalink to this definition">¶</a></dt>
+<code class="sig-prename descclassname">tecplot.macro.</code><code class="sig-name descname">execute_extended_command</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">command_processor_id</span></em>, <em class="sig-param"><span class="n">command</span></em>, <em class="sig-param"><span class="n">raw_data</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/tecplot/macro.html#execute_extended_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tecplot.macro.execute_extended_command" title="Permalink to this definition">¶</a></dt>
 <dd><p>Runs a tecplot macro command defined in an addon.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>command_processor_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a>) – <p>A unique string used to
+<li><p><strong>command_processor_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a>) – <p>A unique string used to
 determine the API to call when an extended macro command is
 processed. API’s are provided by add-ons or applications
 that extend the Tecplot macro language.</p>
@@ -169,9 +171,9 @@ In that case either of these strings would be passed in the
 <em>command_processor_id</em> parameter to indicate the version of the
 API to use.</p>
 </p></li>
-<li><p><strong>command</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a>) – The command to run.</p></li>
-<li><p><strong>raw_data</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a>) – Raw data required for the command, if any
-(default: <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.8)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>).</p></li>
+<li><p><strong>command</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a>) – The command to run.</p></li>
+<li><p><strong>raw_data</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a>) – Raw data required for the command, if any
+(default: <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.9)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>).</p></li>
 </ul>
 </dd>
 </dl>
@@ -200,13 +202,13 @@ acceptable.</p>
 </div>
 <div class="section" id="macro-execute-file">
 <h2><a class="toc-backref" href="#id4">macro.execute_file()</a><a class="headerlink" href="#macro-execute-file" title="Permalink to this headline">¶</a></h2>
-<dl class="function">
+<dl class="py function">
 <dt id="tecplot.macro.execute_file">
-<code class="sig-prename descclassname">tecplot.macro.</code><code class="sig-name descname">execute_file</code><span class="sig-paren">(</span><em class="sig-param">filename</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/tecplot/macro.html#execute_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tecplot.macro.execute_file" title="Permalink to this definition">¶</a></dt>
+<code class="sig-prename descclassname">tecplot.macro.</code><code class="sig-name descname">execute_file</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">filename</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/tecplot/macro.html#execute_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tecplot.macro.execute_file" title="Permalink to this definition">¶</a></dt>
 <dd><p>Run a macro file.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a>) – The file to be run. (See note
+<dd class="field-odd"><p><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a>) – The file to be run. (See note
 below concerning absolute and relative paths.)</p>
 </dd>
 </dl>
@@ -226,7 +228,7 @@ should be used when running macro commands from python or when using
 <p><strong>Absolute and relative paths with PyTecplot</strong></p>
 <p>Relative paths, when used within the PyTecplot API are always from
 Python’s current working directory which can be obtained by calling
-<a class="reference external" href="https://docs.python.org/3/library/os.html#os.getcwd" title="(in Python v3.8)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.getcwd()</span></code></a>. This is true for batch and <a class="reference internal" href="tecplot.session.html#tecplot.session.connect" title="tecplot.session.connect"><code class="xref any py py-func docutils literal notranslate"><span class="pre">connected</span></code></a> modes. One exception to this is paths
+<a class="reference external" href="https://docs.python.org/3/library/os.html#os.getcwd" title="(in Python v3.9)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.getcwd()</span></code></a>. This is true for batch and <a class="reference internal" href="tecplot.session.html#tecplot.session.connect" title="tecplot.session.connect"><code class="xref any py py-func docutils literal notranslate"><span class="pre">connected</span></code></a> modes. One exception to this is paths
 within a macro command or file which will be relative to the Tecplot Engine’s home directory, which is typically the <a class="reference external" href="https://www.tecplot.com/products/tecplot-360">Tecplot 360</a>
 installation directory. Finally, when connected to a remote (non-local)
 instance of Tecplot 360, only absolute paths are allowed.</p>
@@ -245,21 +247,21 @@ respectively. Alternatively, one may use Python’s raw strings:
 </div>
 <div class="section" id="macro-execute-function">
 <h2><a class="toc-backref" href="#id5">macro.execute_function()</a><a class="headerlink" href="#macro-execute-function" title="Permalink to this headline">¶</a></h2>
-<dl class="function">
+<dl class="py function">
 <dt id="tecplot.macro.execute_function">
-<code class="sig-prename descclassname">tecplot.macro.</code><code class="sig-name descname">execute_function</code><span class="sig-paren">(</span><em class="sig-param">name</em>, <em class="sig-param">parameters=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/tecplot/macro.html#execute_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tecplot.macro.execute_function" title="Permalink to this definition">¶</a></dt>
+<code class="sig-prename descclassname">tecplot.macro.</code><code class="sig-name descname">execute_function</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">parameters</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/tecplot/macro.html#execute_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tecplot.macro.execute_function" title="Permalink to this definition">¶</a></dt>
 <dd><p>Runs a macro function.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>name</strong> – (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a>): Name of the macro function to run. This name
-is not case sensitive. Must be a non-zero length <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a>.</p></li>
-<li><p><strong>parameters</strong> – (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a>): Any parameters which the quick macro
-requires. Pass <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.8)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a> (default) for macro functions which require no
+<li><p><strong>name</strong> – (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a>): Name of the macro function to run. This name
+is not case sensitive. Must be a non-zero length <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a>.</p></li>
+<li><p><strong>parameters</strong> – (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><code class="xref any docutils literal notranslate"><span class="pre">str</span></code></a>): Any parameters which the quick macro
+requires. Pass <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.9)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a> (default) for macro functions which require no
 parameters. The parameters are passed as a string which includes
 the parenthesis. For example, if the macro function takes a
 string parameter and int parameter, pass
-<strong>‘(“string_parameter_name”, 2)’</strong> Default: <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.8)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a></p></li>
+<strong>‘(“string_parameter_name”, 2)’</strong> Default: <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.9)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a></p></li>
 </ul>
 </dd>
 </dl>
@@ -292,6 +294,7 @@ layout file and an integer as parameters:</p>
 </div>
 
 
+            <div class="clearer"></div>
           </div>
         </div>
       </div>
@@ -373,6 +376,7 @@ layout file and an integer as parameters:</p>
     
 
           <li class="nav-item nav-item-1"><a href="../reference.html" >Reference</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Macros</a></li>
     <li class="right">
         
 
@@ -392,11 +396,11 @@ layout file and an integer as parameters:</p>
     </div>  
     <div class="footer">
     &copy; Copyright 2020, Tecplot, Inc.
-    Last updated on Jul 09, 2020.
+    Last updated on Dec 01, 2020.
     
     <br />
 
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 2.4.1.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.3.1.
     </div>
 
   </body>