<!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::CommandReadXMLFile 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="a00034.html">CommandReadXMLFile</a>
</div>
</div>
<div class="contents">
<h1>frepple::CommandReadXMLFile Class Reference</h1><!-- doxytag: class="frepple::CommandReadXMLFile" --><!-- doxytag: inherits="frepple::utils::Command" -->
<p>This command is used for reading XML input. The input comes either from a flatfile, or from the standard input.
<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::CommandReadXMLFile:</div>
<div class="dynsection">
<div class="center"><img src="a00394.png" border="0" usemap="#frepple_1_1_command_read_x_m_l_file_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_command_read_x_m_l_file_inherit__map" id="frepple_1_1_command_read_x_m_l_file_inherit__map">
<area shape="rect" id="node2" href="a00025.html" title="Abstract base class for all commands." alt="" coords="28,6,185,34"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00395.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="a00034.html#a78443cdded581cac591c7003777d38bf">CommandReadXMLFile</a> (const string &s, bool v=true, bool o=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#a5a8e5acdc417f02076e7779c7675592a">CommandReadXMLFile</a> (const char *s=NULL, bool v=true, bool o=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#af80b41aa35b39eccfcce566002b0d363">execute</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#aa1a789583d35a0fe67d349f3dd28a4b5">getFileName</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#a9e153b3a36ec3624db9147b71234d764">getValidate</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#afbe426a8cf3e177f6b96b25c4121c908">getValidateOnly</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#ae36396b7131ec7404ec35eac226d000c">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="a00034.html#afc142d38afa784be52856dafbd0bd3a5">setValidate</a> (bool b)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#a656747498e8b1fedeaaf9bb9f8699453">setValidateOnly</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="a00034.html#a74255af79a52f7d1e6c033fe49a34f44">executePython</a> (PyObject *, PyObject *)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This command is used for reading XML input. The input comes either from a flatfile, or from the standard input. </p>
<p>The command is not thread-safe: multiple threads can simultaneously access the same objects. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04298">4298</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5a8e5acdc417f02076e7779c7675592a"></a><!-- doxytag: member="frepple::CommandReadXMLFile::CommandReadXMLFile" ref="a5a8e5acdc417f02076e7779c7675592a" args="(const char *s=NULL, bool v=true, bool o=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::CommandReadXMLFile::CommandReadXMLFile </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>s</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>v</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>o</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. If no file or directory name is passed or specified later the standard input will be read during execution of the command. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04303">4303</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a78443cdded581cac591c7003777d38bf"></a><!-- doxytag: member="frepple::CommandReadXMLFile::CommandReadXMLFile" ref="a78443cdded581cac591c7003777d38bf" args="(const string &s, bool v=true, bool o=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::CommandReadXMLFile::CommandReadXMLFile </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>v</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>o</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></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#l04307">4307</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="af80b41aa35b39eccfcce566002b0d363"></a><!-- doxytag: member="frepple::CommandReadXMLFile::execute" ref="af80b41aa35b39eccfcce566002b0d363" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::CommandReadXMLFile::execute </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The commit action reads the input. If a filename is specified (either in the constructor or with the setFileName function), a flat file is read. Otherwise, the standard input is read. </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#l00038">38</a> of file <a class="el" href="a00192_source.html">model/actions.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a74255af79a52f7d1e6c033fe49a34f44"></a><!-- doxytag: member="frepple::CommandReadXMLFile::executePython" ref="a74255af79a52f7d1e6c033fe49a34f44" args="(PyObject *, PyObject *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PyObject * frepple::CommandReadXMLFile::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 for this command. </p>
<p>Definition at line <a class="el" href="a00192_source.html#l00070">70</a> of file <a class="el" href="a00192_source.html">model/actions.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa1a789583d35a0fe67d349f3dd28a4b5"></a><!-- doxytag: member="frepple::CommandReadXMLFile::getFileName" ref="aa1a789583d35a0fe67d349f3dd28a4b5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string frepple::CommandReadXMLFile::getFileName </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the name of the input file. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04314">4314</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9e153b3a36ec3624db9147b71234d764"></a><!-- doxytag: member="frepple::CommandReadXMLFile::getValidate" ref="a9e153b3a36ec3624db9147b71234d764" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::CommandReadXMLFile::getValidate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the schema validation has been enabled. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04320">4320</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="afbe426a8cf3e177f6b96b25c4121c908"></a><!-- doxytag: member="frepple::CommandReadXMLFile::getValidateOnly" ref="afbe426a8cf3e177f6b96b25c4121c908" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::CommandReadXMLFile::getValidateOnly </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether we only need to validate to data, or really execute them too. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04327">4327</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae36396b7131ec7404ec35eac226d000c"></a><!-- doxytag: member="frepple::CommandReadXMLFile::setFileName" ref="ae36396b7131ec7404ec35eac226d000c" args="(const string &v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::CommandReadXMLFile::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 input file. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04311">4311</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="afc142d38afa784be52856dafbd0bd3a5"></a><!-- doxytag: member="frepple::CommandReadXMLFile::setValidate" ref="afc142d38afa784be52856dafbd0bd3a5" args="(bool b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::CommandReadXMLFile::setValidate </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>Enables or disables the validation. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04317">4317</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a656747498e8b1fedeaaf9bb9f8699453"></a><!-- doxytag: member="frepple::CommandReadXMLFile::setValidateOnly" ref="a656747498e8b1fedeaaf9bb9f8699453" args="(bool b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::CommandReadXMLFile::setValidateOnly </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>Only validate the input, do not really execute it. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04323">4323</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>
