frepple::FlowPlan Class Reference
A flowplan represents a planned material flow in or out of a buffer. More...
#include <model.h>

Public Member Functions | |
FlowPlan (OperationPlan *, const Flow *) | |
const Buffer * | getBuffer () const |
const Flow * | getFlow () const |
bool | getHidden () const |
OperationPlan * | getOperationPlan () const |
TimeLine< FlowPlan > * | getTimeLine () const |
void | setFlow (const Flow *) |
void | setQuantity (double qty, bool b=false, bool u=true) |
void | update () |
void | writeElement (XMLOutput *, const Keyword &, mode=DEFAULT) const |
virtual | ~FlowPlan () |
Static Public Member Functions | |
static int | initialize () |
Static Public Attributes | |
static const MetaCategory * | metadata |
Friends | |
class | OperationPlan::FlowPlanIterator |
Detailed Description
A flowplan represents a planned material flow in or out of a buffer.
Flowplans are owned by operationplans, which manage a container to store them.
Definition at line 3574 of file model.h.
Constructor & Destructor Documentation
frepple::FlowPlan::FlowPlan | ( | OperationPlan * | opplan, | |
const Flow * | f | |||
) | [explicit] |
Constructor.
Definition at line 51 of file flowplan.cpp.
virtual frepple::FlowPlan::~FlowPlan | ( | ) | [inline, virtual] |
Member Function Documentation
const Buffer* frepple::FlowPlan::getBuffer | ( | ) | const [inline] |
const Flow* frepple::FlowPlan::getFlow | ( | ) | const [inline] |
bool frepple::FlowPlan::getHidden | ( | ) | const [inline] |
OperationPlan* frepple::FlowPlan::getOperationPlan | ( | ) | const [inline] |
Return a pointer to the timeline data structure owning this flowplan.
Reimplemented from frepple::utils::TimeLine< type >::Event.
int frepple::FlowPlan::initialize | ( | ) | [static] |
Definition at line 36 of file flowplan.cpp.
void frepple::FlowPlan::setFlow | ( | const Flow * | newfl | ) |
Update the flow of an already existing flowplan.
The new flow must belong to the same operation.
Definition at line 103 of file flowplan.cpp.
void frepple::FlowPlan::setQuantity | ( | double | qty, | |
bool | b = false , |
|||
bool | u = true | |||
) | [inline] |
void frepple::FlowPlan::update | ( | ) |
This function needs to be called whenever the flowplan date or quantity are changed.
Definition at line 87 of file flowplan.cpp.
Writing the element. This method has the same prototype as a usual instance of the Object class, but this is only superficial: FlowPlan isn't a subclass of Object at all.
Definition at line 134 of file flowplan.cpp.
Friends And Related Function Documentation
friend class OperationPlan::FlowPlanIterator [friend] |
Member Data Documentation
const MetaCategory * frepple::FlowPlan::metadata [static] |
The documentation for this class was generated from the following files:
Documentation generated for frePPLe by
