<!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::Problem::List 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="a00134.html">Problem</a>::<a class="el" href="a00100.html">List</a> </div> </div> <div class="contents"> <h1>frepple::Problem::List Class Reference</h1><!-- doxytag: class="frepple::Problem::List" --> <p>This auxilary class is used to maintain a list of problem models. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="a00218_source.html">model.h</a>></code></p> <p><a href="a00486.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="a00039.html">Problem::const_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00100.html#a37816a7d0734ba6022676b187893bb9a">begin</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00100.html#a620fa94f33970c5b337dd0e2365e9ab6">clear</a> (<a class="el" href="a00134.html">Problem</a> *=NULL)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00100.html#a6dee7bba1d823f9a3bb7a0e68a8fcc9b">empty</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00039.html">Problem::const_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00100.html#ac6f657fbb920f53a3cda1d401ec2e364">end</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00100.html#ae97452c70fa50fb1a075e70c7665f693">List</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00100.html#ad00f9532f9f1aa1f744e7ac6ceccdfac">pop</a> (<a class="el" href="a00134.html">Problem</a> *)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00134.html">Problem</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00100.html#add9d396135451bf2efef6527cea7839a">push</a> (const <a class="el" href="a00115.html">MetaClass</a> *, const <a class="el" href="a00120.html">Object</a> *, <a class="el" href="a00049.html">Date</a>, <a class="el" href="a00049.html">Date</a>, double)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00134.html">Problem</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00100.html#a0391e63b3596b7820946776182f7bd7f">top</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00134.html">Problem</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00100.html#adef6b9db7efa29b9fefe26b0d4101919">unlink</a> (<a class="el" href="a00134.html">Problem</a> *p)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00100.html#ad4da9a81136367754e0d2f02bd269a2a">~List</a> ()</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>This auxilary class is used to maintain a list of problem models. </p> <p>Definition at line <a class="el" href="a00218_source.html#l01057">1057</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ae97452c70fa50fb1a075e70c7665f693"></a><!-- doxytag: member="frepple::Problem::List::List" ref="ae97452c70fa50fb1a075e70c7665f693" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">frepple::Problem::List::List </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor. </p> <p>Definition at line <a class="el" href="a00218_source.html#l01061">1061</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p> </div> </div> <a class="anchor" id="ad4da9a81136367754e0d2f02bd269a2a"></a><!-- doxytag: member="frepple::Problem::List::~List" ref="ad4da9a81136367754e0d2f02bd269a2a" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">frepple::Problem::List::~List </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="a00218_source.html#l01064">1064</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a37816a7d0734ba6022676b187893bb9a"></a><!-- doxytag: member="frepple::Problem::List::begin" ref="a37816a7d0734ba6022676b187893bb9a" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00039.html">Problem::const_iterator</a> frepple::Problem::List::begin </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Return an iterator to the start of the list.</p> <p>Retrieve an iterator for the list. </p> <p>Definition at line <a class="el" href="a00218_source.html#l05712">5712</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p> </div> </div> <a class="anchor" id="a620fa94f33970c5b337dd0e2365e9ab6"></a><!-- doxytag: member="frepple::Problem::List::clear" ref="a620fa94f33970c5b337dd0e2365e9ab6" args="(Problem *=NULL)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void frepple::Problem::List::clear </td> <td>(</td> <td class="paramtype"><a class="el" href="a00134.html">Problem</a> * </td> <td class="paramname"> <em>c</em> = <code>NULL</code></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Empty the list.<br/> If a problem is passed as argument, that problem and all problems following it in the lsit are deleted.<br/> If no argument is passed, the complete list is erased. </p> <p>Definition at line <a class="el" href="a00227_source.html#l00556">556</a> of file <a class="el" href="a00227_source.html">problem.cpp</a>.</p> </div> </div> <a class="anchor" id="a6dee7bba1d823f9a3bb7a0e68a8fcc9b"></a><!-- doxytag: member="frepple::Problem::List::empty" ref="a6dee7bba1d823f9a3bb7a0e68a8fcc9b" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool frepple::Problem::List::empty </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns true if the list is empty. </p> <p>Definition at line <a class="el" href="a00218_source.html#l01093">1093</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p> </div> </div> <a class="anchor" id="ac6f657fbb920f53a3cda1d401ec2e364"></a><!-- doxytag: member="frepple::Problem::List::end" ref="ac6f657fbb920f53a3cda1d401ec2e364" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00039.html">Problem::const_iterator</a> frepple::Problem::List::end </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>End iterator.</p> <p>Stop iterator. </p> <p>Definition at line <a class="el" href="a00218_source.html#l05717">5717</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p> </div> </div> <a class="anchor" id="ad00f9532f9f1aa1f744e7ac6ceccdfac"></a><!-- doxytag: member="frepple::Problem::List::pop" ref="ad00f9532f9f1aa1f744e7ac6ceccdfac" args="(Problem *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void frepple::Problem::List::pop </td> <td>(</td> <td class="paramtype"><a class="el" href="a00134.html">Problem</a> * </td> <td class="paramname"> <em>p</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Remove all problems from the list that appear AFTER the one passed as argument. </p> <p>Definition at line <a class="el" href="a00227_source.html#l00616">616</a> of file <a class="el" href="a00227_source.html">problem.cpp</a>.</p> </div> </div> <a class="anchor" id="add9d396135451bf2efef6527cea7839a"></a><!-- doxytag: member="frepple::Problem::List::push" ref="add9d396135451bf2efef6527cea7839a" args="(const MetaClass *, const Object *, Date, Date, double)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00134.html">Problem</a> * frepple::Problem::List::push </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00115.html">MetaClass</a> * </td> <td class="paramname"> <em>m</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="a00120.html">Object</a> * </td> <td class="paramname"> <em>o</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00049.html">Date</a> </td> <td class="paramname"> <em>st</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00049.html">Date</a> </td> <td class="paramname"> <em>nd</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"> <em>w</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Add a problem to the list. </p> <p>Definition at line <a class="el" href="a00227_source.html#l00583">583</a> of file <a class="el" href="a00227_source.html">problem.cpp</a>.</p> </div> </div> <a class="anchor" id="a0391e63b3596b7820946776182f7bd7f"></a><!-- doxytag: member="frepple::Problem::List::top" ref="a0391e63b3596b7820946776182f7bd7f" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00134.html">Problem</a> * frepple::Problem::List::top </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Get the last problem on the list. </p> <p>Definition at line <a class="el" href="a00227_source.html#l00643">643</a> of file <a class="el" href="a00227_source.html">problem.cpp</a>.</p> </div> </div> <a class="anchor" id="adef6b9db7efa29b9fefe26b0d4101919"></a><!-- doxytag: member="frepple::Problem::List::unlink" ref="adef6b9db7efa29b9fefe26b0d4101919" args="(Problem *p)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00134.html">Problem</a>* frepple::Problem::List::unlink </td> <td>(</td> <td class="paramtype"><a class="el" href="a00134.html">Problem</a> * </td> <td class="paramname"> <em>p</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Cur the list in two parts . </p> <p>Definition at line <a class="el" href="a00218_source.html#l01085">1085</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="a00227_source.html">problem.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>