<!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::Customer 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="a00044.html">Customer</a> </div> </div> <div class="contents"> <h1>frepple::Customer Class Reference</h1><!-- doxytag: class="frepple::Customer" --><!-- doxytag: inherits="HasHierarchy< Customer >,frepple::utils::HasDescription" --> <p>This abstracts class represents customers. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="a00218_source.html">model.h</a>></code></p> <div class="dynheader"> Inheritance diagram for frepple::Customer:</div> <div class="dynsection"> <div class="center"><img src="a00402.png" border="0" usemap="#frepple_1_1_customer_inherit__map" alt="Inheritance graph"/></div> <map name="frepple_1_1_customer_inherit__map" id="frepple_1_1_customer_inherit__map"> <area shape="rect" id="node17" href="a00045.html" title="This class implements the abstract Customer class." alt="" coords="340,393,503,421"/> <area shape="rect" id="node2" href="a00083.html" title="frepple::utils::HasHierarchy\< Customer \>" alt="" coords="171,238,427,266"/> <area shape="rect" id="node4" href="a00085.html" title="frepple::utils::HasName\< Customer \>" alt="" coords="181,161,416,189"/> <area shape="rect" id="node6" href="a00119.html" title="Class NonCopyable is a base class. Derive your own class from it when you want to..." alt="" coords="5,83,181,111"/> <area shape="rect" id="node8" href="a00182.html" title="This class represents a node in the tree." alt="" coords="205,83,392,111"/> <area shape="rect" id="node10" href="a00120.html" title="Object is the abstract base class for the main entities." alt="" coords="416,83,552,111"/> <area shape="rect" id="node12" href="a00151.html" title="This is a base class for all Python extension types." alt="" coords="371,6,597,34"/> <area shape="rect" id="node14" href="a00082.html" title="This is a decorator class for the main objects." alt="" coords="451,238,637,266"/> </map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="a00403.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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#abbd151a27329d6ae49946628c62c4c02">beginElement</a> (<a class="el" href="a00186.html">XMLInput</a> &, const <a class="el" href="a00002.html">Attribute</a> &)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a459adf7961b477d66b7b73d6a727c530">Customer</a> (const string &n)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ad1392742a456d7eb2c9ca9e393cbfe5e">endElement</a> (<a class="el" href="a00186.html">XMLInput</a> &, const <a class="el" href="a00002.html">Attribute</a> &, const <a class="el" href="a00047.html">DataElement</a> &)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#aa79b4a38eb4d82c5b8f4307369bf26d9">extrasize</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual PyObject * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a047a380178082731d71876cd40051ff8">getattro</a> (const <a class="el" href="a00002.html">Attribute</a> &)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="a00115.html">MetaClass</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a95fc8ebff90e4593512dc4bef14b1877">getType</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a8157599f29ca0b90287dae1b194e0ab9">setattro</a> (const <a class="el" href="a00002.html">Attribute</a> &, const <a class="el" href="a00154.html">PythonObject</a> &)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a965897378d171498bdc39f897857dede">writeElement</a> (<a class="el" href="a00189.html">XMLOutput</a> *, const <a class="el" href="a00096.html">Keyword</a> &, <a class="el" href="a00257.html#a20c2c7e4c6b668e71c154ae3eb18f398">mode</a>=DEFAULT) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ae4e36077a909c1466c6ccba230553f3d">~Customer</a> ()</td></tr> <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a448a0c8ebde44ae037bf6903800f4652">initialize</a> ()</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="a00114.html">MetaCategory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a8b7bb9faf02f19d16c8c4cc9468ed2c4">metadata</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>This abstracts class represents customers. </p> <p>Demands can be associated with a customer, but there is no planning behavior directly linked to customers. </p> <p>Definition at line <a class="el" href="a00218_source.html#l01459">1459</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a459adf7961b477d66b7b73d6a727c530"></a><!-- doxytag: member="frepple::Customer::Customer" ref="a459adf7961b477d66b7b73d6a727c530" args="(const string &n)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">frepple::Customer::Customer </td> <td>(</td> <td class="paramtype">const string & </td> <td class="paramname"> <em>n</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="a00218_source.html#l01469">1469</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p> </div> </div> <a class="anchor" id="ae4e36077a909c1466c6ccba230553f3d"></a><!-- doxytag: member="frepple::Customer::~Customer" ref="ae4e36077a909c1466c6ccba230553f3d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">frepple::Customer::~Customer </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="a00197_source.html#l00094">94</a> of file <a class="el" href="a00197_source.html">customer.cpp</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="abbd151a27329d6ae49946628c62c4c02"></a><!-- doxytag: member="frepple::Customer::beginElement" ref="abbd151a27329d6ae49946628c62c4c02" args="(XMLInput &, const Attribute &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void frepple::Customer::beginElement </td> <td>(</td> <td class="paramtype"><a class="el" href="a00186.html">XMLInput</a> & </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="a00002.html">Attribute</a> & </td> <td class="paramname"></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Called while restoring the model from an XML-file.<br/> This is called for each element within the "this" element, for which the "this" element is immediate parent.<br/> It is called when the open element tag is encountered. </p> <p>Reimplemented from <a class="el" href="a00083.html#a41b02672884e4e1dcb08d64a46ad968d">frepple::utils::HasHierarchy< Customer ></a>.</p> <p>Definition at line <a class="el" href="a00197_source.html#l00081">81</a> of file <a class="el" href="a00197_source.html">customer.cpp</a>.</p> </div> </div> <a class="anchor" id="ad1392742a456d7eb2c9ca9e393cbfe5e"></a><!-- doxytag: member="frepple::Customer::endElement" ref="ad1392742a456d7eb2c9ca9e393cbfe5e" args="(XMLInput &, const Attribute &, const DataElement &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void frepple::Customer::endElement </td> <td>(</td> <td class="paramtype"><a class="el" href="a00186.html">XMLInput</a> & </td> <td class="paramname"> <em>pIn</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="a00002.html">Attribute</a> & </td> <td class="paramname"> <em>pAttr</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="a00047.html">DataElement</a> & </td> <td class="paramname"> <em>pElement</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Reimplemented from <a class="el" href="a00082.html#ad6c2b65721b36431bcbb8d6e218fde7c">frepple::utils::HasDescription</a>.</p> <p>Definition at line <a class="el" href="a00197_source.html#l00087">87</a> of file <a class="el" href="a00197_source.html">customer.cpp</a>.</p> </div> </div> <a class="anchor" id="aa79b4a38eb4d82c5b8f4307369bf26d9"></a><!-- doxytag: member="frepple::Customer::extrasize" ref="aa79b4a38eb4d82c5b8f4307369bf26d9" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">size_t frepple::Customer::extrasize </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the memory size in bytes. </p> <p>Reimplemented from <a class="el" href="a00082.html#a3cfae26eb004dfe977271fdedacbb5e3">frepple::utils::HasDescription</a>.</p> <p>Definition at line <a class="el" href="a00218_source.html#l01467">1467</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p> </div> </div> <a class="anchor" id="a047a380178082731d71876cd40051ff8"></a><!-- doxytag: member="frepple::Customer::getattro" ref="a047a380178082731d71876cd40051ff8" args="(const Attribute &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">PyObject * frepple::Customer::getattro </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00002.html">Attribute</a> & </td> <td class="paramname"> <em>attr</em></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Default getattro method. <br/> Subclasses are expected to implement an override if the type supports gettattro. </p> <p>Reimplemented from <a class="el" href="a00151.html#af3cfc29003472070ba9e133bcf5eb335">frepple::utils::PythonExtensionBase</a>.</p> <p>Definition at line <a class="el" href="a00197_source.html#l00102">102</a> of file <a class="el" href="a00197_source.html">customer.cpp</a>.</p> </div> </div> <a class="anchor" id="a95fc8ebff90e4593512dc4bef14b1877"></a><!-- doxytag: member="frepple::Customer::getType" ref="a95fc8ebff90e4593512dc4bef14b1877" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const <a class="el" href="a00115.html">MetaClass</a>& frepple::Customer::getType </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>This returns the type information on the object, a bit similar to the standard type_info information. </p> <p>Implements <a class="el" href="a00120.html#a2e5ff5e5d9c32647f692abd04a0d72d2">frepple::utils::Object</a>.</p> <p>Reimplemented in <a class="el" href="a00045.html#a01d1c5a716d71ca5d90340bbacafeffb">frepple::CustomerDefault</a>.</p> <p>Definition at line <a class="el" href="a00218_source.html#l01471">1471</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p> </div> </div> <a class="anchor" id="a448a0c8ebde44ae037bf6903800f4652"></a><!-- doxytag: member="frepple::Customer::initialize" ref="a448a0c8ebde44ae037bf6903800f4652" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int frepple::Customer::initialize </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Reimplemented in <a class="el" href="a00045.html#af76bea520c7b3e594cbfeb790e759be6">frepple::CustomerDefault</a>.</p> <p>Definition at line <a class="el" href="a00197_source.html#l00039">39</a> of file <a class="el" href="a00197_source.html">customer.cpp</a>.</p> </div> </div> <a class="anchor" id="a8157599f29ca0b90287dae1b194e0ab9"></a><!-- doxytag: member="frepple::Customer::setattro" ref="a8157599f29ca0b90287dae1b194e0ab9" args="(const Attribute &, const PythonObject &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int frepple::Customer::setattro </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00002.html">Attribute</a> & </td> <td class="paramname"> <em>attr</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="a00154.html">PythonObject</a> & </td> <td class="paramname"> <em>field</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Default setattro method. <br/> Subclasses are expected to implement an override if the type supports settattro. </p> <p>Reimplemented from <a class="el" href="a00151.html#a0a1bd051198a1b82fd23d3ca04c3ee8d">frepple::utils::PythonExtensionBase</a>.</p> <p>Definition at line <a class="el" href="a00197_source.html#l00120">120</a> of file <a class="el" href="a00197_source.html">customer.cpp</a>.</p> </div> </div> <a class="anchor" id="a965897378d171498bdc39f897857dede"></a><!-- doxytag: member="frepple::Customer::writeElement" ref="a965897378d171498bdc39f897857dede" args="(XMLOutput *, const Keyword &, mode=DEFAULT) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void frepple::Customer::writeElement </td> <td>(</td> <td class="paramtype"><a class="el" href="a00189.html">XMLOutput</a> * </td> <td class="paramname"> <em>o</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="a00096.html">Keyword</a> & </td> <td class="paramname"> <em>tag</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00257.html#a20c2c7e4c6b668e71c154ae3eb18f398">mode</a> </td> <td class="paramname"> <em>m</em> = <code>DEFAULT</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Reimplemented from <a class="el" href="a00082.html#aff43518d92c1ac8298ce3df9ad4c9fbb">frepple::utils::HasDescription</a>.</p> <p>Definition at line <a class="el" href="a00197_source.html#l00062">62</a> of file <a class="el" href="a00197_source.html">customer.cpp</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a8b7bb9faf02f19d16c8c4cc9468ed2c4"></a><!-- doxytag: member="frepple::Customer::metadata" ref="a8b7bb9faf02f19d16c8c4cc9468ed2c4" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="a00114.html">MetaCategory</a> * <a class="el" href="a00044.html#a8b7bb9faf02f19d16c8c4cc9468ed2c4">frepple::Customer::metadata</a><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Reimplemented in <a class="el" href="a00045.html#aefbad57013da95dc1ea85c895a0df6c2">frepple::CustomerDefault</a>.</p> <p>Definition at line <a class="el" href="a00218_source.html#l01472">1472</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="a00218_source.html">model.h</a></li> <li><a class="el" href="a00197_source.html">customer.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>