Represents a routing operation, i.e. an operation consisting of multiple, sequential sub-operations. More...
#include <model.h>

Public Member Functions | |
void | addStepBack (Operation *o) |
void | addStepFront (Operation *o) |
void | beginElement (XMLInput &, const Attribute &) |
void | endElement (XMLInput &, const Attribute &, const DataElement &) |
virtual PyObject * | getattro (const Attribute &) |
virtual size_t | getSize () const |
virtual const Operationlist & | getSubOperations () const |
virtual const MetaClass & | getType () const |
OperationRouting (const string &c) | |
void | removeSubOperation (Operation *o) |
OperationPlanState | setOperationPlanParameters (OperationPlan *, double, Date, Date, bool=true, bool=true) const |
virtual void | solve (Solver &s, void *v=NULL) const |
virtual void | writeElement (XMLOutput *, const Keyword &, mode=DEFAULT) const |
~OperationRouting () | |
Static Public Member Functions | |
static PyObject * | addStep (PyObject *, PyObject *) |
static int | initialize () |
Static Public Attributes | |
static const MetaClass * | metadata |
Protected Member Functions | |
virtual bool | extraInstantiate (OperationPlan *o) |
Detailed Description
Represents a routing operation, i.e. an operation consisting of multiple, sequential sub-operations.
Constructor & Destructor Documentation
frepple::OperationRouting::OperationRouting | ( | const string & | c | ) | [inline, explicit] |
frepple::OperationRouting::~OperationRouting | ( | ) |
Destructor.
Definition at line 147 of file operation.cpp.
Member Function Documentation
PyObject * frepple::OperationRouting::addStep | ( | PyObject * | self, |
PyObject * | args | ||
) | [static] |
Add one or more steps to a routing.
Definition at line 1607 of file operation.cpp.
void frepple::OperationRouting::addStepBack | ( | Operation * | o | ) | [inline] |
void frepple::OperationRouting::addStepFront | ( | Operation * | o | ) | [inline] |
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::Operation.
Definition at line 916 of file operation.cpp.
void frepple::OperationRouting::endElement | ( | XMLInput & | pIn, |
const Attribute & | pAttr, | ||
const DataElement & | pElement | ||
) | [virtual] |
Reimplemented from frepple::Operation.
Definition at line 925 of file operation.cpp.
bool frepple::OperationRouting::extraInstantiate | ( | OperationPlan * | o | ) | [protected, virtual] |
Extra logic to be used when instantiating an operationplan.
Reimplemented from frepple::Operation.
Definition at line 1004 of file operation.cpp.
PyObject * frepple::OperationRouting::getattro | ( | const Attribute & | attr | ) | [virtual] |
Default getattro method.
Subclasses are expected to implement an override if the type supports gettattro.
Reimplemented from frepple::Operation.
Definition at line 1593 of file operation.cpp.
virtual size_t frepple::OperationRouting::getSize | ( | ) | const [inline, virtual] |
Return the memory size of the object in bytes.
Implements frepple::utils::Object.
virtual const Operationlist& frepple::OperationRouting::getSubOperations | ( | ) | const [inline, virtual] |
Return a list of all sub-operationplans.
Reimplemented from frepple::Operation.
virtual const MetaClass& frepple::OperationRouting::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.
int frepple::OperationRouting::initialize | ( | ) | [static] |
Reimplemented from frepple::Operation.
Definition at line 89 of file operation.cpp.
void frepple::OperationRouting::removeSubOperation | ( | Operation * | o | ) | [inline, virtual] |
Remove a step from a routing.
Reimplemented from frepple::Operation.
OperationPlanState frepple::OperationRouting::setOperationPlanParameters | ( | OperationPlan * | opplan, |
double | q, | ||
Date | s, | ||
Date | e, | ||
bool | preferEnd = true , |
||
bool | execute = true |
||
) | const [virtual] |
A operation of this type enforces the following rules on its operationplans:
- If an end date is given, sequentially use this method on the different steps. The steps are stepped through starting from the last step, and each step will adjust to meet the requested end date. If there is slack between the routings' step operationplans, it can be used to "absorb" the change.
- When a start date is given, the behavior is similar to the previous case, except that we step through the operationplans from the first step this time.
- If both a start and an end date are given, we use only the end date.
- If there are no sub operationplans yet, apply the requested changes blindly.
Implements frepple::Operation.
Definition at line 939 of file operation.cpp.
virtual void frepple::OperationRouting::solve | ( | Solver & | s, |
void * | v = NULL |
||
) | const [inline, virtual] |
This method is called by solver classes. The implementation of this class simply calls the solve method on the solver class. Using the polymorphism the solver can implement seperate methods for different plannable subclasses.
Reimplemented from frepple::Operation.
void frepple::OperationRouting::writeElement | ( | XMLOutput * | o, |
const Keyword & | tag, | ||
mode | m = DEFAULT |
||
) | const [virtual] |
Reimplemented from frepple::Operation.
Definition at line 889 of file operation.cpp.
Member Data Documentation
const MetaClass * frepple::OperationRouting::metadata [static] |
Reimplemented from frepple::Operation.
The documentation for this class was generated from the following files:
Documentation generated for frePPLe by
