<!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::SetupMatrix::Rule 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="a00165.html">SetupMatrix</a>::<a class="el" href="a00160.html">Rule</a>
</div>
</div>
<div class="contents">
<h1>frepple::SetupMatrix::Rule Class Reference</h1><!-- doxytag: class="frepple::SetupMatrix::Rule" --><!-- doxytag: inherits="frepple::utils::Object" -->
<p>An specific changeover rule in a setup matrix.
<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::SetupMatrix::Rule:</div>
<div class="dynsection">
<div class="center"><img src="a00525.png" border="0" usemap="#frepple_1_1_setup_matrix_1_1_rule_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_setup_matrix_1_1_rule_inherit__map" id="frepple_1_1_setup_matrix_1_1_rule_inherit__map">
<area shape="rect" id="node2" href="a00120.html" title="Object is the abstract base class for the main entities." alt="" coords="51,83,187,111"/>
<area shape="rect" id="node4" href="a00151.html" title="This is a base class for all Python extension types." alt="" coords="5,6,232,34"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00526.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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#aa1a62514cbfce49c2a6fad86f9f2b619">endElement</a> (<a class="el" href="a00186.html">XMLInput</a> &, const <a class="el" href="a00002.html">Attribute</a> &, const <a class="el" href="a00047.html">DataElement</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual PyObject * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#ae9aef1dfff28ff034dfeee764a212f6b">getattro</a> (const <a class="el" href="a00002.html">Attribute</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#ac41cf32876b75929836777b1cc78f049">getCost</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00179.html">TimePeriod</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#a86db8a7f88eb9abd1dd3c099ca7a944e">getDuration</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#aae1be986c397ea7b0bfc72bdef6f21ee">getFromSetup</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#a64746ea25ea01d76bffb7dc72ac5e080">getPriority</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#a3d890c7105d7c25668dbb059984530a0">getSize</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#a39a544d79a7a55dfe77e79588fc7e182">getToSetup</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="a00115.html">MetaClass</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#aeeda9c9e26302325a381179961552050">getType</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#aab09b14a3ccc5ac8fca5f06c46bb9230">Rule</a> (<a class="el" href="a00165.html">SetupMatrix</a> *s, int p=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#ab36d248ccce512ee2687ed0912345a3b">setattro</a> (const <a class="el" href="a00002.html">Attribute</a> &, const <a class="el" href="a00154.html">PythonObject</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#a2d9c5a9e6b0b5f84e1a08f633fff184a">setCost</a> (const double p)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#a462401ed07d7ed19d50a9302f7662458">setDuration</a> (const <a class="el" href="a00179.html">TimePeriod</a> p)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#afeda6a852fcf4390a0b5abd8a5ead426">setFromSetup</a> (const string f)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#a9b9482727e470f01960eb6fa74686712">setPriority</a> (const int)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#a2abdf44bfdecb8a6ca539f74d4872af9">setToSetup</a> (const string f)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#a85805ac8e48a65353925b1c66db9bef1">writeElement</a> (<a class="el" href="a00189.html">XMLOutput</a> *, const <a class="el" href="a00096.html">Keyword</a> &, <a class="el" href="a00257.html#a20c2c7e4c6b668e71c154ae3eb18f398">mode</a>=DEFAULT) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#aac1bc5ee4f1cc00daa04c682d33e2205">~Rule</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#a66c9698df6098ec77684eaca40a1d746">initialize</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="a00114.html">MetaCategory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#ae470441d15b30b149d7179596c96498e">metadata</a></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#a363d8d3a29e4e50cafa67185d70c8403">RuleIterator</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#af45da32a216cc1e50ef250dc3f153d4b">SetupMatrix</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An specific changeover rule in a setup matrix. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03683">3683</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aab09b14a3ccc5ac8fca5f06c46bb9230"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::Rule" ref="aab09b14a3ccc5ac8fca5f06c46bb9230" args="(SetupMatrix *s, int p=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::SetupMatrix::Rule::Rule </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00165.html">SetupMatrix</a> * </td>
<td class="paramname"> <em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>p</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Definition at line <a class="el" href="a00237_source.html#l00251">251</a> of file <a class="el" href="a00237_source.html">setupmatrix.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aac1bc5ee4f1cc00daa04c682d33e2205"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::~Rule" ref="aac1bc5ee4f1cc00daa04c682d33e2205" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::SetupMatrix::Rule::~Rule </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="a00237_source.html#l00281">281</a> of file <a class="el" href="a00237_source.html">setupmatrix.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa1a62514cbfce49c2a6fad86f9f2b619"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::endElement" ref="aa1a62514cbfce49c2a6fad86f9f2b619" args="(XMLInput &, const Attribute &, const DataElement &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::SetupMatrix::Rule::endElement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00186.html">XMLInput</a> & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00002.html">Attribute</a> & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00047.html">DataElement</a> & </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called while restoring the model from an XML-file.<br/>
This is called when the corresponding close element tag is encountered, and the Data() member of pElement is valid. </p>
<p>Implements <a class="el" href="a00120.html#a88eab6db69f9b38c6b3f5ea37da630fd">frepple::utils::Object</a>.</p>
<p>Definition at line <a class="el" href="a00237_source.html#l00302">302</a> of file <a class="el" href="a00237_source.html">setupmatrix.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae9aef1dfff28ff034dfeee764a212f6b"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::getattro" ref="ae9aef1dfff28ff034dfeee764a212f6b" args="(const Attribute &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PyObject * frepple::SetupMatrix::Rule::getattro </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00002.html">Attribute</a> & </td>
<td class="paramname"> <em>attr</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default getattro method. <br/>
Subclasses are expected to implement an override if the type supports gettattro. </p>
<p>Reimplemented from <a class="el" href="a00151.html#af3cfc29003472070ba9e133bcf5eb335">frepple::utils::PythonExtensionBase</a>.</p>
<p>Definition at line <a class="el" href="a00237_source.html#l00317">317</a> of file <a class="el" href="a00237_source.html">setupmatrix.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac41cf32876b75929836777b1cc78f049"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::getCost" ref="ac41cf32876b75929836777b1cc78f049" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double frepple::SetupMatrix::Rule::getCost </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the conversion cost. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03737">3737</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a86db8a7f88eb9abd1dd3c099ca7a944e"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::getDuration" ref="a86db8a7f88eb9abd1dd3c099ca7a944e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00179.html">TimePeriod</a> frepple::SetupMatrix::Rule::getDuration </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the conversion duration. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03731">3731</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aae1be986c397ea7b0bfc72bdef6f21ee"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::getFromSetup" ref="aae1be986c397ea7b0bfc72bdef6f21ee" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const string& frepple::SetupMatrix::Rule::getFromSetup </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the from setup. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03719">3719</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a64746ea25ea01d76bffb7dc72ac5e080"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::getPriority" ref="a64746ea25ea01d76bffb7dc72ac5e080" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double frepple::SetupMatrix::Rule::getPriority </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the priority. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03713">3713</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3d890c7105d7c25668dbb059984530a0"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::getSize" ref="a3d890c7105d7c25668dbb059984530a0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t frepple::SetupMatrix::Rule::getSize </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the memory size of the object in bytes. </p>
<p>Implements <a class="el" href="a00120.html#ae381655a0e700d1e0d9ef72379792872">frepple::utils::Object</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l03703">3703</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a39a544d79a7a55dfe77e79588fc7e182"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::getToSetup" ref="a39a544d79a7a55dfe77e79588fc7e182" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const string& frepple::SetupMatrix::Rule::getToSetup </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the from setup. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03725">3725</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aeeda9c9e26302325a381179961552050"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::getType" ref="aeeda9c9e26302325a381179961552050" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="a00115.html">MetaClass</a>& frepple::SetupMatrix::Rule::getType </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This returns the type information on the object, a bit similar to the standard type_info information. </p>
<p>Implements <a class="el" href="a00120.html#a2e5ff5e5d9c32647f692abd04a0d72d2">frepple::utils::Object</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l03700">3700</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a66c9698df6098ec77684eaca40a1d746"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::initialize" ref="a66c9698df6098ec77684eaca40a1d746" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int frepple::SetupMatrix::Rule::initialize </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00237_source.html#l00053">53</a> of file <a class="el" href="a00237_source.html">setupmatrix.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab36d248ccce512ee2687ed0912345a3b"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::setattro" ref="ab36d248ccce512ee2687ed0912345a3b" args="(const Attribute &, const PythonObject &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int frepple::SetupMatrix::Rule::setattro </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00002.html">Attribute</a> & </td>
<td class="paramname"> <em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00154.html">PythonObject</a> & </td>
<td class="paramname"> <em>field</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default setattro method. <br/>
Subclasses are expected to implement an override if the type supports settattro. </p>
<p>Reimplemented from <a class="el" href="a00151.html#a0a1bd051198a1b82fd23d3ca04c3ee8d">frepple::utils::PythonExtensionBase</a>.</p>
<p>Definition at line <a class="el" href="a00237_source.html#l00333">333</a> of file <a class="el" href="a00237_source.html">setupmatrix.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2d9c5a9e6b0b5f84e1a08f633fff184a"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::setCost" ref="a2d9c5a9e6b0b5f84e1a08f633fff184a" args="(const double p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::SetupMatrix::Rule::setCost </td>
<td>(</td>
<td class="paramtype">const double </td>
<td class="paramname"> <em>p</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the conversion cost. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03734">3734</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a462401ed07d7ed19d50a9302f7662458"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::setDuration" ref="a462401ed07d7ed19d50a9302f7662458" args="(const TimePeriod p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::SetupMatrix::Rule::setDuration </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00179.html">TimePeriod</a> </td>
<td class="paramname"> <em>p</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the conversion duration. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03728">3728</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="afeda6a852fcf4390a0b5abd8a5ead426"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::setFromSetup" ref="afeda6a852fcf4390a0b5abd8a5ead426" args="(const string f)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::SetupMatrix::Rule::setFromSetup </td>
<td>(</td>
<td class="paramtype">const string </td>
<td class="paramname"> <em>f</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the from setup. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03716">3716</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9b9482727e470f01960eb6fa74686712"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::setPriority" ref="a9b9482727e470f01960eb6fa74686712" args="(const int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::SetupMatrix::Rule::setPriority </td>
<td>(</td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>n</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the priority.<br/>
The priority value is a key field. If multiple rules have the same priority a data exception is thrown. </p>
<p>Definition at line <a class="el" href="a00237_source.html#l00351">351</a> of file <a class="el" href="a00237_source.html">setupmatrix.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2abdf44bfdecb8a6ca539f74d4872af9"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::setToSetup" ref="a2abdf44bfdecb8a6ca539f74d4872af9" args="(const string f)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::SetupMatrix::Rule::setToSetup </td>
<td>(</td>
<td class="paramtype">const string </td>
<td class="paramname"> <em>f</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the from setup. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03722">3722</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a85805ac8e48a65353925b1c66db9bef1"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::writeElement" ref="a85805ac8e48a65353925b1c66db9bef1" args="(XMLOutput *, const Keyword &, mode=DEFAULT) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::SetupMatrix::Rule::writeElement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00189.html">XMLOutput</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00096.html">Keyword</a> & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00257.html#a20c2c7e4c6b668e71c154ae3eb18f398">mode</a> </td>
<td class="paramname"> = <code>DEFAULT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called while writing the model into an XML-file. The user class should write itself out, using the IOutStream members for its "simple" members and calling writeElement recursively for any contained objects. Not all classes are expected to implement this method. In instances of such a class can be created but can't be persisted. E.g. Command </p>
<p>Reimplemented from <a class="el" href="a00120.html#a324e43c334cb519909fcbdad0f8cbd82">frepple::utils::Object</a>.</p>
<p>Definition at line <a class="el" href="a00237_source.html#l00291">291</a> of file <a class="el" href="a00237_source.html">setupmatrix.cpp</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a363d8d3a29e4e50cafa67185d70c8403"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::RuleIterator" ref="a363d8d3a29e4e50cafa67185d70c8403" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="a00161.html">RuleIterator</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l03685">3685</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="af45da32a216cc1e50ef250dc3f153d4b"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::SetupMatrix" ref="af45da32a216cc1e50ef250dc3f153d4b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="a00165.html">SetupMatrix</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l03686">3686</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ae470441d15b30b149d7179596c96498e"></a><!-- doxytag: member="frepple::SetupMatrix::Rule::metadata" ref="ae470441d15b30b149d7179596c96498e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00114.html">MetaCategory</a> * <a class="el" href="a00160.html#ae470441d15b30b149d7179596c96498e">frepple::SetupMatrix::Rule::metadata</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l03701">3701</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="a00237_source.html">setupmatrix.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>
