frepple::Flow Class Reference
This class defines a material flow to/from a buffer, linked with an operation. This default implementation plans the material flow at the start of the operation.
More...
#include <model.h>
List of all members.
Detailed Description
This class defines a material flow to/from a buffer, linked with an operation. This default implementation plans the material flow at the start of the operation.
Definition at line 3306 of file model.h.
Constructor & Destructor Documentation
frepple::Flow::~Flow |
( |
|
) |
[virtual] |
frepple::Flow::Flow |
( |
Operation * |
o, |
|
|
Buffer * |
b, |
|
|
double |
q | |
|
) |
| | [inline, explicit] |
frepple::Flow::Flow |
( |
|
) |
[inline, explicit, protected] |
Default constructor.
Definition at line 3411 of file model.h.
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 284 of file flow.cpp.
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 valid.
Implements frepple::utils::Object.
Definition at line 293 of file flow.cpp.
Flow* frepple::Flow::getAlternate |
( |
|
) |
const [inline] |
Returns the flow of which this one is an alternate.
NULL is return where there is none.
Definition at line 3369 of file model.h.
Buffer* frepple::Flow::getBuffer |
( |
|
) |
const [inline] |
Returns the buffer.
Definition at line 3349 of file model.h.
Date frepple::Flow::getFlowplanDate |
( |
const FlowPlan * |
fl |
) |
const [inline, virtual] |
This method holds the logic the compute the date of a flowplan.
Reimplemented in frepple::FlowEnd.
Definition at line 3579 of file model.h.
double frepple::Flow::getFlowplanQuantity |
( |
const FlowPlan * |
fl |
) |
const [inline, virtual] |
This method holds the logic the compute the quantity of a flowplan.
Definition at line 3571 of file model.h.
virtual bool frepple::Flow::getHidden |
( |
|
) |
const [inline, virtual] |
Operation* frepple::Flow::getOperation |
( |
|
) |
const [inline] |
Returns the operation.
Definition at line 3324 of file model.h.
int frepple::Flow::getPriority |
( |
|
) |
const [inline] |
Return the priority of a flow.
Definition at line 3361 of file model.h.
double frepple::Flow::getQuantity |
( |
|
) |
const [inline] |
Returns the material flow PER UNIT of the operationplan.
Definition at line 3339 of file model.h.
SearchMode frepple::Flow::getSearch |
( |
|
) |
const [inline] |
Return the search mode.
Definition at line 3378 of file model.h.
virtual size_t frepple::Flow::getSize |
( |
|
) |
const [inline, virtual] |
virtual const MetaClass& frepple::Flow::getType |
( |
|
) |
const [inline, virtual] |
bool frepple::Flow::hasAlternates |
( |
|
) |
const [inline] |
Returns true if there are alternates for this flow.
Definition at line 3364 of file model.h.
int frepple::Flow::initialize |
( |
|
) |
[static] |
bool frepple::Flow::isConsumer |
( |
|
) |
const [inline] |
Returns true if this flow consumes material from the buffer.
Definition at line 3333 of file model.h.
bool frepple::Flow::isProducer |
( |
|
) |
const [inline] |
Returns true if this flow produces material into the buffer.
Definition at line 3336 of file model.h.
void frepple::Flow::setAlternate |
( |
const string & |
n |
) |
|
Define the flow of which this one is an alternate.
Definition at line 236 of file flow.cpp.
void frepple::Flow::setAlternate |
( |
Flow * |
f |
) |
|
Define the flow of which this one is an alternate.
Definition at line 220 of file flow.cpp.
void frepple::Flow::setBuffer |
( |
Buffer * |
b |
) |
[inline] |
Updates the buffer of this flow. This method can be called only ONCE for each flow. In case that doesn't suit you, delete the existing flow and create a new one.
Definition at line 3355 of file model.h.
void frepple::Flow::setOperation |
( |
Operation * |
o |
) |
[inline] |
Updates the operation of this flow. This method can be called only ONCE for each flow. In case that doesn't suit you, delete the existing flow and create a new one.
Definition at line 3330 of file model.h.
void frepple::Flow::setPriority |
( |
int |
i |
) |
[inline] |
Update the priority of a flow.
Definition at line 3358 of file model.h.
void frepple::Flow::setQuantity |
( |
double |
f |
) |
[inline] |
Updates the material flow PER UNIT of the operationplan. Existing flowplans are NOT updated to take the new quantity in effect. Only new operationplans and updates to existing ones will use the new quantity value.
Definition at line 3346 of file model.h.
void frepple::Flow::setSearch |
( |
const string |
a |
) |
[inline] |
Update the search mode.
Definition at line 3381 of file model.h.
virtual void frepple::Flow::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::Solvable.
Reimplemented in frepple::FlowStart, and frepple::FlowEnd.
Definition at line 3403 of file model.h.
Called while writing the model into an XML-file. The user class should write itself out, using the IOutStream members for its "simple" members and calling writeElement recursively for any contained objects. Not all classes are expected to implement this method. In instances of such a class can be created but can't be persisted. E.g. Command
Reimplemented from frepple::utils::Object.
Reimplemented in frepple::FlowEnd.
Definition at line 246 of file flow.cpp.
Member Data Documentation
The documentation for this class was generated from the following files: