<!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::Load 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="a00103.html">Load</a>
</div>
</div>
<div class="contents">
<h1>frepple::Load Class Reference</h1><!-- doxytag: class="frepple::Load" --><!-- doxytag: inherits="frepple::utils::Object,frepple::utils::Association::Node,frepple::Solvable" -->
<p>This class links a resource to a certain operation.
<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::Load:</div>
<div class="dynsection">
<div class="center"><img src="a00441.png" border="0" usemap="#frepple_1_1_load_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_load_inherit__map" id="frepple_1_1_load_inherit__map">
<area shape="rect" id="node2" href="a00120.html" title="Object is the abstract base class for the main entities." alt="" coords="407,5,543,33"/>
<area shape="rect" id="node4" href="a00151.html" title="This is a base class for all Python extension types." alt="" coords="7,5,233,33"/>
<area shape="rect" id="node6" href="a00118.html" title="A base class for the class representing the association itself." alt="" coords="283,55,667,83"/>
<area shape="rect" id="node8" href="a00170.html" title="This class needs to be implemented by all classes that implement dynamic behavior..." alt="" coords="417,106,532,134"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00442.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="a00103.html#a2d04b2c99b6ce43cbea8a76ce06859dc">beginElement</a> (<a class="el" href="a00186.html">XMLInput</a> &, const <a class="el" href="a00002.html">Attribute</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#adbcb964c3c54613bb3102bfbc567c3a3">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"><a class="el" href="a00103.html">Load</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#aa2c9280733f439ea3766f8b2459f9151">getAlternate</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PyObject * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a9bcc4b30fb83164c39ffb294b86c2832">getattro</a> (const <a class="el" href="a00002.html">Attribute</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a55dd804959a1602b394f63ccaa9f9dd9">getHidden</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00049.html">Date</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a7379c868caf6f7d20ba18a6235ede122">getLoadplanDate</a> (const <a class="el" href="a00105.html">LoadPlan</a> *) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a61b673421557d1b833d841502fa851a9">getLoadplanQuantity</a> (const <a class="el" href="a00105.html">LoadPlan</a> *) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00121.html">Operation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a6cb533b9f893a9af0137bf78b07e3987">getOperation</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a0d0ec833e41b3595901349ca17f66956">getPriority</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a8def658dae973c6e51034680baf13c70">getQuantity</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00156.html">Resource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#ab929aafe9c6085a216ad3084ec23c93b">getResource</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00256.html#aa439ebf4ddfb4983ac3d44abacb9b749">SearchMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a71f05cf78bb1925c4af3dc8494641a57">getSearch</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a7cab9031b62cd9d89a924ff5dcb2aa60">getSetup</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a558aeaf5a31c60a94d0c3a3f6ec0a6b2">getSize</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="a00103.html#aeee91176d13b29bfef8ca0b680c382e7">getType</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#ac390d54e89b0a2903c092c5a6ec46571">hasAlternates</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a4ce25fb7a9346e3d89aedd249cc6ab07">Load</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#af11375418a1627299f0f49ff637571b4">Load</a> (<a class="el" href="a00121.html">Operation</a> *o, <a class="el" href="a00156.html">Resource</a> *r, double u)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a403906d3bdeb89d1c2887c4c60d5b8ff">setAlternate</a> (const string &n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a21bfb581059ea14921565dd86f7fb007">setAlternate</a> (<a class="el" href="a00103.html">Load</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#af71ff01487d4c328888ff9730bc06d50">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="a00103.html#a5f1714647aeb77dd01095bd74c3e9830">setOperation</a> (<a class="el" href="a00121.html">Operation</a> *o)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a70b9905e05f59754ca0b739c98720d83">setPriority</a> (int i)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#aa39839141ec642898b6b7331f61514ef">setQuantity</a> (double f)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a90023cac148b876db4f1bb3da876f21c">setResource</a> (<a class="el" href="a00156.html">Resource</a> *r)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a5190926294619bb17a441345c754d333">setSearch</a> (const string a)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a16e0939e73cd0dd9fae41145caf70931">setSetup</a> (const string)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a2c0c3916222c1966dab27ad9447e5029">solve</a> (<a class="el" href="a00171.html">Solver</a> &s, void *v=NULL) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a5ea80e6ec27b0e31eec7b7e3b2baf83d">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="a00103.html#a84c0739c123a504da8afdd35810dbdde">~Load</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="a00103.html#a48ed20340de96da9265bf4afc6575d37">initialize</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#ae1cacbcbdac199c21beb1f79bbdc0a97">writer</a> (const <a class="el" href="a00114.html">MetaCategory</a> *, <a class="el" href="a00189.html">XMLOutput</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="a00103.html#a0abc6edc2b69b52286df209039c0c118">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="a00103.html#a48b9344c0b50eaf70275cf053612df8f">Operation</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00103.html#a0ebbdc315d2466b93b663656f9d9ab44">Resource</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class links a resource to a certain operation. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04058">4058</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af11375418a1627299f0f49ff637571b4"></a><!-- doxytag: member="frepple::Load::Load" ref="af11375418a1627299f0f49ff637571b4" args="(Operation *o, Resource *r, double u)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::Load::Load </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00121.html">Operation</a> * </td>
<td class="paramname"> <em>o</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00156.html">Resource</a> * </td>
<td class="paramname"> <em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>u</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04067">4067</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a84c0739c123a504da8afdd35810dbdde"></a><!-- doxytag: member="frepple::Load::~Load" ref="a84c0739c123a504da8afdd35810dbdde" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::Load::~Load </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="a00212_source.html#l00148">148</a> of file <a class="el" href="a00212_source.html">load.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4ce25fb7a9346e3d89aedd249cc6ab07"></a><!-- doxytag: member="frepple::Load::Load" ref="a4ce25fb7a9346e3d89aedd249cc6ab07" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::Load::Load </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04160">4160</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="a2d04b2c99b6ce43cbea8a76ce06859dc"></a><!-- doxytag: member="frepple::Load::beginElement" ref="a2d04b2c99b6ce43cbea8a76ce06859dc" args="(XMLInput &, const Attribute &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Load::beginElement </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><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 for each element within the "this" element, for which the "this" element is immediate parent.<br/>
It is called when the open element tag is encountered. </p>
<p>Reimplemented from <a class="el" href="a00120.html#ac17c9f7df359ee20839f5e09723d38f1">frepple::utils::Object</a>.</p>
<p>Definition at line <a class="el" href="a00212_source.html#l00308">308</a> of file <a class="el" href="a00212_source.html">load.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="adbcb964c3c54613bb3102bfbc567c3a3"></a><!-- doxytag: member="frepple::Load::endElement" ref="adbcb964c3c54613bb3102bfbc567c3a3" args="(XMLInput &, const Attribute &, const DataElement &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Load::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="a00212_source.html#l00317">317</a> of file <a class="el" href="a00212_source.html">load.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa2c9280733f439ea3766f8b2459f9151"></a><!-- doxytag: member="frepple::Load::getAlternate" ref="aa2c9280733f439ea3766f8b2459f9151" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00103.html">Load</a>* frepple::Load::getAlternate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the load of which this one is an alternate.<br/>
NULL is return where there is none. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04119">4119</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9bcc4b30fb83164c39ffb294b86c2832"></a><!-- doxytag: member="frepple::Load::getattro" ref="a9bcc4b30fb83164c39ffb294b86c2832" args="(const Attribute &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PyObject * frepple::Load::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="a00212_source.html#l00366">366</a> of file <a class="el" href="a00212_source.html">load.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a55dd804959a1602b394f63ccaa9f9dd9"></a><!-- doxytag: member="frepple::Load::getHidden" ref="a55dd804959a1602b394f63ccaa9f9dd9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::Load::getHidden </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether an entity is real or dummy. </p>
<p>Reimplemented from <a class="el" href="a00120.html#a05c1c38045f55cd8ce66cee9e933d2bb">frepple::utils::Object</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l04147">4147</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7379c868caf6f7d20ba18a6235ede122"></a><!-- doxytag: member="frepple::Load::getLoadplanDate" ref="a7379c868caf6f7d20ba18a6235ede122" args="(const LoadPlan *) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00049.html">Date</a> frepple::Load::getLoadplanDate </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00105.html">LoadPlan</a> * </td>
<td class="paramname"> <em>lp</em></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method holds the logic the compute the date of a loadplan. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04893">4893</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a61b673421557d1b833d841502fa851a9"></a><!-- doxytag: member="frepple::Load::getLoadplanQuantity" ref="a61b673421557d1b833d841502fa851a9" args="(const LoadPlan *) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double frepple::Load::getLoadplanQuantity </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00105.html">LoadPlan</a> * </td>
<td class="paramname"> <em>lp</em></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method holds the logic the compute the quantity of a loadplan. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04907">4907</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6cb533b9f893a9af0137bf78b07e3987"></a><!-- doxytag: member="frepple::Load::getOperation" ref="a6cb533b9f893a9af0137bf78b07e3987" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00121.html">Operation</a>* frepple::Load::getOperation </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the operation consuming the resource capacity. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04081">4081</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0d0ec833e41b3595901349ca17f66956"></a><!-- doxytag: member="frepple::Load::getPriority" ref="a0d0ec833e41b3595901349ca17f66956" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int frepple::Load::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 of a load. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04111">4111</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8def658dae973c6e51034680baf13c70"></a><!-- doxytag: member="frepple::Load::getQuantity" ref="a8def658dae973c6e51034680baf13c70" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double frepple::Load::getQuantity </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns how much capacity is consumed during the duration of the operationplan. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04096">4096</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab929aafe9c6085a216ad3084ec23c93b"></a><!-- doxytag: member="frepple::Load::getResource" ref="ab929aafe9c6085a216ad3084ec23c93b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00156.html">Resource</a>* frepple::Load::getResource </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the capacity resource being consumed. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04088">4088</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a71f05cf78bb1925c4af3dc8494641a57"></a><!-- doxytag: member="frepple::Load::getSearch" ref="a71f05cf78bb1925c4af3dc8494641a57" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00256.html#aa439ebf4ddfb4983ac3d44abacb9b749">SearchMode</a> frepple::Load::getSearch </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the search mode. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04164">4164</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7cab9031b62cd9d89a924ff5dcb2aa60"></a><!-- doxytag: member="frepple::Load::getSetup" ref="a7cab9031b62cd9d89a924ff5dcb2aa60" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const string& frepple::Load::getSetup </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the required resource setup. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04131">4131</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a558aeaf5a31c60a94d0c3a3f6ec0a6b2"></a><!-- doxytag: member="frepple::Load::getSize" ref="a558aeaf5a31c60a94d0c3a3f6ec0a6b2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t frepple::Load::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#l04156">4156</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aeee91176d13b29bfef8ca0b680c382e7"></a><!-- doxytag: member="frepple::Load::getType" ref="aeee91176d13b29bfef8ca0b680c382e7" 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::Load::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#l04154">4154</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac390d54e89b0a2903c092c5a6ec46571"></a><!-- doxytag: member="frepple::Load::hasAlternates" ref="ac390d54e89b0a2903c092c5a6ec46571" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::Load::hasAlternates </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if there are alternates for this load. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04114">4114</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a48ed20340de96da9265bf4afc6575d37"></a><!-- doxytag: member="frepple::Load::initialize" ref="a48ed20340de96da9265bf4afc6575d37" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int frepple::Load::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="a00212_source.html#l00036">36</a> of file <a class="el" href="a00212_source.html">load.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a403906d3bdeb89d1c2887c4c60d5b8ff"></a><!-- doxytag: member="frepple::Load::setAlternate" ref="a403906d3bdeb89d1c2887c4c60d5b8ff" args="(const string &n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Load::setAlternate </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>n</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Define the load of which this one is an alternate. </p>
<p>Definition at line <a class="el" href="a00212_source.html#l00235">235</a> of file <a class="el" href="a00212_source.html">load.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a21bfb581059ea14921565dd86f7fb007"></a><!-- doxytag: member="frepple::Load::setAlternate" ref="a21bfb581059ea14921565dd86f7fb007" args="(Load *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Load::setAlternate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00103.html">Load</a> * </td>
<td class="paramname"> <em>f</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Define the load of which this one is an alternate. </p>
<p>Definition at line <a class="el" href="a00212_source.html#l00221">221</a> of file <a class="el" href="a00212_source.html">load.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af71ff01487d4c328888ff9730bc06d50"></a><!-- doxytag: member="frepple::Load::setattro" ref="af71ff01487d4c328888ff9730bc06d50" args="(const Attribute &, const PythonObject &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int frepple::Load::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="a00212_source.html#l00396">396</a> of file <a class="el" href="a00212_source.html">load.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5f1714647aeb77dd01095bd74c3e9830"></a><!-- doxytag: member="frepple::Load::setOperation" ref="a5f1714647aeb77dd01095bd74c3e9830" args="(Operation *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Load::setOperation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00121.html">Operation</a> * </td>
<td class="paramname"> <em>o</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the operation being loaded. This method can only be called once for a load. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04085">4085</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a70b9905e05f59754ca0b739c98720d83"></a><!-- doxytag: member="frepple::Load::setPriority" ref="a70b9905e05f59754ca0b739c98720d83" args="(int i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Load::setPriority </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the priority of a load. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04108">4108</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa39839141ec642898b6b7331f61514ef"></a><!-- doxytag: member="frepple::Load::setQuantity" ref="aa39839141ec642898b6b7331f61514ef" args="(double f)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Load::setQuantity </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>f</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the quantity of the load. </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>DataException</em> </td><td>When a negative number is passed. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00218_source.html#l04101">4101</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a90023cac148b876db4f1bb3da876f21c"></a><!-- doxytag: member="frepple::Load::setResource" ref="a90023cac148b876db4f1bb3da876f21c" args="(Resource *r)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Load::setResource </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00156.html">Resource</a> * </td>
<td class="paramname"> <em>r</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the capacity being consumed. This method can only be called once on a resource. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04092">4092</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5190926294619bb17a441345c754d333"></a><!-- doxytag: member="frepple::Load::setSearch" ref="a5190926294619bb17a441345c754d333" args="(const string a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Load::setSearch </td>
<td>(</td>
<td class="paramtype">const string </td>
<td class="paramname"> <em>a</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the search mode. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04167">4167</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a16e0939e73cd0dd9fae41145caf70931"></a><!-- doxytag: member="frepple::Load::setSetup" ref="a16e0939e73cd0dd9fae41145caf70931" args="(const string)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Load::setSetup </td>
<td>(</td>
<td class="paramtype">const string </td>
<td class="paramname"> <em>n</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the required resource setup. </p>
<p>Definition at line <a class="el" href="a00212_source.html#l00245">245</a> of file <a class="el" href="a00212_source.html">load.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2c0c3916222c1966dab27ad9447e5029"></a><!-- doxytag: member="frepple::Load::solve" ref="a2c0c3916222c1966dab27ad9447e5029" args="(Solver &s, void *v=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void frepple::Load::solve </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00171.html">Solver</a> & </td>
<td class="paramname"> <em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>v</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is called by solver classes. The implementation of this class simply calls the solve method on the solver class. Using the polymorphism the solver can implement seperate methods for different plannable subclasses. </p>
<p>Reimplemented from <a class="el" href="a00170.html#a35ad0dc1632fbfaee0ecc55752980c29">frepple::Solvable</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l04152">4152</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5ea80e6ec27b0e31eec7b7e3b2baf83d"></a><!-- doxytag: member="frepple::Load::writeElement" ref="a5ea80e6ec27b0e31eec7b7e3b2baf83d" args="(XMLOutput *, const Keyword &, mode=DEFAULT) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Load::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="a00212_source.html#l00263">263</a> of file <a class="el" href="a00212_source.html">load.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae1cacbcbdac199c21beb1f79bbdc0a97"></a><!-- doxytag: member="frepple::Load::writer" ref="ae1cacbcbdac199c21beb1f79bbdc0a97" args="(const MetaCategory *, XMLOutput *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Load::writer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00114.html">MetaCategory</a> * </td>
<td class="paramname"> <em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00189.html">XMLOutput</a> * </td>
<td class="paramname"> <em>o</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>Definition at line <a class="el" href="a00212_source.html#l00058">58</a> of file <a class="el" href="a00212_source.html">load.cpp</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a48b9344c0b50eaf70275cf053612df8f"></a><!-- doxytag: member="frepple::Load::Operation" ref="a48b9344c0b50eaf70275cf053612df8f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="a00121.html">Operation</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l04063">4063</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0ebbdc315d2466b93b663656f9d9ab44"></a><!-- doxytag: member="frepple::Load::Resource" ref="a0ebbdc315d2466b93b663656f9d9ab44" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="a00156.html">Resource</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l04062">4062</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="a0abc6edc2b69b52286df209039c0c118"></a><!-- doxytag: member="frepple::Load::metadata" ref="a0abc6edc2b69b52286df209039c0c118" 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="a00103.html#a0abc6edc2b69b52286df209039c0c118">frepple::Load::metadata</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l04155">4155</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="a00212_source.html">load.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>
