frepple::CommandSavePlan Class Reference

This command writes the dynamic part of the plan to an text file. More...

#include <model.h>

Inheritance diagram for frepple::CommandSavePlan:
frepple::utils::Command

List of all members.

Public Member Functions

 CommandSavePlan (const string &v="plan.out")
void endElement (XMLInput &, const Attribute &, const DataElement &)
void execute ()
string getDescription () const
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 3896 of file model.h.


Constructor & Destructor Documentation

frepple::CommandSavePlan::CommandSavePlan ( const string &  v = "plan.out"  )  [inline]

Definition at line 3899 of file model.h.


Member Function Documentation

void frepple::CommandSavePlan::endElement ( XMLInput ,
const Attribute ,
const DataElement  
)
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 305 of file model/actions.cpp.

PyObject * frepple::CommandSavePlan::executePython ( PyObject *  self,
PyObject *  args 
) [static]

Python interface to this command.

Definition at line 418 of file model/actions.cpp.

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

Reimplemented from frepple::utils::Command.

Definition at line 3908 of file model.h.

string frepple::CommandSavePlan::getFileName (  )  const [inline]

Definition at line 3900 of file model.h.

void frepple::CommandSavePlan::setFileName ( const string &  v  )  [inline]

Definition at line 3901 of file model.h.


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

Generated on 25 Sep 2009 for frePPLe by  doxygen 1.6.1