frepple::CommandCreateOperationPlan Class Reference

This command is used to create an operationplan. More...

#include <model.h>

Inheritance diagram for frepple::CommandCreateOperationPlan:
frepple::utils::Command

List of all members.

Public Member Functions

 CommandCreateOperationPlan (const Operation *o, double q, Date d1, Date d2, Demand *l, OperationPlan *ow=NULL, bool makeflowsloads=true)
void execute ()
string getDescription () const
OperationPlangetOperationPlan () const
void undo ()
bool undoable () const
 ~CommandCreateOperationPlan ()

Detailed Description

This command is used to create an operationplan.

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.

Definition at line 4805 of file model.h.


Constructor & Destructor Documentation

frepple::CommandCreateOperationPlan::CommandCreateOperationPlan ( const Operation o,
double  q,
Date  d1,
Date  d2,
Demand l,
OperationPlan ow = NULL,
bool  makeflowsloads = true 
) [inline]

Constructor.

Definition at line 4810 of file model.h.

frepple::CommandCreateOperationPlan::~CommandCreateOperationPlan (  )  [inline]

Definition at line 4827 of file model.h.


Member Function Documentation

void frepple::CommandCreateOperationPlan::execute (  )  [inline, virtual]

This method is used to actually execute the action.
A couple of notes on how this method should be implemented by the subclasses:

  • Calling the method multiple times is harmless and results in the same state change as calling it only once.

Implements frepple::utils::Command.

Definition at line 4817 of file model.h.

string frepple::CommandCreateOperationPlan::getDescription (  )  const [inline, virtual]

Reimplemented from frepple::utils::Command.

Definition at line 4829 of file model.h.

OperationPlan* frepple::CommandCreateOperationPlan::getOperationPlan (  )  const [inline]

Definition at line 4828 of file model.h.

void frepple::CommandCreateOperationPlan::undo (  )  [inline, virtual]

This method is undoing the state change of the execute() method.
Reversing the action is not possible for all commands. Command subclasses should override the undo() and undoable() method in case they are reversible.
A couple of notes on how this method should be implemented by the subclasses:

  • Calling the undo() method is harmless if the execute() hasn't been called yet.
  • Calling the undo() method multiple times is harmless and results in the same state change as calling it only once.

Reimplemented from frepple::utils::Command.

Definition at line 4825 of file model.h.

bool frepple::CommandCreateOperationPlan::undoable (  )  const [inline, virtual]

Returns true if the execution of this command can be undone.

Reimplemented from frepple::utils::Command.

Definition at line 4826 of file model.h.


The documentation for this class was generated from the following file:

Generated on 25 Sep 2009 for frePPLe by  doxygen 1.6.1