frepple::LoadPlan Class Reference

This class represents the resource capacity of an operationplan. More...

#include <model.h>

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

List of all members.

Public Member Functions

bool getHidden () const
LoadgetLoad () const
OperationPlangetOperationPlan () const
LoadPlangetOtherLoadPlan () const
TimeLine< LoadPlan > * getTimeLine () const
bool isStart () const
 LoadPlan (OperationPlan *, const Load *)
void update ()
virtual ~LoadPlan ()

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 4190 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 34 of file loadplan.cpp.

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

Destructor.

Definition at line 4212 of file model.h.


Member Function Documentation

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

Returns true when the loadplan is hidden.
This is determined by looking at whether the load is hidden or not.

Definition at line 4230 of file model.h.

Load* frepple::LoadPlan::getLoad (  )  const [inline]

Return the load of which this is a plan instance.

Definition at line 4206 of file model.h.

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

Return the operationplan owning this loadplan.

Definition at line 4203 of file model.h.

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 74 of file loadplan.cpp.

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

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

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

Definition at line 4224 of file model.h.

bool frepple::LoadPlan::isStart (  )  const [inline]

Return true when this loadplan marks the start of an operationplan.

Definition at line 4209 of file model.h.

void frepple::LoadPlan::update (  ) 

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

Definition at line 82 of file loadplan.cpp.


Friends And Related Function Documentation

friend class OperationPlan::LoadPlanIterator [friend]

Definition at line 4192 of file model.h.


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

Generated on 25 Sep 2009 for frePPLe by  doxygen 1.6.1