frepple::Buffer Class Reference

A buffer represents a combination of a item and location.
It is the entity for keeping modeling inventory. More...

#include <model.h>

Inheritance diagram for frepple::Buffer:

List of all members.

Public Types

typedef Association< Operation,
Buffer, Flow >::ListB 
flowlist
typedef TimeLine< FlowPlanflowplanlist

Public Member Functions

virtual void beginElement (XMLInput &, const Attribute &)
 Buffer (const string &str)
void deleteOperationPlans (bool deleteLockedOpplans=false)
virtual void endElement (XMLInput &, const Attribute &, const DataElement &)
size_t extrasize () const
FlowfindFlow (const Operation *o, Date d) const
virtual void followPegging (PeggingIterator &, FlowPlan *, short, double, double)
virtual PyObject * getattro (const Attribute &)
double getCarryingCost () const
flowplanlistgetFlowPlans ()
const flowplanlistgetFlowPlans () const
const flowlistgetFlows () const
bool getHidden () const
ItemgetItem () const
LocationgetLocation () const
CalendarDoublegetMaximum () const
CalendarDoublegetMinimum () const
double getOnHand (Date, Date, bool min=true) const
double getOnHand (Date d=Date::infinitePast) const
OperationgetProducingOperation () const
virtual const MetaClassgetType () const
virtual int setattro (const Attribute &, const PythonObject &)
void setCarryingCost (const double c)
void setHidden (bool b)
void setItem (Item *i)
void setLocation (Location *i)
void setMaximum (CalendarDouble *)
void setMinimum (CalendarDouble *)
void setOnHand (double f)
void setProducingOperation (Operation *o)
virtual void solve (Solver &s, void *v=NULL) const
virtual void updateProblems ()
virtual void writeElement (XMLOutput *, const Keyword &, mode=DEFAULT) const
virtual ~Buffer ()

Static Public Member Functions

static int initialize ()

Static Public Attributes

static const MetaCategorymetadata

Friends

class Flow
class FlowPlan

Detailed Description

A buffer represents a combination of a item and location.
It is the entity for keeping modeling inventory.

Definition at line 2920 of file model.h.


Member Typedef Documentation

Definition at line 2928 of file model.h.

Definition at line 2927 of file model.h.


Constructor & Destructor Documentation

frepple::Buffer::Buffer ( const string &  str  )  [inline, explicit]

Constructor. Implicit creation of instances is disallowed.

Definition at line 2931 of file model.h.

frepple::Buffer::~Buffer (  )  [virtual]

Destructor.

Definition at line 442 of file buffer.cpp.


Member Function Documentation

void frepple::Buffer::beginElement ( XMLInput ,
const Attribute  
) [virtual]

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::HasHierarchy< Buffer >.

Definition at line 267 of file buffer.cpp.

void frepple::Buffer::deleteOperationPlans ( bool  deleteLockedOpplans = false  ) 

Deletes all operationplans consuming from or producing from this buffer. The boolean parameter controls whether we delete also locked operationplans or not.

Definition at line 431 of file buffer.cpp.

void frepple::Buffer::endElement ( XMLInput pIn,
const Attribute pAttr,
const DataElement pElement 
) [virtual]

Reimplemented from frepple::Plannable.

Reimplemented in frepple::BufferProcure.

Definition at line 292 of file buffer.cpp.

size_t frepple::Buffer::extrasize (  )  const [inline]

Returns the memory size in bytes.

Reimplemented from frepple::utils::HasDescription.

Definition at line 2993 of file model.h.

Flow* frepple::Buffer::findFlow ( const Operation o,
Date  d 
) const [inline]

Return the flow that is associates a given operation with this buffer.
Returns NULL is no such flow exists.

Definition at line 3030 of file model.h.

void frepple::Buffer::followPegging ( PeggingIterator iter,
FlowPlan curflowplan,
short  nextlevel,
double  curqty,
double  curfactor 
) [virtual]

This function matches producing and consuming operationplans with each other, and updates the pegging iterator accordingly.

Definition at line 460 of file buffer.cpp.

PyObject * frepple::Buffer::getattro ( const Attribute attr  )  [virtual]

Default getattro method.
Subclasses are expected to implement an override if the type supports gettattro.

Reimplemented from frepple::utils::PythonExtensionBase.

Reimplemented in frepple::BufferProcure.

Definition at line 711 of file buffer.cpp.

double frepple::Buffer::getCarryingCost (  )  const [inline]

Return the carrying cost.
The cost of carrying inventory in this buffer. The value is a percentage of the item sales price, per year and per unit.

Definition at line 2974 of file model.h.

flowplanlist& frepple::Buffer::getFlowPlans (  )  [inline]

Returns a reference to the list of all flow plans of this buffer.

Definition at line 3026 of file model.h.

const flowplanlist& frepple::Buffer::getFlowPlans (  )  const [inline]

Returns a reference to the list of all flow plans of this buffer.

Definition at line 3023 of file model.h.

const flowlist& frepple::Buffer::getFlows (  )  const [inline]

Returns a reference to the list of all flows of this buffer.

Definition at line 3018 of file model.h.

bool frepple::Buffer::getHidden (  )  const [inline, virtual]

Returns whether an entity is real or dummy.

Reimplemented from frepple::utils::Object.

Definition at line 3042 of file model.h.

Item* frepple::Buffer::getItem (  )  const [inline]

Returns the item stored in this buffer.

Definition at line 2945 of file model.h.

Location* frepple::Buffer::getLocation (  )  const [inline]

Returns the Location of this buffer.

Definition at line 2951 of file model.h.

CalendarDouble* frepple::Buffer::getMaximum (  )  const [inline]

Returns a pointer to a calendar for storing the maximum inventory level.

Definition at line 2962 of file model.h.

CalendarDouble* frepple::Buffer::getMinimum (  )  const [inline]

Returns a pointer to a calendar for storing the minimum inventory level.

Definition at line 2958 of file model.h.

double frepple::Buffer::getOnHand ( Date  d1,
Date  d2,
bool  min = true 
) const

Returns minimum or maximum available material on hand in the given daterange. The third parameter specifies whether we return the minimum (which is the default) or the maximum value. The computation is INclusive the start and end dates.

Definition at line 165 of file buffer.cpp.

double frepple::Buffer::getOnHand ( Date  d = Date::infinitePast  )  const

Returns the available material on hand immediately after the given date.

Definition at line 147 of file buffer.cpp.

Operation* frepple::Buffer::getProducingOperation (  )  const [inline]

Returns the operation that is used to supply extra supply into this buffer.

Definition at line 2937 of file model.h.

virtual const MetaClass& frepple::Buffer::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::BufferDefault, frepple::BufferInfinite, and frepple::BufferProcure.

Definition at line 3044 of file model.h.

int frepple::Buffer::initialize (  )  [static]

Initialize the class.

Reimplemented in frepple::BufferDefault, frepple::BufferInfinite, and frepple::BufferProcure.

Definition at line 49 of file buffer.cpp.

int frepple::Buffer::setattro ( const Attribute attr,
const PythonObject field 
) [virtual]

Default setattro method.
Subclasses are expected to implement an override if the type supports settattro.

Reimplemented from frepple::utils::PythonExtensionBase.

Reimplemented in frepple::BufferProcure.

Definition at line 754 of file buffer.cpp.

void frepple::Buffer::setCarryingCost ( const double  c  )  [inline]

Return the carrying cost.
The cost of carrying inventory in this buffer. The value is a percentage of the item sales price, per year and per unit.
The default value is 0.0.

Definition at line 2981 of file model.h.

void frepple::Buffer::setHidden ( bool  b  )  [inline, virtual]

Mark the object as hidden or not. Hidden objects are not exported and are used only as dummy constructs.

Reimplemented from frepple::utils::Object.

Definition at line 3041 of file model.h.

void frepple::Buffer::setItem ( Item i  )  [inline]

Updates the Item stored in this buffer.

Definition at line 2948 of file model.h.

void frepple::Buffer::setLocation ( Location i  )  [inline]

Updates the location of this buffer.

Definition at line 2954 of file model.h.

void frepple::Buffer::setMaximum ( CalendarDouble cal  ) 

Updates the minimum inventory target for the buffer.

Definition at line 393 of file buffer.cpp.

void frepple::Buffer::setMinimum ( CalendarDouble cal  ) 

Updates the minimum inventory target for the buffer.

Definition at line 355 of file buffer.cpp.

void frepple::Buffer::setOnHand ( double  f  ) 

Update the on-hand inventory at the start of the planning horizon.

Definition at line 98 of file buffer.cpp.

void frepple::Buffer::setProducingOperation ( Operation o  )  [inline]

Updates the operation that is used to supply extra supply into this buffer.

Definition at line 2941 of file model.h.

virtual void frepple::Buffer::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::BufferInfinite, and frepple::BufferProcure.

Definition at line 3020 of file model.h.

void frepple::Buffer::updateProblems (  )  [virtual]

Called to update the list of problems. The function will only be called when:

  • the list of problems is being recomputed
  • AND, problem detection is enabled for this object
  • AND, the object has changed since the last problem computation

Implements frepple::HasProblems.

Definition at line 35 of file problems_buffer.cpp.

void frepple::Buffer::writeElement ( XMLOutput o,
const Keyword tag,
mode  m = DEFAULT 
) const [virtual]

Reimplemented from frepple::Plannable.

Reimplemented in frepple::BufferInfinite, and frepple::BufferProcure.

Definition at line 210 of file buffer.cpp.


Friends And Related Function Documentation

friend class Flow [friend]

Definition at line 2923 of file model.h.

friend class FlowPlan [friend]

Definition at line 2924 of file model.h.


Member Data Documentation

Reimplemented in frepple::BufferDefault, frepple::BufferInfinite, and frepple::BufferProcure.

Definition at line 3045 of file model.h.


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

Documentation generated for frePPLe by  doxygen