<!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::OperationAlternate 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="a00122.html">OperationAlternate</a>
</div>
</div>
<div class="contents">
<h1>frepple::OperationAlternate Class Reference</h1><!-- doxytag: class="frepple::OperationAlternate" --><!-- doxytag: inherits="frepple::Operation" -->
<p>This class represents a choice between multiple operations. The alternates are sorted in order of priority.
<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::OperationAlternate:</div>
<div class="dynsection">
<div class="center"><img src="a00457.png" border="0" usemap="#frepple_1_1_operation_alternate_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_operation_alternate_inherit__map" id="frepple_1_1_operation_alternate_inherit__map">
<area shape="rect" id="node2" href="a00121.html" title="An operation represents an activity: these consume and produce material, take time..." alt="" coords="807,131,929,159"/>
<area shape="rect" id="node4" href="a00085.html" title="frepple::utils::HasName\< Operation \>" alt="" coords="521,55,756,83"/>
<area shape="rect" id="node6" href="a00119.html" title="Class NonCopyable is a base class. Derive your own class from it when you want to..." alt="" coords="289,5,465,33"/>
<area shape="rect" id="node8" href="a00182.html" title="This class represents a node in the tree." alt="" coords="284,55,471,83"/>
<area shape="rect" id="node10" href="a00120.html" title="Object is the abstract base class for the main entities." alt="" coords="309,106,445,134"/>
<area shape="rect" id="node12" href="a00151.html" title="This is a base class for all Python extension types." alt="" coords="7,106,233,134"/>
<area shape="rect" id="node14" href="a00084.html" title="The purpose of this class is to compute the levels of all buffers, operations and..." alt="" coords="579,106,699,134"/>
<area shape="rect" id="node16" href="a00133.html" title="This class needs to be implemented by all classes that implement dynamic behavior..." alt="" coords="577,157,700,185"/>
<area shape="rect" id="node18" href="a00086.html" title="Classes that keep track of problem conditions need to implement this class." alt="" coords="305,157,449,185"/>
<area shape="rect" id="node20" href="a00170.html" title="This class needs to be implemented by all classes that implement dynamic behavior..." alt="" coords="320,207,435,235"/>
<area shape="rect" id="node22" href="a00082.html" title="This is a decorator class for the main objects." alt="" coords="545,207,732,235"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00458.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef pair< int, <a class="el" href="a00050.html">DateRange</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#a21276a85b32a20ee590af9e02445d5f8">alternateProperty</a></td></tr>
<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="a00122.html#accd0dc05a16c25a96b3fad2c22834ccc">addAlternate</a> (<a class="el" href="a00121.html">Operation</a> *, int=1, <a class="el" href="a00050.html">DateRange</a>=<a class="el" href="a00050.html">DateRange</a>())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#a21d641b55fcac1c0be9e52df180056c9">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="a00122.html#aa1a730f69090603825c925e332491b4c">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="a00122.html#aca0c41e63d37719114c08f1c0e709664">getattro</a> (const <a class="el" href="a00002.html">Attribute</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00122.html#a21276a85b32a20ee590af9e02445d5f8">alternateProperty</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#afa54c209215c9841187cecfb0c9e2808">getProperties</a> (<a class="el" href="a00121.html">Operation</a> *o) 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="a00122.html#a9eee64d0bb881e81d0fe9ba7dbe05c66">getSearch</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="a00122.html#a859817e8336730b8912c2b867859e8f8">getSize</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="a00121.html#ae5c93377f652a5bdb9ec20e6bee898e9">Operationlist</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#a15e4ba08a35bb3a364e2f6ce2512f3c6">getSubOperations</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="a00122.html#a909fec5736d2bd90dc6052aa8f4b7b94">getType</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#a5e0e712c1554a1ace140966198ad012f">OperationAlternate</a> (const string &c)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#a8067158022e2bd145cc9dad06c4e685b">removeSubOperation</a> (<a class="el" href="a00121.html">Operation</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#a4adc5f876e7f8719b61f27770e0ed4e0">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="a00122.html#ac5c3ebcb02f8d7b61ec15f2c0318c3c5">setEffective</a> (<a class="el" href="a00121.html">Operation</a> *, <a class="el" href="a00050.html">DateRange</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00127.html">OperationPlanState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#affd8bc828a150f258619aec11c4559b0">setOperationPlanParameters</a> (<a class="el" href="a00125.html">OperationPlan</a> *, double, <a class="el" href="a00049.html">Date</a>, <a class="el" href="a00049.html">Date</a>, bool=true, bool=true) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#a552b0c104bec99d2bdeb153cf7189b8d">setPriority</a> (<a class="el" href="a00121.html">Operation</a> *, int)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#a59b4283e24286d5b9d19671379eb4ecf">setSearch</a> (const string a)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#a09ed4c0ea12a06e628ef7b6313493b46">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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#abc8519120ca9ff5e0be1a65131751a09">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="a00122.html#ab0389a8a75d09bd9c12560e0eee782b4">~OperationAlternate</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="a00122.html#a6efec2ca0c191b0630f0e915f860c5df">addAlternate</a> (PyObject *, PyObject *, PyObject *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#a0fd492b1c7b1c0d52270bd77cde6ffef">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="a00115.html">MetaClass</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#af55e7f4c9ea99a222e7433756f001d4a">metadata</a></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#a76ab3ec452cd87b5a3bc72af13454458">extraInstantiate</a> (<a class="el" href="a00125.html">OperationPlan</a> *o)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class represents a choice between multiple operations. The alternates are sorted in order of priority. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l02728">2728</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a21276a85b32a20ee590af9e02445d5f8"></a><!-- doxytag: member="frepple::OperationAlternate::alternateProperty" ref="a21276a85b32a20ee590af9e02445d5f8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef pair<int,<a class="el" href="a00050.html">DateRange</a>> <a class="el" href="a00122.html#a21276a85b32a20ee590af9e02445d5f8">frepple::OperationAlternate::alternateProperty</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l02731">2731</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5e0e712c1554a1ace140966198ad012f"></a><!-- doxytag: member="frepple::OperationAlternate::OperationAlternate" ref="a5e0e712c1554a1ace140966198ad012f" args="(const string &c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::OperationAlternate::OperationAlternate </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>c</em></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#l02734">2734</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab0389a8a75d09bd9c12560e0eee782b4"></a><!-- doxytag: member="frepple::OperationAlternate::~OperationAlternate" ref="ab0389a8a75d09bd9c12560e0eee782b4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::OperationAlternate::~OperationAlternate </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="a00223_source.html#l00157">157</a> of file <a class="el" href="a00223_source.html">operation.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6efec2ca0c191b0630f0e915f860c5df"></a><!-- doxytag: member="frepple::OperationAlternate::addAlternate" ref="a6efec2ca0c191b0630f0e915f860c5df" args="(PyObject *, PyObject *, PyObject *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PyObject * frepple::OperationAlternate::addAlternate </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PyObject * </td>
<td class="paramname"> <em>kwdict</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>Add an alternate to the operation.<br/>
The keyword arguments are "operation", "priority", "effective_start" and "effective_end" </p>
<p>Definition at line <a class="el" href="a00223_source.html#l01549">1549</a> of file <a class="el" href="a00223_source.html">operation.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="accd0dc05a16c25a96b3fad2c22834ccc"></a><!-- doxytag: member="frepple::OperationAlternate::addAlternate" ref="accd0dc05a16c25a96b3fad2c22834ccc" args="(Operation *, int=1, DateRange=DateRange())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::OperationAlternate::addAlternate </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">int </td>
<td class="paramname"> <em>prio</em> = <code>1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00050.html">DateRange</a> </td>
<td class="paramname"> <em>eff</em> = <code><a class="el" href="a00050.html">DateRange</a>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a new alternate operation.<br/>
The lower the priority value, the more important this alternate operation is. </p>
<p>Definition at line <a class="el" href="a00223_source.html#l01053">1053</a> of file <a class="el" href="a00223_source.html">operation.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a21d641b55fcac1c0be9e52df180056c9"></a><!-- doxytag: member="frepple::OperationAlternate::beginElement" ref="a21d641b55fcac1c0be9e52df180056c9" args="(XMLInput &, const Attribute &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::OperationAlternate::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="a00121.html#a1ea5ed57a9d9cf0ffd71db2c1122ecf5">frepple::Operation</a>.</p>
<p>Definition at line <a class="el" href="a00223_source.html#l01167">1167</a> of file <a class="el" href="a00223_source.html">operation.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa1a730f69090603825c925e332491b4c"></a><!-- doxytag: member="frepple::OperationAlternate::endElement" ref="aa1a730f69090603825c925e332491b4c" args="(XMLInput &, const Attribute &, const DataElement &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::OperationAlternate::endElement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00186.html">XMLInput</a> & </td>
<td class="paramname"> <em>pIn</em>, </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"> <em>pAttr</em>, </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"> <em>pElement</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>Reimplemented from <a class="el" href="a00121.html#aa201f6f1dd9d0194ac419345333a5a7f">frepple::Operation</a>.</p>
<p>Definition at line <a class="el" href="a00223_source.html#l01176">1176</a> of file <a class="el" href="a00223_source.html">operation.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a76ab3ec452cd87b5a3bc72af13454458"></a><!-- doxytag: member="frepple::OperationAlternate::extraInstantiate" ref="a76ab3ec452cd87b5a3bc72af13454458" args="(OperationPlan *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::OperationAlternate::extraInstantiate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00125.html">OperationPlan</a> * </td>
<td class="paramname"> <em>o</em></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extra logic to be used when instantiating an operationplan. </p>
<p>Reimplemented from <a class="el" href="a00121.html#a281dbc14aa516838b895c352bd388bda">frepple::Operation</a>.</p>
<p>Definition at line <a class="el" href="a00223_source.html#l01249">1249</a> of file <a class="el" href="a00223_source.html">operation.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aca0c41e63d37719114c08f1c0e709664"></a><!-- doxytag: member="frepple::OperationAlternate::getattro" ref="aca0c41e63d37719114c08f1c0e709664" args="(const Attribute &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PyObject * frepple::OperationAlternate::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="a00121.html#a0681225944aef2db5421e5a5f7f710c1">frepple::Operation</a>.</p>
<p>Definition at line <a class="el" href="a00223_source.html#l01519">1519</a> of file <a class="el" href="a00223_source.html">operation.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="afa54c209215c9841187cecfb0c9e2808"></a><!-- doxytag: member="frepple::OperationAlternate::getProperties" ref="afa54c209215c9841187cecfb0c9e2808" args="(Operation *o) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00122.html#a21276a85b32a20ee590af9e02445d5f8">OperationAlternate::alternateProperty</a> & frepple::OperationAlternate::getProperties </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> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the properties of a certain suboperation. </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>LogicException</em> </td><td>Generated when the argument operation is null or when it is not a sub-operation of this alternate. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00223_source.html#l01070">1070</a> of file <a class="el" href="a00223_source.html">operation.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9eee64d0bb881e81d0fe9ba7dbe05c66"></a><!-- doxytag: member="frepple::OperationAlternate::getSearch" ref="a9eee64d0bb881e81d0fe9ba7dbe05c66" 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::OperationAlternate::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#l02768">2768</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a859817e8336730b8912c2b867859e8f8"></a><!-- doxytag: member="frepple::OperationAlternate::getSize" ref="a859817e8336730b8912c2b867859e8f8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t frepple::OperationAlternate::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#l02799">2799</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a15e4ba08a35bb3a364e2f6ce2512f3c6"></a><!-- doxytag: member="frepple::OperationAlternate::getSubOperations" ref="a15e4ba08a35bb3a364e2f6ce2512f3c6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="a00121.html#ae5c93377f652a5bdb9ec20e6bee898e9">Operationlist</a>& frepple::OperationAlternate::getSubOperations </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a reference to the list of sub operations of this operation. </p>
<p>Reimplemented from <a class="el" href="a00121.html#adacfb6a7138a25e554e17da40f2c5438">frepple::Operation</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l02788">2788</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a909fec5736d2bd90dc6052aa8f4b7b94"></a><!-- doxytag: member="frepple::OperationAlternate::getType" ref="a909fec5736d2bd90dc6052aa8f4b7b94" 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::OperationAlternate::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#l02797">2797</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0fd492b1c7b1c0d52270bd77cde6ffef"></a><!-- doxytag: member="frepple::OperationAlternate::initialize" ref="a0fd492b1c7b1c0d52270bd77cde6ffef" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int frepple::OperationAlternate::initialize </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="a00121.html#ab5e2d2b189b10576cb3775b44e232f87">frepple::Operation</a>.</p>
<p>Definition at line <a class="el" href="a00223_source.html#l00077">77</a> of file <a class="el" href="a00223_source.html">operation.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8067158022e2bd145cc9dad06c4e685b"></a><!-- doxytag: member="frepple::OperationAlternate::removeSubOperation" ref="a8067158022e2bd145cc9dad06c4e685b" args="(Operation *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::OperationAlternate::removeSubOperation </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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes an alternate from the list. </p>
<p>Definition at line <a class="el" href="a00223_source.html#l01274">1274</a> of file <a class="el" href="a00223_source.html">operation.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4adc5f876e7f8719b61f27770e0ed4e0"></a><!-- doxytag: member="frepple::OperationAlternate::setattro" ref="a4adc5f876e7f8719b61f27770e0ed4e0" args="(const Attribute &, const PythonObject &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int frepple::OperationAlternate::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="a00121.html#a494bac93a19785d858ed4553eb444166">frepple::Operation</a>.</p>
<p>Definition at line <a class="el" href="a00223_source.html#l01539">1539</a> of file <a class="el" href="a00223_source.html">operation.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac5c3ebcb02f8d7b61ec15f2c0318c3c5"></a><!-- doxytag: member="frepple::OperationAlternate::setEffective" ref="ac5c3ebcb02f8d7b61ec15f2c0318c3c5" args="(Operation *, DateRange)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::OperationAlternate::setEffective </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="a00050.html">DateRange</a> </td>
<td class="paramname"> <em>dr</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the effective daterange of a certain suboperation. </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>Generated when the argument operation is not null and not a sub-operation of this alternate. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00223_source.html#l01106">1106</a> of file <a class="el" href="a00223_source.html">operation.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="affd8bc828a150f258619aec11c4559b0"></a><!-- doxytag: member="frepple::OperationAlternate::setOperationPlanParameters" ref="affd8bc828a150f258619aec11c4559b0" args="(OperationPlan *, double, Date, Date, bool=true, bool=true) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00127.html">OperationPlanState</a> frepple::OperationAlternate::setOperationPlanParameters </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00125.html">OperationPlan</a> * </td>
<td class="paramname"> <em>opplan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>q</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00049.html">Date</a> </td>
<td class="paramname"> <em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00049.html">Date</a> </td>
<td class="paramname"> <em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>preferEnd</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>execute</em> = <code>true</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>A operation of this type enforces the following rules on its operationplans:</p>
<ul>
<li>Very simple, call the method with the same name on the alternate suboperationplan. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00121.html#a744480cdd80e70a2b0a7606114e1ab73">Operation::setOperationPlanParameters</a> </dd></dl>
</li>
</ul>
<p>Implements <a class="el" href="a00121.html#a744480cdd80e70a2b0a7606114e1ab73">frepple::Operation</a>.</p>
<p>Definition at line <a class="el" href="a00223_source.html#l01218">1218</a> of file <a class="el" href="a00223_source.html">operation.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a552b0c104bec99d2bdeb153cf7189b8d"></a><!-- doxytag: member="frepple::OperationAlternate::setPriority" ref="a552b0c104bec99d2bdeb153cf7189b8d" args="(Operation *, int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::OperationAlternate::setPriority </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">int </td>
<td class="paramname"> <em>f</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the priority of a certain suboperation. </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>Generated when the argument operation is not null and not a sub-operation of this alternate. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00223_source.html#l01088">1088</a> of file <a class="el" href="a00223_source.html">operation.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a59b4283e24286d5b9d19671379eb4ecf"></a><!-- doxytag: member="frepple::OperationAlternate::setSearch" ref="a59b4283e24286d5b9d19671379eb4ecf" args="(const string a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::OperationAlternate::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#l02771">2771</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a09ed4c0ea12a06e628ef7b6313493b46"></a><!-- doxytag: member="frepple::OperationAlternate::solve" ref="a09ed4c0ea12a06e628ef7b6313493b46" args="(Solver &s, void *v=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void frepple::OperationAlternate::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="a00121.html#a15b6686fb03126fea6d5151a79aa5a91">frepple::Operation</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l02787">2787</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="abc8519120ca9ff5e0be1a65131751a09"></a><!-- doxytag: member="frepple::OperationAlternate::writeElement" ref="abc8519120ca9ff5e0be1a65131751a09" args="(XMLOutput *, const Keyword &, mode=DEFAULT) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::OperationAlternate::writeElement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00189.html">XMLOutput</a> * </td>
<td class="paramname"> <em>o</em>, </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"> <em>tag</em>, </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"> <em>m</em> = <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>Reimplemented from <a class="el" href="a00121.html#a3db91252184523fa8246064446d56b60">frepple::Operation</a>.</p>
<p>Definition at line <a class="el" href="a00223_source.html#l01125">1125</a> of file <a class="el" href="a00223_source.html">operation.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="af55e7f4c9ea99a222e7433756f001d4a"></a><!-- doxytag: member="frepple::OperationAlternate::metadata" ref="af55e7f4c9ea99a222e7433756f001d4a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00115.html">MetaClass</a> * <a class="el" href="a00122.html#af55e7f4c9ea99a222e7433756f001d4a">frepple::OperationAlternate::metadata</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="a00121.html#afcc9adf1a9c37fd168af778368601978">frepple::Operation</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l02798">2798</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="a00223_source.html">operation.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>
