<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>C++ API frePPLe: frepple::utils::CommandPython Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="../styles.css" rel="stylesheet" type="text/css">
</head>
<body>
<div id="container">
<div id="menubar">
<div id="logo" align="center">
<br/><img src='../frepple.bmp' alt="frepple" /><br/>
<a href='http://www.frepple.com/'>
<strong>a Free<br/>Production Planning<br/>Library</strong>
</a>
</div>
<div id="menu">
<br/>
<h3><a href='../Main/HomePage.html'>Main</a></h3>
<h3><a href='../UI/Main.html'>User Manual</a></h3>
<h3><a href='../Tutorial/Main.html'>Tutorial</a></h3>
<h3><a href='../Frepple/Main.html'>Reference Manual</a></h3>
<h3><a href='../Main/FAQ.html'>FAQ</a></h3>
<h3><a href='index.html'>C++ API</a></h3>
<br/>
</div>
</div>
<div id="content">
<br/>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00256.html">frepple</a>::<a class="el" href="a00257.html">utils</a>::<a class="el" href="a00033.html">CommandPython</a>
</div>
</div>
<div class="contents">
<h1>frepple::utils::CommandPython Class Reference</h1><!-- doxytag: class="frepple::utils::CommandPython" --><!-- doxytag: inherits="frepple::utils::Command" -->
<p>This command executes Python code in the embedded interpreter.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00252_source.html">utils.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for frepple::utils::CommandPython:</div>
<div class="dynsection">
<div class="center"><img src="a00564.png" border="0" usemap="#frepple_1_1utils_1_1_command_python_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1utils_1_1_command_python_inherit__map" id="frepple_1_1utils_1_1_command_python_inherit__map">
<area shape="rect" id="node2" href="a00025.html" title="Abstract base class for all commands." alt="" coords="27,6,184,34"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00565.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00033.html#a2ff4959ce30411252022daa1da9af425">CommandPython</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00033.html#a3a7108daca9313128fac9864dd63b332">execute</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00033.html#a76cd3dde51c41babddb2b40b62afc577">getCommandLine</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00033.html#a12c421e4b18df9f7a0275b72dc4044b3">getFileName</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00033.html#a2aee8df4458cad71deef6101af535e10">setCommandLine</a> (const string &s)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00033.html#a53c31e4ba70e41711844e645f40dd2dc">setFileName</a> (const string &s)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00033.html#a3b462d2b152c06d10648490652bdcecd">~CommandPython</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00033.html#af71bbd41fa2d420e572cfe963ac17ba6">processorXMLInstruction</a> (const char *d)</td></tr>
<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="a00115.html">MetaClass</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00033.html#a679228b0372db2965ec58e1c34760ab7">metadata2</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This command executes Python code in the embedded interpreter. </p>
<p>The interpreter can execute generic scripts, and it also has access to the frePPLe objects.<br/>
The interpreter is multi-threaded. Multiple python scripts can run in parallel. Internally Python allows only one thread at a time to execute and the interpreter switches between the active threads, i.e. a quite primitive threading model.<br/>
FrePPLe uses a single global interpreter. A global Python variable or function is thus visible across multiple invocations of the Python interpreter. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l04075">4075</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2ff4959ce30411252022daa1da9af425"></a><!-- doxytag: member="frepple::utils::CommandPython::CommandPython" ref="a2ff4959ce30411252022daa1da9af425" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::utils::CommandPython::CommandPython </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l04089">4089</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3b462d2b152c06d10648490652bdcecd"></a><!-- doxytag: member="frepple::utils::CommandPython::~CommandPython" ref="a3b462d2b152c06d10648490652bdcecd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual frepple::utils::CommandPython::~CommandPython </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l04092">4092</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3a7108daca9313128fac9864dd63b332"></a><!-- doxytag: member="frepple::utils::CommandPython::execute" ref="a3a7108daca9313128fac9864dd63b332" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::utils::CommandPython::execute </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Executes the python command or source file. </p>
<p>Implements <a class="el" href="a00025.html#acc6f6bc4f9a9ce8cfa2de41fd12f3024">frepple::utils::Command</a>.</p>
<p>Definition at line <a class="el" href="a00233_source.html#l00054">54</a> of file <a class="el" href="a00233_source.html">pythonutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a76cd3dde51c41babddb2b40b62afc577"></a><!-- doxytag: member="frepple::utils::CommandPython::getCommandLine" ref="a76cd3dde51c41babddb2b40b62afc577" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string frepple::utils::CommandPython::getCommandLine </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the command line. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l04098">4098</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a12c421e4b18df9f7a0275b72dc4044b3"></a><!-- doxytag: member="frepple::utils::CommandPython::getFileName" ref="a12c421e4b18df9f7a0275b72dc4044b3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string frepple::utils::CommandPython::getFileName </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the filename. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l04101">4101</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="af71bbd41fa2d420e572cfe963ac17ba6"></a><!-- doxytag: member="frepple::utils::CommandPython::processorXMLInstruction" ref="af71bbd41fa2d420e572cfe963ac17ba6" args="(const char *d)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void frepple::utils::CommandPython::processorXMLInstruction </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>d</em></td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is called when a processing instruction is read. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l04110">4110</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2aee8df4458cad71deef6101af535e10"></a><!-- doxytag: member="frepple::utils::CommandPython::setCommandLine" ref="a2aee8df4458cad71deef6101af535e10" args="(const string &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::utils::CommandPython::setCommandLine </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>s</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the commandline field and clears the filename field. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l04095">4095</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a53c31e4ba70e41711844e645f40dd2dc"></a><!-- doxytag: member="frepple::utils::CommandPython::setFileName" ref="a53c31e4ba70e41711844e645f40dd2dc" args="(const string &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::utils::CommandPython::setFileName </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>s</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the filename field and clear the filename field. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l04104">4104</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a679228b0372db2965ec58e1c34760ab7"></a><!-- doxytag: member="frepple::utils::CommandPython::metadata2" ref="a679228b0372db2965ec58e1c34760ab7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00115.html">MetaClass</a> * <a class="el" href="a00033.html#a679228b0372db2965ec58e1c34760ab7">frepple::utils::CommandPython::metadata2</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Metadata for registration as an XML instruction. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l04107">4107</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="a00252_source.html">utils.h</a></li>
<li><a class="el" href="a00233_source.html">pythonutils.cpp</a></li>
</ul>
</div>
<hr size="1"/><address style="align: right;"><small>Documentation generated for frePPLe by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"/></a></small></address>
</div>
</div>
</body>
</html>
