frepple::FlowPlan Class Reference

A flowplan represents a planned material flow in or out of a buffer. More...

#include <model.h>

Inheritance diagram for frepple::FlowPlan:
frepple::utils::TimeLine< type >::EventChangeOnhand frepple::utils::TimeLine< type >::Event frepple::utils::NonCopyable

List of all members.

Public Member Functions

 FlowPlan (OperationPlan *, const Flow *)
FlowgetFlow () const
bool getHidden () const
OperationPlangetOperationPlan () const
TimeLine< FlowPlan > * getTimeLine () const
void setQuantity (double qty, bool b=false, bool u=true)
void update ()
void writeElement (XMLOutput *, const Keyword &, mode=DEFAULT) const
virtual ~FlowPlan ()

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 3285 of file model.h.


Constructor & Destructor Documentation

frepple::FlowPlan::FlowPlan ( OperationPlan opplan,
const Flow f 
) [explicit]

Constructor.

Definition at line 33 of file flowplan.cpp.

virtual frepple::FlowPlan::~FlowPlan (  )  [inline, virtual]

Destructor.

Definition at line 3309 of file model.h.


Member Function Documentation

Flow* frepple::FlowPlan::getFlow (  )  const [inline]

Returns the flow of which this is an plan instance.

Definition at line 3303 of file model.h.

bool frepple::FlowPlan::getHidden (  )  const [inline]

Returns true when the flowplan is hidden.
This is determined by looking at whether the flow is hidden or not.

Definition at line 3347 of file model.h.

OperationPlan* frepple::FlowPlan::getOperationPlan (  )  const [inline]

Returns the operationplan owning this flowplan.

Definition at line 3306 of file model.h.

TimeLine<FlowPlan>* frepple::FlowPlan::getTimeLine (  )  const [inline, virtual]

Return a pointer to the timeline data structure owning this flowplan.

Reimplemented from frepple::utils::TimeLine< type >::Event.

Definition at line 3341 of file model.h.

void frepple::FlowPlan::setQuantity ( double  qty,
bool  b = false,
bool  u = true 
) [inline]

Updates the quantity of the flowplan by changing the quantity of the operationplan owning this flowplan.
The boolean parameter is used to control whether to round up or down in case the operation quantity must be a multiple.

Definition at line 3329 of file model.h.

void frepple::FlowPlan::update (  ) 

This function needs to be called whenever the flowplan date or quantity are changed.

Definition at line 57 of file flowplan.cpp.

void frepple::FlowPlan::writeElement ( XMLOutput o,
const Keyword tag,
mode  m = DEFAULT 
) const

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 75 of file flowplan.cpp.


Friends And Related Function Documentation

friend class OperationPlan::FlowPlanIterator [friend]

Definition at line 3287 of file model.h.


The documentation for this class was generated from the following files:

Generated on 25 Feb 2010 for frePPLe by  doxygen 1.6.1