<!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::CommandSavePlan 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="a00037.html">CommandSavePlan</a>
</div>
</div>
<div class="contents">
<h1>frepple::CommandSavePlan Class Reference</h1><!-- doxytag: class="frepple::CommandSavePlan" --><!-- doxytag: inherits="frepple::utils::Command" -->
<p>This command writes the dynamic part of the plan to an text file.
<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::CommandSavePlan:</div>
<div class="dynsection">
<div class="center"><img src="a00400.png" border="0" usemap="#frepple_1_1_command_save_plan_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_command_save_plan_inherit__map" id="frepple_1_1_command_save_plan_inherit__map">
<area shape="rect" id="node2" href="a00025.html" title="Abstract base class for all commands." alt="" coords="16,6,173,34"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00401.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="a00037.html#a6789702f043c0defe3bcbdbca9847609">CommandSavePlan</a> (const string &v="plan.out")</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#a022fdd40b637558fcbb7ce89781a7dfe">execute</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#a62e986b830c994c651ede1570ea589ed">getFileName</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00037.html#a81e96afc7264a6c018c65e92c3dd6e58">setFileName</a> (const string &v)</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="a00037.html#ae94f793824fcdfd970965e19b89af69c">executePython</a> (PyObject *, PyObject *)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This command writes the dynamic part of the plan to an text file. </p>
<p>This saved information covers the buffer flowplans, operationplans, resource loading, demand, problems, etc...<br/>
The main use of this function is in the test suite: a simple text file comparison allows us to identify changes quickly. The output format is only to be seen in this context of testing, and is not intended to be used as an official method for publishing plans to other systems.<br/>
The data file is written by the <a class="el" href="a00037.html#a022fdd40b637558fcbb7ce89781a7dfe">execute()</a> function. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00036.html" title="This command writes the complete model to an XML-file.">CommandSave</a> </dd></dl>
<p>Definition at line <a class="el" href="a00218_source.html#l04496">4496</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a6789702f043c0defe3bcbdbca9847609"></a><!-- doxytag: member="frepple::CommandSavePlan::CommandSavePlan" ref="a6789702f043c0defe3bcbdbca9847609" args="(const string &v="plan.out")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::CommandSavePlan::CommandSavePlan </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>v</em> = <code>"plan.out"</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#l04499">4499</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="a022fdd40b637558fcbb7ce89781a7dfe"></a><!-- doxytag: member="frepple::CommandSavePlan::execute" ref="a022fdd40b637558fcbb7ce89781a7dfe" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::CommandSavePlan::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#l00209">209</a> of file <a class="el" href="a00192_source.html">model/actions.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae94f793824fcdfd970965e19b89af69c"></a><!-- doxytag: member="frepple::CommandSavePlan::executePython" ref="ae94f793824fcdfd970965e19b89af69c" args="(PyObject *, PyObject *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PyObject * frepple::CommandSavePlan::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#l00337">337</a> of file <a class="el" href="a00192_source.html">model/actions.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a62e986b830c994c651ede1570ea589ed"></a><!-- doxytag: member="frepple::CommandSavePlan::getFileName" ref="a62e986b830c994c651ede1570ea589ed" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string frepple::CommandSavePlan::getFileName </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#l04500">4500</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a81e96afc7264a6c018c65e92c3dd6e58"></a><!-- doxytag: member="frepple::CommandSavePlan::setFileName" ref="a81e96afc7264a6c018c65e92c3dd6e58" args="(const string &v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::CommandSavePlan::setFileName </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>v</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#l04501">4501</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>
