<!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::CommandSave 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="a00036.html">CommandSave</a>
</div>
</div>
<div class="contents">
<h1>frepple::CommandSave Class Reference</h1><!-- doxytag: class="frepple::CommandSave" --><!-- doxytag: inherits="frepple::utils::Command" -->
<p>This command writes the complete model to an XML-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::CommandSave:</div>
<div class="dynsection">
<div class="center"><img src="a00398.png" border="0" usemap="#frepple_1_1_command_save_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_command_save_inherit__map" id="frepple_1_1_command_save_inherit__map">
<area shape="rect" id="node2" href="a00025.html" title="Abstract base class for all commands." alt="" coords="5,6,163,34"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00399.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="a00036.html#a68b43c480df7ff42cc0f6bac3778135f">CommandSave</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="a00036.html#a1fd2e4735da8296f34555e2bb2598a3d">execute</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">XMLOutput::content_type </td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#a90cadadb1f9880b76fbf829a1a7888b8">getContent</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#a87fc8b6122a26d34894d4ff3e44722a5">getFileName</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#afe8aa5e582698d6fd1f8b8f7611ba0bc">getHeaderAtts</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#a2bc0931595a9c3f247d0ef2d72b5dc81">getHeaderStart</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#acfe5e4c3e4f11a26155d82865eb0d0bb">setContent</a> (XMLOutput::content_type t)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#a2b19c09a8218ace0000965410a31280a">setFileName</a> (const string &v)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#af41d24a0072770d23c6f937aac7bb4c3">setHeaderAtts</a> (const string &s)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#aea5f90dec680a6db85a1224a40ea9c26">setHeaderStart</a> (const string &s)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#a7e6621a0aed5e2885e1079f3e6384625">~CommandSave</a> ()</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="a00036.html#ab42b5fd2bc7357ec0c1aa9296de19fd5">executePython</a> (PyObject *, PyObject *)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This command writes the complete model to an XML-file. </p>
<p>Both the static model (i.e. items, locations, buffers, resources, calendars, etc...) and the dynamic data (i.e. the actual plan including the operationplans, demand, problems, etc...).<br/>
The format is such that the output file can be re-read to restore the very same model.<br/>
The data is written by the <a class="el" href="a00036.html#a1fd2e4735da8296f34555e2bb2598a3d">execute()</a> function. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00037.html" title="This command writes the dynamic part of the plan to an text file.">CommandSavePlan</a> </dd></dl>
<p>Definition at line <a class="el" href="a00218_source.html#l04426">4426</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a68b43c480df7ff42cc0f6bac3778135f"></a><!-- doxytag: member="frepple::CommandSave::CommandSave" ref="a68b43c480df7ff42cc0f6bac3778135f" args="(const string &v="plan.out")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::CommandSave::CommandSave </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>Constructor. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04430">4430</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7e6621a0aed5e2885e1079f3e6384625"></a><!-- doxytag: member="frepple::CommandSave::~CommandSave" ref="a7e6621a0aed5e2885e1079f3e6384625" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual frepple::CommandSave::~CommandSave </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="a00218_source.html#l04434">4434</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="a1fd2e4735da8296f34555e2bb2598a3d"></a><!-- doxytag: member="frepple::CommandSave::execute" ref="a1fd2e4735da8296f34555e2bb2598a3d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::CommandSave::execute </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute the command, ie write the data into XML format. </p>
<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#l00147">147</a> of file <a class="el" href="a00192_source.html">model/actions.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab42b5fd2bc7357ec0c1aa9296de19fd5"></a><!-- doxytag: member="frepple::CommandSave::executePython" ref="ab42b5fd2bc7357ec0c1aa9296de19fd5" args="(PyObject *, PyObject *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PyObject * frepple::CommandSave::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#l00169">169</a> of file <a class="el" href="a00192_source.html">model/actions.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a90cadadb1f9880b76fbf829a1a7888b8"></a><!-- doxytag: member="frepple::CommandSave::getContent" ref="a90cadadb1f9880b76fbf829a1a7888b8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XMLOutput::content_type frepple::CommandSave::getContent </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the type of output. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04449">4449</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a87fc8b6122a26d34894d4ff3e44722a5"></a><!-- doxytag: member="frepple::CommandSave::getFileName" ref="a87fc8b6122a26d34894d4ff3e44722a5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string frepple::CommandSave::getFileName </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the name of the output file. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04437">4437</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="afe8aa5e582698d6fd1f8b8f7611ba0bc"></a><!-- doxytag: member="frepple::CommandSave::getHeaderAtts" ref="afe8aa5e582698d6fd1f8b8f7611ba0bc" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string frepple::CommandSave::getHeaderAtts </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the attributes that are written for the root element of each XML document. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04475">4475</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2bc0931595a9c3f247d0ef2d72b5dc81"></a><!-- doxytag: member="frepple::CommandSave::getHeaderStart" ref="a2bc0931595a9c3f247d0ef2d72b5dc81" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string frepple::CommandSave::getHeaderStart </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the string that is printed as the first line of each XML document. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04465">4465</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="acfe5e4c3e4f11a26155d82865eb0d0bb"></a><!-- doxytag: member="frepple::CommandSave::setContent" ref="acfe5e4c3e4f11a26155d82865eb0d0bb" args="(XMLOutput::content_type t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::CommandSave::setContent </td>
<td>(</td>
<td class="paramtype">XMLOutput::content_type </td>
<td class="paramname"> <em>t</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the type of output. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>XMLOutput::content_type </dd></dl>
<p>Definition at line <a class="el" href="a00218_source.html#l04454">4454</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2b19c09a8218ace0000965410a31280a"></a><!-- doxytag: member="frepple::CommandSave::setFileName" ref="a2b19c09a8218ace0000965410a31280a" args="(const string &v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::CommandSave::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>Update the name of the output file. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04440">4440</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="af41d24a0072770d23c6f937aac7bb4c3"></a><!-- doxytag: member="frepple::CommandSave::setHeaderAtts" ref="af41d24a0072770d23c6f937aac7bb4c3" args="(const string &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::CommandSave::setHeaderAtts </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>s</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the attributes that are written for the root element of each XML document.<br/>
The default value is an empty string. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04471">4471</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aea5f90dec680a6db85a1224a40ea9c26"></a><!-- doxytag: member="frepple::CommandSave::setHeaderStart" ref="aea5f90dec680a6db85a1224a40ea9c26" args="(const string &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::CommandSave::setHeaderStart </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>s</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the string that is printed as the first line of each XML document.<br/>
The default value is: <?xml version="1.0" encoding="UTF-8"?> </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04461">4461</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>
