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>

Public Member Functions | |
void | beginElement (XMLInput &, const Attribute &) |
void | endElement (XMLInput &, const Attribute &, const DataElement &) |
Flow (Operation *o, Buffer *b, double q) | |
Flow (Operation *o, Buffer *b, double q, DateRange e) | |
Flow * | getAlternate () const |
Buffer * | getBuffer () const |
virtual Date | getFlowplanDate (const FlowPlan *) const |
virtual double | getFlowplanQuantity (const FlowPlan *) const |
virtual bool | getHidden () const |
Operation * | getOperation () const |
int | getPriority () const |
double | getQuantity () const |
SearchMode | getSearch () const |
virtual size_t | getSize () const |
virtual const MetaClass & | getType () const |
bool | hasAlternates () const |
bool | isConsumer () const |
bool | isProducer () const |
void | setAlternate (Flow *) |
void | setAlternate (const string &n) |
void | setBuffer (Buffer *b) |
void | setOperation (Operation *o) |
void | setPriority (int i) |
void | setQuantity (double f) |
void | setSearch (const string a) |
virtual void | solve (Solver &s, void *v=NULL) const |
virtual void | writeElement (XMLOutput *, const Keyword &, mode=DEFAULT) const |
virtual | ~Flow () |
Static Public Member Functions | |
static int | initialize () |
static void | writer (const MetaCategory *, XMLOutput *) |
Static Public Attributes | |
static const MetaCategory * | metadata |
Protected Member Functions | |
Flow () |
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.
Constructor & Destructor Documentation
frepple::Flow::Flow | ( | ) | [inline, explicit, protected] |
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.
void frepple::Flow::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 valid.
Implements frepple::utils::Object.
Flow* frepple::Flow::getAlternate | ( | ) | const [inline] |
Buffer* frepple::Flow::getBuffer | ( | ) | const [inline] |
This method holds the logic the compute the date of a flowplan.
Reimplemented in frepple::FlowEnd.
double frepple::Flow::getFlowplanQuantity | ( | const FlowPlan * | fl | ) | const [inline, virtual] |
virtual bool frepple::Flow::getHidden | ( | ) | const [inline, virtual] |
A flow is considered hidden when either its buffer or operation are hidden.
Reimplemented from frepple::utils::Object.
Operation* frepple::Flow::getOperation | ( | ) | const [inline] |
int frepple::Flow::getPriority | ( | ) | const [inline] |
double frepple::Flow::getQuantity | ( | ) | const [inline] |
SearchMode frepple::Flow::getSearch | ( | ) | const [inline] |
virtual size_t frepple::Flow::getSize | ( | ) | const [inline, virtual] |
Return the memory size of the object in bytes.
Implements frepple::utils::Object.
Reimplemented in frepple::FlowEnd, and frepple::FlowStart.
virtual const MetaClass& frepple::Flow::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.
Reimplemented in frepple::FlowEnd, and frepple::FlowStart.
bool frepple::Flow::hasAlternates | ( | ) | const [inline] |
bool frepple::Flow::isConsumer | ( | ) | const [inline] |
bool frepple::Flow::isProducer | ( | ) | const [inline] |
void frepple::Flow::setAlternate | ( | Flow * | f | ) |
void frepple::Flow::setAlternate | ( | const string & | n | ) |
void frepple::Flow::setBuffer | ( | Buffer * | b | ) | [inline] |
void frepple::Flow::setOperation | ( | Operation * | o | ) | [inline] |
void frepple::Flow::setPriority | ( | int | i | ) | [inline] |
void frepple::Flow::setQuantity | ( | double | f | ) | [inline] |
void frepple::Flow::setSearch | ( | const string | a | ) | [inline] |
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::FlowEnd, and frepple::FlowStart.
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.
void frepple::Flow::writer | ( | const MetaCategory * | c, |
XMLOutput * | o | ||
) | [static] |
Member Data Documentation
const MetaCategory * frepple::Flow::metadata [static] |
Reimplemented in frepple::FlowEnd, and frepple::FlowStart.
The documentation for this class was generated from the following files:
Documentation generated for frePPLe by
