<!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::OperationSetup 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="a00129.html">OperationSetup</a>
</div>
</div>
<div class="contents">
<h1>frepple::OperationSetup Class Reference</h1><!-- doxytag: class="frepple::OperationSetup" --><!-- doxytag: inherits="frepple::Operation" -->
<p>Models an operation to convert a setup on a resource.
<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::OperationSetup:</div>
<div class="dynsection">
<div class="center"><img src="a00473.png" border="0" usemap="#frepple_1_1_operation_setup_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_operation_setup_inherit__map" id="frepple_1_1_operation_setup_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="a00474.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">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00129.html#ad1469e3732050d17cf059b5f6edec20e">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="a00129.html#ad15c66eeacc7b40556c5f1f1793046f8">getType</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00129.html#a115a2310ed09327f4e750682a7c2433a">OperationSetup</a> (const string &s)</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="a00129.html#aa06543c742d743b48f916fb99beb3129">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">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00129.html#ab564880d276353f1634bf7e5eb870128">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="a00129.html#afcbe8d4db472da78e2f9391078173e6f">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 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="a00129.html#abfeacc412756b3ccb6707c371f683a29">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="a00129.html#a615531dcb5e0218ab36901655f4c6052">metadata</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="a00121.html">Operation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00129.html#add35ebccc253401c86cc40dc2fed3f04">setupoperation</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="a00129.html#af54ca844a39f7029fc056cabac4bfe7e">CommandErase</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Models an operation to convert a setup on a resource. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l02499">2499</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a115a2310ed09327f4e750682a7c2433a"></a><!-- doxytag: member="frepple::OperationSetup::OperationSetup" ref="a115a2310ed09327f4e750682a7c2433a" args="(const string &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::OperationSetup::OperationSetup </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>s</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#l02504">2504</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="ad1469e3732050d17cf059b5f6edec20e"></a><!-- doxytag: member="frepple::OperationSetup::getSize" ref="ad1469e3732050d17cf059b5f6edec20e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t frepple::OperationSetup::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#l02514">2514</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad15c66eeacc7b40556c5f1f1793046f8"></a><!-- doxytag: member="frepple::OperationSetup::getType" ref="ad15c66eeacc7b40556c5f1f1793046f8" 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::OperationSetup::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#l02512">2512</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="abfeacc412756b3ccb6707c371f683a29"></a><!-- doxytag: member="frepple::OperationSetup::initialize" ref="abfeacc412756b3ccb6707c371f683a29" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int frepple::OperationSetup::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#l00101">101</a> of file <a class="el" href="a00223_source.html">operation.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa06543c742d743b48f916fb99beb3129"></a><!-- doxytag: member="frepple::OperationSetup::setOperationPlanParameters" ref="aa06543c742d743b48f916fb99beb3129" 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::OperationSetup::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>The duration is calculated based on the conversion type. </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#l01298">1298</a> of file <a class="el" href="a00223_source.html">operation.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab564880d276353f1634bf7e5eb870128"></a><!-- doxytag: member="frepple::OperationSetup::solve" ref="ab564880d276353f1634bf7e5eb870128" args="(Solver &s, void *v=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void frepple::OperationSetup::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#l02510">2510</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="afcbe8d4db472da78e2f9391078173e6f"></a><!-- doxytag: member="frepple::OperationSetup::writeElement" ref="afcbe8d4db472da78e2f9391078173e6f" args="(XMLOutput *, const Keyword &, mode=DEFAULT) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::OperationSetup::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> [inline, 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="a00218_source.html#l02507">2507</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="af54ca844a39f7029fc056cabac4bfe7e"></a><!-- doxytag: member="frepple::OperationSetup::CommandErase" ref="af54ca844a39f7029fc056cabac4bfe7e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="a00028.html">CommandErase</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l02501">2501</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="a615531dcb5e0218ab36901655f4c6052"></a><!-- doxytag: member="frepple::OperationSetup::metadata" ref="a615531dcb5e0218ab36901655f4c6052" 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="a00129.html#a615531dcb5e0218ab36901655f4c6052">frepple::OperationSetup::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#l02513">2513</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="add35ebccc253401c86cc40dc2fed3f04"></a><!-- doxytag: member="frepple::OperationSetup::setupoperation" ref="add35ebccc253401c86cc40dc2fed3f04" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00121.html">Operation</a> * <a class="el" href="a00129.html#add35ebccc253401c86cc40dc2fed3f04">frepple::OperationSetup::setupoperation</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A pointer to the operation that is instantiated for all conversions. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l02525">2525</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>
