<!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::CommandErase 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="a00028.html">CommandErase</a>
</div>
</div>
<div class="contents">
<h1>frepple::CommandErase Class Reference</h1><!-- doxytag: class="frepple::CommandErase" --><!-- doxytag: inherits="frepple::utils::Command" -->
<p>This command deletes part of the model or the plan from memory.
<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::CommandErase:</div>
<div class="dynsection">
<div class="center"><img src="a00388.png" border="0" usemap="#frepple_1_1_command_erase_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_command_erase_inherit__map" id="frepple_1_1_command_erase_inherit__map">
<area shape="rect" id="node2" href="a00025.html" title="Abstract base class for all commands." alt="" coords="7,6,164,34"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00389.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="a00028.html#a54ecb1e1e40986dd30d9936fb791b570">CommandErase</a> (bool staticAlso=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#a9e23b520cc21ec96c78a801a14986f11">execute</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#aa433ee6cc44143ebbc35df3f37b3fb35">getDeleteStaticModel</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#a531a2ed508fd6887d6819d59aa98ca30">setDeleteStaticModel</a> (bool b)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static PyObject * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#ab28c6d6f3d9731c878e25069069f7b36">executePython</a> (PyObject *, PyObject *)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This command deletes part of the model or the plan from memory. </p>
<p>The class allows the following modes to control what to delete:</p>
<ul>
<li>plan:<br/>
Deletes the dynamic modelling constructs, such as operationplans, loadplans and flowplans only. Locked operationplans are not deleted.<br/>
The static model is left intact.<br/>
This is the default mode.</li>
<li>model:<br/>
The dynamic as well as the static objects are removed. You'll end up with a completely empty model. Due to the logic required in the object destructors this mode doesn't scale linear with the model size. </li>
</ul>
<p>Definition at line <a class="el" href="a00218_source.html#l04547">4547</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a54ecb1e1e40986dd30d9936fb791b570"></a><!-- doxytag: member="frepple::CommandErase::CommandErase" ref="a54ecb1e1e40986dd30d9936fb791b570" args="(bool staticAlso=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::CommandErase::CommandErase </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>staticAlso</em> = <code>false</code></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#l04550">4550</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="a9e23b520cc21ec96c78a801a14986f11"></a><!-- doxytag: member="frepple::CommandErase::execute" ref="a9e23b520cc21ec96c78a801a14986f11" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::CommandErase::execute </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is used to actually execute the action.<br/>
A couple of notes on how this method should be implemented by the subclasses:</p>
<ul>
<li>Calling the method multiple times is harmless and results in the same state change as calling it only once. </li>
</ul>
<p>Implements <a class="el" href="a00025.html#acc6f6bc4f9a9ce8cfa2de41fd12f3024">frepple::utils::Command</a>.</p>
<p>Definition at line <a class="el" href="a00192_source.html#l00497">497</a> of file <a class="el" href="a00192_source.html">model/actions.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab28c6d6f3d9731c878e25069069f7b36"></a><!-- doxytag: member="frepple::CommandErase::executePython" ref="ab28c6d6f3d9731c878e25069069f7b36" args="(PyObject *, PyObject *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PyObject * frepple::CommandErase::executePython </td>
<td>(</td>
<td class="paramtype">PyObject * </td>
<td class="paramname"> <em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PyObject * </td>
<td class="paramname"> <em>args</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Python interface to this command. </p>
<p>Definition at line <a class="el" href="a00192_source.html#l00541">541</a> of file <a class="el" href="a00192_source.html">model/actions.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa433ee6cc44143ebbc35df3f37b3fb35"></a><!-- doxytag: member="frepple::CommandErase::getDeleteStaticModel" ref="aa433ee6cc44143ebbc35df3f37b3fb35" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::CommandErase::getDeleteStaticModel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l04557">4557</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a531a2ed508fd6887d6819d59aa98ca30"></a><!-- doxytag: member="frepple::CommandErase::setDeleteStaticModel" ref="a531a2ed508fd6887d6819d59aa98ca30" args="(bool b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::CommandErase::setDeleteStaticModel </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>b</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#l04558">4558</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="a00192_source.html">model/actions.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>
