<!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::CommandCreateOperationPlan 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="a00026.html">CommandCreateOperationPlan</a>
</div>
</div>
<div class="contents">
<h1>frepple::CommandCreateOperationPlan Class Reference</h1><!-- doxytag: class="frepple::CommandCreateOperationPlan" --><!-- doxytag: inherits="frepple::utils::Command" -->
<p>This command is used to create an operationplan.
<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::CommandCreateOperationPlan:</div>
<div class="dynsection">
<div class="center"><img src="a00384.png" border="0" usemap="#frepple_1_1_command_create_operation_plan_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_command_create_operation_plan_inherit__map" id="frepple_1_1_command_create_operation_plan_inherit__map">
<area shape="rect" id="node2" href="a00025.html" title="Abstract base class for all commands." alt="" coords="49,6,207,34"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00385.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#ab87d11f02e5984c871c628600ea007e4">CommandCreateOperationPlan</a> (const <a class="el" href="a00121.html">Operation</a> *o, double q, <a class="el" href="a00049.html">Date</a> d1, <a class="el" href="a00049.html">Date</a> d2, <a class="el" href="a00051.html">Demand</a> *l, <a class="el" href="a00125.html">OperationPlan</a> *ow=NULL, bool makeflowsloads=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a1c7b585fd6bc89384ea7f629af47946b">execute</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00125.html">OperationPlan</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#ab1a9489e2182059cebf9d0fc1606d83d">getOperationPlan</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a306ddae494588b4a394ff3b84fa7e236">undo</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a5523d0eb49970e2d10899f3b1289f0db">undoable</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a7b4eeeedcedd2bbf2ed3996fcaf2e013">~CommandCreateOperationPlan</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This command is used to create an operationplan. </p>
<p>The operationplan will have its load and loadplans created when the command is created. It is assigned an id and added to the list of all operationplans when the command is committed. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05436">5436</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab87d11f02e5984c871c628600ea007e4"></a><!-- doxytag: member="frepple::CommandCreateOperationPlan::CommandCreateOperationPlan" ref="ab87d11f02e5984c871c628600ea007e4" args="(const Operation *o, double q, Date d1, Date d2, Demand *l, OperationPlan *ow=NULL, bool makeflowsloads=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::CommandCreateOperationPlan::CommandCreateOperationPlan </td>
<td>(</td>
<td class="paramtype">const <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">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>d1</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>d2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00051.html">Demand</a> * </td>
<td class="paramname"> <em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00125.html">OperationPlan</a> * </td>
<td class="paramname"> <em>ow</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>makeflowsloads</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05441">5441</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7b4eeeedcedd2bbf2ed3996fcaf2e013"></a><!-- doxytag: member="frepple::CommandCreateOperationPlan::~CommandCreateOperationPlan" ref="a7b4eeeedcedd2bbf2ed3996fcaf2e013" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::CommandCreateOperationPlan::~CommandCreateOperationPlan </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l05458">5458</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="a1c7b585fd6bc89384ea7f629af47946b"></a><!-- doxytag: member="frepple::CommandCreateOperationPlan::execute" ref="a1c7b585fd6bc89384ea7f629af47946b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::CommandCreateOperationPlan::execute </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is used to actually execute the action.<br/>
A couple of notes on how this method should be implemented by the subclasses:</p>
<ul>
<li>Calling the method multiple times is harmless and results in the same state change as calling it only once. </li>
</ul>
<p>Implements <a class="el" href="a00025.html#acc6f6bc4f9a9ce8cfa2de41fd12f3024">frepple::utils::Command</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l05448">5448</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab1a9489e2182059cebf9d0fc1606d83d"></a><!-- doxytag: member="frepple::CommandCreateOperationPlan::getOperationPlan" ref="ab1a9489e2182059cebf9d0fc1606d83d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00125.html">OperationPlan</a>* frepple::CommandCreateOperationPlan::getOperationPlan </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l05459">5459</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a306ddae494588b4a394ff3b84fa7e236"></a><!-- doxytag: member="frepple::CommandCreateOperationPlan::undo" ref="a306ddae494588b4a394ff3b84fa7e236" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::CommandCreateOperationPlan::undo </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is undoing the state change of the <a class="el" href="a00026.html#a1c7b585fd6bc89384ea7f629af47946b">execute()</a> method.<br/>
Reversing the action is not possible for all commands. Command subclasses should override the <a class="el" href="a00026.html#a306ddae494588b4a394ff3b84fa7e236">undo()</a> and <a class="el" href="a00026.html#a5523d0eb49970e2d10899f3b1289f0db">undoable()</a> method in case they are reversible.<br/>
A couple of notes on how this method should be implemented by the subclasses:</p>
<ul>
<li>Calling the <a class="el" href="a00026.html#a306ddae494588b4a394ff3b84fa7e236">undo()</a> method is harmless if the <a class="el" href="a00026.html#a1c7b585fd6bc89384ea7f629af47946b">execute()</a> hasn't been called yet.</li>
<li>Calling the <a class="el" href="a00026.html#a306ddae494588b4a394ff3b84fa7e236">undo()</a> method multiple times is harmless and results in the same state change as calling it only once. </li>
</ul>
<p>Reimplemented from <a class="el" href="a00025.html#a908c201250c653dad3c93f1df886b3fc">frepple::utils::Command</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l05456">5456</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5523d0eb49970e2d10899f3b1289f0db"></a><!-- doxytag: member="frepple::CommandCreateOperationPlan::undoable" ref="a5523d0eb49970e2d10899f3b1289f0db" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::CommandCreateOperationPlan::undoable </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the execution of this command can be undone. </p>
<p>Reimplemented from <a class="el" href="a00025.html#aebd560086e9d6e041a9d5d0fd3d38364">frepple::utils::Command</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l05457">5457</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 file:<ul>
<li><a class="el" href="a00218_source.html">model.h</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>
