frepple::CommandSolve Class Reference
This command runs a specific solver. More...
#include <model.h>
Public Member Functions | |
| void | beginElement (XMLInput &, const Attribute &) |
| CommandSolve () | |
| void | endElement (XMLInput &, const Attribute &, const DataElement &) |
| void | execute () |
| string | getDescription () const |
| virtual size_t | getSize () const |
| Solver * | getSolver () const |
| virtual const MetaClass & | getType () const |
| void | setSolver (Solver *s) |
| void | undo () |
| bool | undoable () const |
Static Public Attributes | |
| static const MetaClass | metadata |
Detailed Description
This command runs a specific solver.Definition at line 1039 of file model.h.
Constructor & Destructor Documentation
| frepple::CommandSolve::CommandSolve | ( | ) | [inline] |
Member Function Documentation
Called while restoring the model from an XML-file. This is called for each element within the "this" element, for which the "this" element is immediate parent. It is called when the open element tag is encountered.
Reimplemented from frepple::utils::Object.
Definition at line 39 of file model/actions.cpp.
| void frepple::CommandSolve::endElement | ( | XMLInput & | , | |
| const Attribute & | , | |||
| const DataElement & | ||||
| ) | [virtual] |
Called while restoring the model from an XML-file. This is called when the corresponding close element tag is encountered, and the Data() member of pElement is also valid. NOTE: each object receives both its own beginElement so it can process its own element tag attributes, and its own endElement so it can process its own character data.
Reimplemented from frepple::utils::Command.
Definition at line 46 of file model/actions.cpp.
| void frepple::CommandSolve::execute | ( | ) | [virtual] |
The core of the execute method is a call to the solve() method of the solver.
Implements frepple::utils::Command.
Definition at line 59 of file model/actions.cpp.
| string frepple::CommandSolve::getDescription | ( | ) | const [inline, virtual] |
| virtual size_t frepple::CommandSolve::getSize | ( | ) | const [inline, virtual] |
Return the memory size of the object in bytes.
Implements frepple::utils::Object.
| Solver* frepple::CommandSolve::getSolver | ( | ) | const [inline] |
| virtual const MetaClass& frepple::CommandSolve::getType | ( | ) | const [inline, virtual] |
This returns the type information on the object, a bit similar to the standard type_info information.
Implements frepple::utils::Object.
| void frepple::CommandSolve::setSolver | ( | Solver * | s | ) | [inline] |
| void frepple::CommandSolve::undo | ( | ) | [inline, virtual] |
This type of command can't be undone.
Reimplemented from frepple::utils::Command.
| bool frepple::CommandSolve::undoable | ( | ) | const [inline, virtual] |
Running a solver can't be undone.
Reimplemented from frepple::utils::Command.
Member Data Documentation
const MetaClass frepple::CommandSolve::metadata [static] |
The documentation for this class was generated from the following files:
Documentation generated by
