Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 54cac1c2268db633d66eeff1b4faa585 > files > 307

frepple-doc-0.8.1-3.fc15.noarch.rpm

<!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::CommandMoveOperationPlan 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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00256.html">frepple</a>::<a class="el" href="a00031.html">CommandMoveOperationPlan</a>
  </div>
</div>
<div class="contents">
<h1>frepple::CommandMoveOperationPlan Class Reference</h1><!-- doxytag: class="frepple::CommandMoveOperationPlan" --><!-- doxytag: inherits="frepple::utils::Command" -->
<p>This class represents the command of moving an operationplan to a new date and/or resizing it.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00218_source.html">model.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for frepple::CommandMoveOperationPlan:</div>
<div class="dynsection">
<div class="center"><img src="a00390.png" border="0" usemap="#frepple_1_1_command_move_operation_plan_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_command_move_operation_plan_inherit__map" id="frepple_1_1_command_move_operation_plan_inherit__map">
<area shape="rect" id="node2" href="a00025.html" title="Abstract base class for all commands." alt="" coords="45,6,203,34"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="a00391.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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a0c856e35f463c32d26bd26327885aa40">CommandMoveOperationPlan</a> (<a class="el" href="a00125.html">OperationPlan</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ae3154a29d69516b1c08f27e637b64c21">CommandMoveOperationPlan</a> (<a class="el" href="a00125.html">OperationPlan</a> *opplanptr, <a class="el" href="a00049.html">Date</a> newStart, <a class="el" href="a00049.html">Date</a> newEnd, double newQty=-1.0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a8da9c2bd183a47ad8e097fc2569c6a8e">execute</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00050.html">DateRange</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ac9ae1e2a6045e733b7826945b4b359fb">getDates</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00125.html">OperationPlan</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#aed800055c540394592b70f71fd181f76">getOperationPlan</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a6fbcfb81bfb58a7e9fee1de9a3c3dcd2">getQuantity</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#aa3f261e74bc7774cb5a8cc1348ec519e">restore</a> (bool=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a1572446f115ffd43ec6ed7ae31ee12ba">setEnd</a> (<a class="el" href="a00049.html">Date</a> d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ab088d3fb1d461db0f17072d901cb49aa">setParameters</a> (<a class="el" href="a00049.html">Date</a> s, <a class="el" href="a00049.html">Date</a> e, double q, bool b)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a22222c5789a84b497b85e4aed50b9b57">setQuantity</a> (double q)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a34d5478a29e5c4f0a931ef008e3e4308">setStart</a> (<a class="el" href="a00049.html">Date</a> d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a2674871def5e3089021e4c3c5e961f82">undo</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ad47b81f12781c562979a30b54a806426">undoable</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#aec7453f44faa6cc5d5233946674045e2">~CommandMoveOperationPlan</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class represents the command of moving an operationplan to a new date and/or resizing it. </p>

<p>Definition at line <a class="el" href="a00218_source.html#l05510">5510</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae3154a29d69516b1c08f27e637b64c21"></a><!-- doxytag: member="frepple::CommandMoveOperationPlan::CommandMoveOperationPlan" ref="ae3154a29d69516b1c08f27e637b64c21" args="(OperationPlan *opplanptr, Date newStart, Date newEnd, double newQty=&#45;1.0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::CommandMoveOperationPlan::CommandMoveOperationPlan </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00125.html">OperationPlan</a> *&nbsp;</td>
          <td class="paramname"> <em>opplanptr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00049.html">Date</a>&nbsp;</td>
          <td class="paramname"> <em>newStart</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00049.html">Date</a>&nbsp;</td>
          <td class="paramname"> <em>newEnd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>newQty</em> = <code>-1.0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor.<br/>
 Unlike most other commands the constructor already executes the change. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>opplanptr</em>&nbsp;</td><td>Pointer to the operationplan being moved. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>newStart</em>&nbsp;</td><td>New start date of the operationplan. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>newEnd</em>&nbsp;</td><td>New end date of the operationplan. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>newQty</em>&nbsp;</td><td>New quantity of the operationplan.The default is -1, which indicates to leave the quantity unchanged. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="a00192_source.html#l00392">392</a> of file <a class="el" href="a00192_source.html">model/actions.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a0c856e35f463c32d26bd26327885aa40"></a><!-- doxytag: member="frepple::CommandMoveOperationPlan::CommandMoveOperationPlan" ref="a0c856e35f463c32d26bd26327885aa40" args="(OperationPlan *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::CommandMoveOperationPlan::CommandMoveOperationPlan </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00125.html">OperationPlan</a> *&nbsp;</td>
          <td class="paramname"> <em>o</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default constructor. </p>

<p>Definition at line <a class="el" href="a00192_source.html#l00365">365</a> of file <a class="el" href="a00192_source.html">model/actions.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="aec7453f44faa6cc5d5233946674045e2"></a><!-- doxytag: member="frepple::CommandMoveOperationPlan::~CommandMoveOperationPlan" ref="aec7453f44faa6cc5d5233946674045e2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::CommandMoveOperationPlan::~CommandMoveOperationPlan </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Destructor. </p>

<p>Definition at line <a class="el" href="a00218_source.html#l05539">5539</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="a8da9c2bd183a47ad8e097fc2569c6a8e"></a><!-- doxytag: member="frepple::CommandMoveOperationPlan::execute" ref="a8da9c2bd183a47ad8e097fc2569c6a8e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::CommandMoveOperationPlan::execute </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Commit the changes. </p>

<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#l05528">5528</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="ac9ae1e2a6045e733b7826945b4b359fb"></a><!-- doxytag: member="frepple::CommandMoveOperationPlan::getDates" ref="ac9ae1e2a6045e733b7826945b4b359fb" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00050.html">DateRange</a> frepple::CommandMoveOperationPlan::getDates </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the dates of the original operationplan. </p>

<p>Definition at line <a class="el" href="a00218_source.html#l05565">5565</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="aed800055c540394592b70f71fd181f76"></a><!-- doxytag: member="frepple::CommandMoveOperationPlan::getOperationPlan" ref="aed800055c540394592b70f71fd181f76" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00125.html">OperationPlan</a>* frepple::CommandMoveOperationPlan::getOperationPlan </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the operationplan being manipulated. </p>

<p>Definition at line <a class="el" href="a00218_source.html#l05542">5542</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a6fbcfb81bfb58a7e9fee1de9a3c3dcd2"></a><!-- doxytag: member="frepple::CommandMoveOperationPlan::getQuantity" ref="a6fbcfb81bfb58a7e9fee1de9a3c3dcd2" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double frepple::CommandMoveOperationPlan::getQuantity </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the quantity of the original operationplan. </p>

<p>Definition at line <a class="el" href="a00218_source.html#l05562">5562</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="aa3f261e74bc7774cb5a8cc1348ec519e"></a><!-- doxytag: member="frepple::CommandMoveOperationPlan::restore" ref="aa3f261e74bc7774cb5a8cc1348ec519e" args="(bool=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::CommandMoveOperationPlan::restore </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>del</em> = <code>false</code></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Undo the changes. </p>

<p>Definition at line <a class="el" href="a00192_source.html#l00424">424</a> of file <a class="el" href="a00192_source.html">model/actions.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a1572446f115ffd43ec6ed7ae31ee12ba"></a><!-- doxytag: member="frepple::CommandMoveOperationPlan::setEnd" ref="a1572446f115ffd43ec6ed7ae31ee12ba" args="(Date d)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::CommandMoveOperationPlan::setEnd </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00049.html">Date</a>&nbsp;</td>
          <td class="paramname"> <em>d</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set another start date for the operationplan. </p>

<p>Definition at line <a class="el" href="a00218_source.html#l05556">5556</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="ab088d3fb1d461db0f17072d901cb49aa"></a><!-- doxytag: member="frepple::CommandMoveOperationPlan::setParameters" ref="ab088d3fb1d461db0f17072d901cb49aa" args="(Date s, Date e, double q, bool b)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::CommandMoveOperationPlan::setParameters </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00049.html">Date</a>&nbsp;</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>&nbsp;</td>
          <td class="paramname"> <em>e</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>q</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>b</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set another start date, end date and quantity for the operationplan. </p>

<p>Definition at line <a class="el" href="a00218_source.html#l05548">5548</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a22222c5789a84b497b85e4aed50b9b57"></a><!-- doxytag: member="frepple::CommandMoveOperationPlan::setQuantity" ref="a22222c5789a84b497b85e4aed50b9b57" args="(double q)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::CommandMoveOperationPlan::setQuantity </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>q</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set another quantity for the operationplan. </p>

<p>Definition at line <a class="el" href="a00218_source.html#l05559">5559</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a34d5478a29e5c4f0a931ef008e3e4308"></a><!-- doxytag: member="frepple::CommandMoveOperationPlan::setStart" ref="a34d5478a29e5c4f0a931ef008e3e4308" args="(Date d)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::CommandMoveOperationPlan::setStart </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00049.html">Date</a>&nbsp;</td>
          <td class="paramname"> <em>d</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set another start date for the operationplan. </p>

<p>Definition at line <a class="el" href="a00218_source.html#l05545">5545</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a2674871def5e3089021e4c3c5e961f82"></a><!-- doxytag: member="frepple::CommandMoveOperationPlan::undo" ref="a2674871def5e3089021e4c3c5e961f82" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::CommandMoveOperationPlan::undo </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Undo the changes. </p>

<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#l05531">5531</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="ad47b81f12781c562979a30b54a806426"></a><!-- doxytag: member="frepple::CommandMoveOperationPlan::undoable" ref="ad47b81f12781c562979a30b54a806426" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::CommandMoveOperationPlan::undoable </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</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#l05536">5536</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="a00192_source.html">model/actions.cpp</a></li>
</ul>
</div>
<hr size="1"/><address style="align: right;"><small>Documentation generated for frePPLe by&nbsp;
<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>