This class represents a choice between multiple operations. The alternates are sorted in order of priority. More...
#include <model.h>

Public Types | |
typedef pair< int, DateRange > | alternateProperty |
Public Member Functions | |
void | addAlternate (Operation *, int=1, DateRange=DateRange()) |
void | beginElement (XMLInput &, const Attribute &) |
void | endElement (XMLInput &, const Attribute &, const DataElement &) |
virtual PyObject * | getattro (const Attribute &) |
const alternateProperty & | getProperties (Operation *o) const |
SearchMode | getSearch () const |
virtual size_t | getSize () const |
virtual const Operationlist & | getSubOperations () const |
virtual const MetaClass & | getType () const |
OperationAlternate (const string &c) | |
void | removeSubOperation (Operation *) |
virtual int | setattro (const Attribute &, const PythonObject &) |
void | setEffective (Operation *, DateRange) |
OperationPlanState | setOperationPlanParameters (OperationPlan *, double, Date, Date, bool=true, bool=true) const |
void | setPriority (Operation *, int) |
void | setSearch (const string a) |
virtual void | solve (Solver &s, void *v=NULL) const |
void | writeElement (XMLOutput *, const Keyword &, mode=DEFAULT) const |
~OperationAlternate () | |
Static Public Member Functions | |
static PyObject * | addAlternate (PyObject *, PyObject *, PyObject *) |
static int | initialize () |
Static Public Attributes | |
static const MetaClass * | metadata |
Protected Member Functions | |
virtual bool | extraInstantiate (OperationPlan *o) |
Detailed Description
This class represents a choice between multiple operations. The alternates are sorted in order of priority.
Member Typedef Documentation
typedef pair<int,DateRange> frepple::OperationAlternate::alternateProperty |
Constructor & Destructor Documentation
frepple::OperationAlternate::OperationAlternate | ( | const string & | c | ) | [inline, explicit] |
frepple::OperationAlternate::~OperationAlternate | ( | ) |
Destructor.
Definition at line 157 of file operation.cpp.
Member Function Documentation
void frepple::OperationAlternate::addAlternate | ( | Operation * | o, |
int | prio = 1 , |
||
DateRange | eff = DateRange() |
||
) |
Add a new alternate operation.
The lower the priority value, the more important this alternate operation is.
Definition at line 1053 of file operation.cpp.
PyObject * frepple::OperationAlternate::addAlternate | ( | PyObject * | self, |
PyObject * | args, | ||
PyObject * | kwdict | ||
) | [static] |
Add an alternate to the operation.
The keyword arguments are "operation", "priority", "effective_start" and "effective_end"
Definition at line 1549 of file operation.cpp.
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 1167 of file operation.cpp.
void frepple::OperationAlternate::endElement | ( | XMLInput & | pIn, |
const Attribute & | pAttr, | ||
const DataElement & | pElement | ||
) | [virtual] |
Reimplemented from frepple::Operation.
Definition at line 1176 of file operation.cpp.
bool frepple::OperationAlternate::extraInstantiate | ( | OperationPlan * | o | ) | [protected, virtual] |
Extra logic to be used when instantiating an operationplan.
Reimplemented from frepple::Operation.
Definition at line 1249 of file operation.cpp.
PyObject * frepple::OperationAlternate::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 1519 of file operation.cpp.
const OperationAlternate::alternateProperty & frepple::OperationAlternate::getProperties | ( | Operation * | o | ) | const |
Returns the properties of a certain suboperation.
- Exceptions:
-
LogicException Generated when the argument operation is null or when it is not a sub-operation of this alternate.
Definition at line 1070 of file operation.cpp.
SearchMode frepple::OperationAlternate::getSearch | ( | ) | const [inline] |
virtual size_t frepple::OperationAlternate::getSize | ( | ) | const [inline, virtual] |
Return the memory size of the object in bytes.
Implements frepple::utils::Object.
virtual const Operationlist& frepple::OperationAlternate::getSubOperations | ( | ) | const [inline, virtual] |
Returns a reference to the list of sub operations of this operation.
Reimplemented from frepple::Operation.
virtual const MetaClass& frepple::OperationAlternate::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::OperationAlternate::initialize | ( | ) | [static] |
Reimplemented from frepple::Operation.
Definition at line 77 of file operation.cpp.
void frepple::OperationAlternate::removeSubOperation | ( | Operation * | o | ) | [virtual] |
Removes an alternate from the list.
Reimplemented from frepple::Operation.
Definition at line 1274 of file operation.cpp.
int frepple::OperationAlternate::setattro | ( | const Attribute & | attr, |
const PythonObject & | field | ||
) | [virtual] |
Default setattro method.
Subclasses are expected to implement an override if the type supports settattro.
Reimplemented from frepple::Operation.
Definition at line 1539 of file operation.cpp.
Updates the effective daterange of a certain suboperation.
- Exceptions:
-
DataException Generated when the argument operation is not null and not a sub-operation of this alternate.
Definition at line 1106 of file operation.cpp.
OperationPlanState frepple::OperationAlternate::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:
- Very simple, call the method with the same name on the alternate suboperationplan.
Implements frepple::Operation.
Definition at line 1218 of file operation.cpp.
void frepple::OperationAlternate::setPriority | ( | Operation * | o, |
int | f | ||
) |
Updates the priority of a certain suboperation.
- Exceptions:
-
DataException Generated when the argument operation is not null and not a sub-operation of this alternate.
Definition at line 1088 of file operation.cpp.
void frepple::OperationAlternate::setSearch | ( | const string | a | ) | [inline] |
virtual void frepple::OperationAlternate::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::OperationAlternate::writeElement | ( | XMLOutput * | o, |
const Keyword & | tag, | ||
mode | m = DEFAULT |
||
) | const [virtual] |
Reimplemented from frepple::Operation.
Definition at line 1125 of file operation.cpp.
Member Data Documentation
const MetaClass * frepple::OperationAlternate::metadata [static] |
Reimplemented from frepple::Operation.
The documentation for this class was generated from the following files:
Documentation generated for frePPLe by
