frepple::CommandSavePlan Class Reference
This command writes the dynamic part of the plan to an text file. More...
#include <model.h>

Public Member Functions | |
CommandSavePlan (const string &v="plan.out") | |
void | execute () |
string | getFileName () const |
void | setFileName (const string &v) |
Static Public Member Functions | |
static PyObject * | executePython (PyObject *, PyObject *) |
Detailed Description
This command writes the dynamic part of the plan to an text file.
This saved information covers the buffer flowplans, operationplans, resource loading, demand, problems, etc...
The main use of this function is in the test suite: a simple text file comparison allows us to identify changes quickly. The output format is only to be seen in this context of testing, and is not intended to be used as an official method for publishing plans to other systems.
The data file is written by the execute() function.
- See also:
- CommandSave
Definition at line 4496 of file model.h.
Constructor & Destructor Documentation
frepple::CommandSavePlan::CommandSavePlan | ( | const string & | v = "plan.out" |
) | [inline] |
Member Function Documentation
void frepple::CommandSavePlan::execute | ( | ) | [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 209 of file model/actions.cpp.
PyObject * frepple::CommandSavePlan::executePython | ( | PyObject * | self, | |
PyObject * | args | |||
) | [static] |
Python interface to this command.
Definition at line 337 of file model/actions.cpp.
string frepple::CommandSavePlan::getFileName | ( | ) | const [inline] |
void frepple::CommandSavePlan::setFileName | ( | const string & | v | ) | [inline] |
The documentation for this class was generated from the following files:
Documentation generated for frePPLe by
