Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 54cac1c2268db633d66eeff1b4faa585 > files > 431

frepple-doc-0.8.1-3.fc15.noarch.rpm

<!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::PythonType 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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;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="a00155.html">PythonType</a>
  </div>
</div>
<div class="contents">
<h1>frepple::utils::PythonType Class Reference</h1><!-- doxytag: class="frepple::utils::PythonType" --><!-- doxytag: inherits="frepple::utils::NonCopyable" -->
<p>This class is a thin wrapper around the type information in Python.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00252_source.html">utils.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for frepple::utils::PythonType:</div>
<div class="dynsection">
<div class="center"><img src="a00623.png" border="0" usemap="#frepple_1_1utils_1_1_python_type_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1utils_1_1_python_type_inherit__map" id="frepple_1_1utils_1_1_python_type_inherit__map">
<area shape="rect" id="node2" href="a00119.html" title="Class NonCopyable is a base class. Derive your own class from it when you want to..." alt="" coords="5,6,181,34"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="a00624.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef PyObject *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a769bc603e7c733e9d796987d55a01e81">createfunc</a> )(PyTypeObject *, PyObject *, PyObject *)</td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a7fc4c71d906fb7627b8c3e2a10e9f8dc">addMethod</a> (const char *, PyCFunctionWithKeywords, int, const char *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#ab5950f891179f3ae7d31f4977580cb1d">addMethod</a> (const char *, PyCFunction, int, const char *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a37248791bb6882072dd5ed2005ff2543">operator==</a> (const type_info &amp;i) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a18377fa75b6cfd097a017b01e6f87d8f">operator==</a> (const <a class="el" href="a00155.html">PythonType</a> &amp;i) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a310a3ff0e845a0c555d579f29342843f">PythonType</a> (size_t, const type_info *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a583846cf8dc2a5c91f5ebb9941039ae5">setBase</a> (PyTypeObject *b)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#aaafe003660694b2cf497a89815d7fe49">setDoc</a> (const string n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#af9217b67c7c60e8e87c703066d6970d5">setName</a> (const string n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a38d5ff23d85156a4b765b2930fcd622b">supportcall</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#ae96d28a03dbcf0e2b51100d8d2e6d621">supportcompare</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a001dc53b2dd832c001aee4d21bc7bf09">supportcreate</a> (<a class="el" href="a00155.html#a769bc603e7c733e9d796987d55a01e81">createfunc</a> c)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#ae1c4cfcecdae829479655653a49949f1">supportdealloc</a> (void(*f)(PyObject *))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a8d3f24e0357f41ac3bc0be78bd2ab268">supportgetattro</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a5bacf8ad021ab55b1056440880cf8760">supportiter</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a83866bef191c69cf8506426fe38b8d19">supportsetattro</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a23a670ed39c26ab20ec400cbe3618e6c">supportstr</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PyTypeObject *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#aed0915f1cc32c0c1e12e209abfedf615">type_object</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a5b2be5d75982b077b2d694c269d43778">typeReady</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#abf914311a885c679e6985f6fc1771c0a">evalException</a> ()</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const type_info *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a5d287a2865a5404e2c24c971e716d910">cppClass</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class is a thin wrapper around the type information in Python. </p>
<p>This class defines a number of convenience functions to interact with the PyTypeObject struct of the Python C API. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01003">1003</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a769bc603e7c733e9d796987d55a01e81"></a><!-- doxytag: member="frepple::utils::PythonType::createfunc" ref="a769bc603e7c733e9d796987d55a01e81" args=")(PyTypeObject *, PyObject *, PyObject *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef PyObject*(* <a class="el" href="a00155.html#a769bc603e7c733e9d796987d55a01e81">frepple::utils::PythonType::createfunc</a>)(PyTypeObject *, PyObject *, PyObject *)</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Type definition for create functions. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01118">1118</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a310a3ff0e845a0c555d579f29342843f"></a><!-- doxytag: member="frepple::utils::PythonType::PythonType" ref="a310a3ff0e845a0c555d579f29342843f" args="(size_t, const type_info *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::utils::PythonType::PythonType </td>
          <td>(</td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>base_size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const type_info *&nbsp;</td>
          <td class="paramname"> <em>tp</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor, sets the tp_base_size member. </p>

<p>Definition at line <a class="el" href="a00233_source.html#l00436">436</a> of file <a class="el" href="a00233_source.html">pythonutils.cpp</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7fc4c71d906fb7627b8c3e2a10e9f8dc"></a><!-- doxytag: member="frepple::utils::PythonType::addMethod" ref="a7fc4c71d906fb7627b8c3e2a10e9f8dc" args="(const char *, PyCFunctionWithKeywords, int, const char *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::utils::PythonType::addMethod </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>c</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PyCFunctionWithKeywords&nbsp;</td>
          <td class="paramname"> <em>f</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>i</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>d</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Add a new method. </p>

<p>Definition at line <a class="el" href="a00233_source.html#l00541">541</a> of file <a class="el" href="a00233_source.html">pythonutils.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ab5950f891179f3ae7d31f4977580cb1d"></a><!-- doxytag: member="frepple::utils::PythonType::addMethod" ref="ab5950f891179f3ae7d31f4977580cb1d" args="(const char *, PyCFunction, int, const char *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::utils::PythonType::addMethod </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>method_name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PyCFunction&nbsp;</td>
          <td class="paramname"> <em>f</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>flags</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>doc</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Add a new method. </p>

<p>Definition at line <a class="el" href="a00233_source.html#l00503">503</a> of file <a class="el" href="a00233_source.html">pythonutils.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="abf914311a885c679e6985f6fc1771c0a"></a><!-- doxytag: member="frepple::utils::PythonType::evalException" ref="abf914311a885c679e6985f6fc1771c0a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::utils::PythonType::evalException </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>A static function that evaluates an exception and sets the Python error string properly.<br/>
 This function should only be called from within a catch-block, since internally it rethrows the exception! </p>

<p>Definition at line <a class="el" href="a00233_source.html#l00561">561</a> of file <a class="el" href="a00233_source.html">pythonutils.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a37248791bb6882072dd5ed2005ff2543"></a><!-- doxytag: member="frepple::utils::PythonType::operator==" ref="a37248791bb6882072dd5ed2005ff2543" args="(const type_info &amp;i) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::utils::PythonType::operator== </td>
          <td>(</td>
          <td class="paramtype">const type_info &amp;&nbsp;</td>
          <td class="paramname"> <em>i</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Comparison operator. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01133">1133</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a18377fa75b6cfd097a017b01e6f87d8f"></a><!-- doxytag: member="frepple::utils::PythonType::operator==" ref="a18377fa75b6cfd097a017b01e6f87d8f" args="(const PythonType &amp;i) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::utils::PythonType::operator== </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00155.html">PythonType</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>i</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Comparison operator. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01127">1127</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a583846cf8dc2a5c91f5ebb9941039ae5"></a><!-- doxytag: member="frepple::utils::PythonType::setBase" ref="a583846cf8dc2a5c91f5ebb9941039ae5" args="(PyTypeObject *b)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::utils::PythonType::setBase </td>
          <td>(</td>
          <td class="paramtype">PyTypeObject *&nbsp;</td>
          <td class="paramname"> <em>b</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Updates tp_base. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01055">1055</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="aaafe003660694b2cf497a89815d7fe49"></a><!-- doxytag: member="frepple::utils::PythonType::setDoc" ref="aaafe003660694b2cf497a89815d7fe49" args="(const string n)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::utils::PythonType::setDoc </td>
          <td>(</td>
          <td class="paramtype">const string&nbsp;</td>
          <td class="paramname"> <em>n</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Updates tp_doc. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01048">1048</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="af9217b67c7c60e8e87c703066d6970d5"></a><!-- doxytag: member="frepple::utils::PythonType::setName" ref="af9217b67c7c60e8e87c703066d6970d5" args="(const string n)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::utils::PythonType::setName </td>
          <td>(</td>
          <td class="paramtype">const string&nbsp;</td>
          <td class="paramname"> <em>n</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Updates tp_name. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01041">1041</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a38d5ff23d85156a4b765b2930fcd622b"></a><!-- doxytag: member="frepple::utils::PythonType::supportcall" ref="a38d5ff23d85156a4b765b2930fcd622b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::utils::PythonType::supportcall </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Updates tp_call.<br/>
 The extension class will need to define a member function with this prototype:<br/>
 PyObject* call(const PythonObject&amp; args, const PythonObject&amp; kwds) </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01106">1106</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="ae96d28a03dbcf0e2b51100d8d2e6d621"></a><!-- doxytag: member="frepple::utils::PythonType::supportcompare" ref="ae96d28a03dbcf0e2b51100d8d2e6d621" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::utils::PythonType::supportcompare </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Updates tp_compare.<br/>
 The extension class will need to define a member function with this prototype:<br/>
 int compare(const PyObject* other) const </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01087">1087</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a001dc53b2dd832c001aee4d21bc7bf09"></a><!-- doxytag: member="frepple::utils::PythonType::supportcreate" ref="a001dc53b2dd832c001aee4d21bc7bf09" args="(createfunc c)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::utils::PythonType::supportcreate </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00155.html#a769bc603e7c733e9d796987d55a01e81">createfunc</a>&nbsp;</td>
          <td class="paramname"> <em>c</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Updates tp_new with the function passed as argument. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01121">1121</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="ae1c4cfcecdae829479655653a49949f1"></a><!-- doxytag: member="frepple::utils::PythonType::supportdealloc" ref="ae1c4cfcecdae829479655653a49949f1" args="(void(*f)(PyObject *))" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::utils::PythonType::supportdealloc </td>
          <td>(</td>
          <td class="paramtype">void(*)(PyObject *)&nbsp;</td>
          <td class="paramname"> <em>f</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Updates the deallocator. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01061">1061</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a8d3f24e0357f41ac3bc0be78bd2ab268"></a><!-- doxytag: member="frepple::utils::PythonType::supportgetattro" ref="a8d3f24e0357f41ac3bc0be78bd2ab268" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::utils::PythonType::supportgetattro </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Updates tp_getattro.<br/>
 The extension class will need to define a member function with this prototype:<br/>
 <a class="el" href="a00154.html" title="This class handles two-way translation between the data types in C++ and Python.">PythonObject</a> getattro(const XMLElement&amp; name) </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01071">1071</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a5bacf8ad021ab55b1056440880cf8760"></a><!-- doxytag: member="frepple::utils::PythonType::supportiter" ref="a5bacf8ad021ab55b1056440880cf8760" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::utils::PythonType::supportiter </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Updates tp_iter and tp_iternext.<br/>
 The extension class will need to define a member function with this prototype:<br/>
 PyObject* iternext() </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01095">1095</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a83866bef191c69cf8506426fe38b8d19"></a><!-- doxytag: member="frepple::utils::PythonType::supportsetattro" ref="a83866bef191c69cf8506426fe38b8d19" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::utils::PythonType::supportsetattro </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Updates tp_setattro.<br/>
 The extension class will need to define a member function with this prototype:<br/>
 int setattro(const Attribute&amp; attr, const PythonObject&amp; field) </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01079">1079</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a23a670ed39c26ab20ec400cbe3618e6c"></a><!-- doxytag: member="frepple::utils::PythonType::supportstr" ref="a23a670ed39c26ab20ec400cbe3618e6c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::utils::PythonType::supportstr </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Updates tp_str.<br/>
 The extension class will need to define a member function with this prototype:<br/>
 PyObject* str() </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01114">1114</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="aed0915f1cc32c0c1e12e209abfedf615"></a><!-- doxytag: member="frepple::utils::PythonType::type_object" ref="aed0915f1cc32c0c1e12e209abfedf615" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PyTypeObject* frepple::utils::PythonType::type_object </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return a pointer to the actual Python PyTypeObject. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01032">1032</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a5b2be5d75982b077b2d694c269d43778"></a><!-- doxytag: member="frepple::utils::PythonType::typeReady" ref="a5b2be5d75982b077b2d694c269d43778" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int frepple::utils::PythonType::typeReady </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>This method needs to be called after the type information has all been updated. It adds the type to the <a class="el" href="a00256.html" title="Core namespace.">frepple</a> module. </p>

<p>Definition at line <a class="el" href="a00233_source.html#l00547">547</a> of file <a class="el" href="a00233_source.html">pythonutils.cpp</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a5d287a2865a5404e2c24c971e716d910"></a><!-- doxytag: member="frepple::utils::PythonType::cppClass" ref="a5d287a2865a5404e2c24c971e716d910" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const type_info* <a class="el" href="a00155.html#a5d287a2865a5404e2c24c971e716d910">frepple::utils::PythonType::cppClass</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Type info of the registering class. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01139">1139</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&nbsp;
<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>