<!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::PythonExtension< T > Class Template 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="a00150.html">PythonExtension</a>
</div>
</div>
<div class="contents">
<h1>frepple::utils::PythonExtension< T > Class Template Reference</h1><!-- doxytag: class="frepple::utils::PythonExtension" --><!-- doxytag: inherits="frepple::utils::PythonExtensionBase,frepple::utils::NonCopyable" -->
<p>Template class to define Python extensions.
<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::PythonExtension< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00614.png" border="0" usemap="#frepple_1_1utils_1_1_python_extension_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1utils_1_1_python_extension_3_01_t_01_4_inherit__map" id="frepple_1_1utils_1_1_python_extension_3_01_t_01_4_inherit__map">
<area shape="rect" id="node2" href="a00151.html" title="This is a base class for all Python extension types." alt="" coords="5,6,232,34"/>
<area shape="rect" id="node4" href="a00119.html" title="Class NonCopyable is a base class. Derive your own class from it when you want to..." alt="" coords="256,6,432,34"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00615.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="a00150.html#ae3947b589c0968f41986c1e1a43619d7">PythonExtension</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00150.html#a58058b1c22348d316cbd90e3de84c8a2">~PythonExtension</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="a00150.html#afcb4c16a923b495f12e05d82a40b9837">deallocator</a> (PyObject *o)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00155.html">PythonType</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00150.html#aec65c2cd811051918027ae6dc00fcfaf">getType</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T><br/>
class frepple::utils::PythonExtension< T ></h3>
<p>Template class to define Python extensions. </p>
<p>The template argument should be your extension class, inheriting from this template class: class MyClass : PythonExtension<MyClass></p>
<p>The structure of the C++ wrappers around the C Python API is heavily inspired on the design of PyCXX.<br/>
More information can be found on <a href="http://cxx.sourceforge.net">http://cxx.sourceforge.net</a> </p>
<p>Definition at line <a class="el" href="a00252_source.html#l03255">3255</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae3947b589c0968f41986c1e1a43619d7"></a><!-- doxytag: member="frepple::utils::PythonExtension::PythonExtension" ref="ae3947b589c0968f41986c1e1a43619d7" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00150.html">frepple::utils::PythonExtension</a>< T >::<a class="el" href="a00150.html">PythonExtension</a> </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l03259">3259</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a58058b1c22348d316cbd90e3de84c8a2"></a><!-- doxytag: member="frepple::utils::PythonExtension::~PythonExtension" ref="a58058b1c22348d316cbd90e3de84c8a2" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00150.html">frepple::utils::PythonExtension</a>< T >::~<a class="el" href="a00150.html">PythonExtension</a> </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#l03265">3265</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="afcb4c16a923b495f12e05d82a40b9837"></a><!-- doxytag: member="frepple::utils::PythonExtension::deallocator" ref="afcb4c16a923b495f12e05d82a40b9837" args="(PyObject *o)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="a00150.html">frepple::utils::PythonExtension</a>< T >::deallocator </td>
<td>(</td>
<td class="paramtype">PyObject * </td>
<td class="paramname"> <em>o</em></td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free the memory.<br/>
See the note on the memory management in the class documentation for <a class="el" href="a00151.html" title="This is a base class for all Python extension types.">PythonExtensionBase</a>. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l03286">3286</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="aec65c2cd811051918027ae6dc00fcfaf"></a><!-- doxytag: member="frepple::utils::PythonExtension::getType" ref="aec65c2cd811051918027ae6dc00fcfaf" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00155.html">PythonType</a>& <a class="el" href="a00150.html">frepple::utils::PythonExtension</a>< T >::getType </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method keeps the type information object for your extension. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l03268">3268</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 file:<ul>
<li><a class="el" href="a00252_source.html">utils.h</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>
