frepple::LoadPlan Class Reference
This class represents the resource capacity of an operationplan. More...
#include <model.h>
Public Member Functions | |
| PyObject * | getattro (const Attribute &) |
| bool | getHidden () const |
| const Load * | getLoad () const |
| OperationPlan * | getOperationPlan () const |
| LoadPlan * | getOtherLoadPlan () const |
| const Resource * | getResource () const |
| const string & | getSetup (bool=true) const |
| TimeLine< LoadPlan > * | getTimeLine () const |
| bool | isStart () const |
| LoadPlan (OperationPlan *, const Load *) | |
| void | setLoad (const Load *) |
| void | update () |
| virtual | ~LoadPlan () |
Static Public Member Functions | |
| static int | initialize () |
Static Public Attributes | |
| static const MetaCategory * | metadata |
Friends | |
| class | OperationPlan::LoadPlanIterator |
Detailed Description
This class represents the resource capacity of an operationplan.
For both the start and the end date of the operationplan, a loadplan object is created. These are then inserted in the timeline structure associated with a resource.
Definition at line 4803 of file model.h.
Constructor & Destructor Documentation
| frepple::LoadPlan::LoadPlan | ( | OperationPlan * | o, | |
| const Load * | r | |||
| ) | [explicit] |
Public constructor.
This constructor constructs the starting loadplan and will also call a private constructor to creates the ending loadplan. In other words, a single call to the constructor will create two loadplan objects.
Definition at line 52 of file loadplan.cpp.
| frepple::LoadPlan::~LoadPlan | ( | ) | [virtual] |
Destructor.
Definition at line 174 of file loadplan.cpp.
Member Function Documentation
| PyObject * frepple::LoadPlan::getattro | ( | const Attribute & | attr | ) | [virtual] |
Default getattro method.
Subclasses are expected to implement an override if the type supports gettattro.
Reimplemented from frepple::utils::PythonExtensionBase.
Definition at line 343 of file loadplan.cpp.
| bool frepple::LoadPlan::getHidden | ( | ) | const [inline] |
| const Load* frepple::LoadPlan::getLoad | ( | ) | const [inline] |
| OperationPlan* frepple::LoadPlan::getOperationPlan | ( | ) | const [inline] |
| LoadPlan * frepple::LoadPlan::getOtherLoadPlan | ( | ) | const |
Each operationplan has 2 loadplans per load: one at the start, when the capacity consumption starts, and one at the end, when the capacity consumption ends.
This method returns the "companion" loadplan. It is not very scalable: the performance is linear with the number of loadplans on the resource.
Definition at line 123 of file loadplan.cpp.
| const Resource* frepple::LoadPlan::getResource | ( | ) | const [inline] |
| const string & frepple::LoadPlan::getSetup | ( | bool | current = true |
) | const |
Returns the current setup of the resource.
When the argument is true (= default) the current setup is returned.
When the argument is false the setup just before the loadplan is returned.
Definition at line 150 of file loadplan.cpp.
Return a pointer to the timeline data structure owning this loadplan.
Reimplemented from frepple::utils::TimeLine< type >::Event.
| int frepple::LoadPlan::initialize | ( | ) | [static] |
Definition at line 37 of file loadplan.cpp.
| bool frepple::LoadPlan::isStart | ( | ) | const [inline] |
| void frepple::LoadPlan::setLoad | ( | const Load * | newld | ) |
Update the load of an already existing flowplan.
The new load must belong to the same operation.
Definition at line 213 of file loadplan.cpp.
| void frepple::LoadPlan::update | ( | ) |
This function needs to be called whenever the loadplan date or quantity are changed.
Definition at line 131 of file loadplan.cpp.
Friends And Related Function Documentation
friend class OperationPlan::LoadPlanIterator [friend] |
Member Data Documentation
const MetaCategory * frepple::LoadPlan::metadata [static] |
The documentation for this class was generated from the following files:
Documentation generated for frePPLe by
