<!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::PythonFunction 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="a00152.html">PythonFunction</a>
</div>
</div>
<div class="contents">
<h1>frepple::utils::PythonFunction Class Reference</h1><!-- doxytag: class="frepple::utils::PythonFunction" --><!-- doxytag: inherits="frepple::utils::PythonObject" -->
<p>This call is a wrapper around a Python function that can be called from the C++ code.
<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::PythonFunction:</div>
<div class="dynsection">
<div class="center"><img src="a00618.png" border="0" usemap="#frepple_1_1utils_1_1_python_function_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1utils_1_1_python_function_inherit__map" id="frepple_1_1utils_1_1_python_function_inherit__map">
<area shape="rect" id="node2" href="a00154.html" title="This class handles two-way translation between the data types in C++ and Python." alt="" coords="11,83,189,111"/>
<area shape="rect" id="node4" href="a00047.html" title="This abstract class represents a attribute and value pair for updating objects in..." alt="" coords="13,6,187,34"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00619.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"><a class="el" href="a00154.html">PythonObject</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00152.html#a6af5206c52b7d44d5f451b0162040868">call</a> (const PyObject *, const PyObject *) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00154.html">PythonObject</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00152.html#a7b8d5006f9ad79fa6b77ff72e42e8d24">call</a> (const PyObject *) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00154.html">PythonObject</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00152.html#a7f199c39019f133986783dfc6017b640">call</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00152.html#ae41c2b578bf9253de49ac31b7f5145cb">operator bool</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00152.html#a6816715e7f950813fcb1bbc3196d8627">operator const PyObject *</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00152.html#ab72d2f7d91618973719dd182b4010217">operator string</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00152.html">PythonFunction</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00152.html#a399b628a71ebec343a1ac01df9e9056d">operator=</a> (const <a class="el" href="a00152.html">PythonFunction</a> &o)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00152.html#aeb35d6bb2d2585a94bebd081d8ded5b0">PythonFunction</a> (const <a class="el" href="a00152.html">PythonFunction</a> &o)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00152.html#ac974e9387de178b97c287277c5999669">PythonFunction</a> (PyObject *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00152.html#a10000c1a4ab56fae9b7639c2bfe6318a">PythonFunction</a> (const string &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00152.html#a178f0b503fd228cc6ec0540d84c557d1">PythonFunction</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00152.html#aa6c0c331f1fb2615b3be94b5b8233066">~PythonFunction</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This call is a wrapper around a Python function that can be called from the C++ code. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l03017">3017</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a178f0b503fd228cc6ec0540d84c557d1"></a><!-- doxytag: member="frepple::utils::PythonFunction::PythonFunction" ref="a178f0b503fd228cc6ec0540d84c557d1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::utils::PythonFunction::PythonFunction </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l03021">3021</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a10000c1a4ab56fae9b7639c2bfe6318a"></a><!-- doxytag: member="frepple::utils::PythonFunction::PythonFunction" ref="a10000c1a4ab56fae9b7639c2bfe6318a" args="(const string &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::utils::PythonFunction::PythonFunction </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>n</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Definition at line <a class="el" href="a00233_source.html#l00578">578</a> of file <a class="el" href="a00233_source.html">pythonutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac974e9387de178b97c287277c5999669"></a><!-- doxytag: member="frepple::utils::PythonFunction::PythonFunction" ref="ac974e9387de178b97c287277c5999669" args="(PyObject *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::utils::PythonFunction::PythonFunction </td>
<td>(</td>
<td class="paramtype">PyObject * </td>
<td class="paramname"> <em>p</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Definition at line <a class="el" href="a00233_source.html#l00608">608</a> of file <a class="el" href="a00233_source.html">pythonutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aeb35d6bb2d2585a94bebd081d8ded5b0"></a><!-- doxytag: member="frepple::utils::PythonFunction::PythonFunction" ref="aeb35d6bb2d2585a94bebd081d8ded5b0" args="(const PythonFunction &o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::utils::PythonFunction::PythonFunction </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00152.html">PythonFunction</a> & </td>
<td class="paramname"> <em>o</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy constructor. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l03030">3030</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa6c0c331f1fb2615b3be94b5b8233066"></a><!-- doxytag: member="frepple::utils::PythonFunction::~PythonFunction" ref="aa6c0c331f1fb2615b3be94b5b8233066" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::utils::PythonFunction::~PythonFunction </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l03045">3045</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="a6af5206c52b7d44d5f451b0162040868"></a><!-- doxytag: member="frepple::utils::PythonFunction::call" ref="a6af5206c52b7d44d5f451b0162040868" args="(const PyObject *, const PyObject *) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00154.html">PythonObject</a> frepple::utils::PythonFunction::call </td>
<td>(</td>
<td class="paramtype">const PyObject * </td>
<td class="paramname"> <em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const PyObject * </td>
<td class="paramname"> <em>q</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Call the Python function with two arguments. </p>
<p>Definition at line <a class="el" href="a00233_source.html#l00676">676</a> of file <a class="el" href="a00233_source.html">pythonutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7b8d5006f9ad79fa6b77ff72e42e8d24"></a><!-- doxytag: member="frepple::utils::PythonFunction::call" ref="a7b8d5006f9ad79fa6b77ff72e42e8d24" args="(const PyObject *) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00154.html">PythonObject</a> frepple::utils::PythonFunction::call </td>
<td>(</td>
<td class="paramtype">const PyObject * </td>
<td class="paramname"> <em>p</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Call the Python function with one argument. </p>
<p>Definition at line <a class="el" href="a00233_source.html#l00660">660</a> of file <a class="el" href="a00233_source.html">pythonutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7f199c39019f133986783dfc6017b640"></a><!-- doxytag: member="frepple::utils::PythonFunction::call" ref="a7f199c39019f133986783dfc6017b640" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00154.html">PythonObject</a> frepple::utils::PythonFunction::call </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Call the Python function without arguments. </p>
<p>Definition at line <a class="el" href="a00233_source.html#l00644">644</a> of file <a class="el" href="a00233_source.html">pythonutils.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae41c2b578bf9253de49ac31b7f5145cb"></a><!-- doxytag: member="frepple::utils::PythonFunction::operator bool" ref="ae41c2b578bf9253de49ac31b7f5145cb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::utils::PythonFunction::operator bool </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Conversion operator to bool. </p>
<p>Reimplemented from <a class="el" href="a00154.html#a0678453851ef002c5890e958d31ebd94">frepple::utils::PythonObject</a>.</p>
<p>Definition at line <a class="el" href="a00252_source.html#l03054">3054</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6816715e7f950813fcb1bbc3196d8627"></a><!-- doxytag: member="frepple::utils::PythonFunction::operator const PyObject *" ref="a6816715e7f950813fcb1bbc3196d8627" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::utils::PythonFunction::operator const PyObject * </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Conversion operator to a Python pointer. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l03048">3048</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab72d2f7d91618973719dd182b4010217"></a><!-- doxytag: member="frepple::utils::PythonFunction::operator string" ref="ab72d2f7d91618973719dd182b4010217" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::utils::PythonFunction::operator string </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Conversion operator to a string. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l03051">3051</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a399b628a71ebec343a1ac01df9e9056d"></a><!-- doxytag: member="frepple::utils::PythonFunction::operator=" ref="a399b628a71ebec343a1ac01df9e9056d" args="(const PythonFunction &o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00152.html">PythonFunction</a>& frepple::utils::PythonFunction::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00152.html">PythonFunction</a> & </td>
<td class="paramname"> <em>o</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assignment operator. </p>
<p>Reimplemented from <a class="el" href="a00154.html#a7722d583f48f6213f482c7ce878dae94">frepple::utils::PythonObject</a>.</p>
<p>Definition at line <a class="el" href="a00252_source.html#l03036">3036</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>
