module_forecast::ForecastSolver Class Reference

Implementation of a forecast netting algorithm. More...

#include <forecast.h>

Inheritance diagram for module_forecast::ForecastSolver:
frepple::Solver frepple::utils::Object frepple::utils::HasName< Solver > frepple::utils::NonCopyable frepple::utils::Tree::TreeNode

List of all members.

Classes

struct  sorter

Public Member Functions

bool callback (Demand *l, const Signal a)
 ForecastSolver (const string &n)
virtual size_t getSize () const
virtual const MetaClassgetType () const
void solve (void *v=NULL)
void solve (const Demand *, void *=NULL)
void writeElement (XMLOutput *, const Keyword &, mode=DEFAULT) const

Static Public Attributes

static const MetaClassmetadata

Friends

class Forecast

Detailed Description

Implementation of a forecast netting algorithm.

As customer orders are being received they need to be deducted from the forecast to avoid double-counting demand.

The netting solver will process each order as follows:

The logging levels have the following meaning:

Definition at line 853 of file forecast.h.


Constructor & Destructor Documentation

module_forecast::ForecastSolver::ForecastSolver ( const string &  n  )  [inline]

Constructor.

Definition at line 858 of file forecast.h.


Member Function Documentation

bool module_forecast::ForecastSolver::callback ( Demand l,
const Signal  a 
)

Callback function, used for netting orders against the forecast.

Definition at line 33 of file forecastsolver.cpp.

virtual size_t module_forecast::ForecastSolver::getSize (  )  const [inline, virtual]

Return the memory size of the object in bytes.

Implements frepple::utils::Object.

Definition at line 872 of file forecast.h.

virtual const MetaClass& module_forecast::ForecastSolver::getType (  )  const [inline, virtual]

This returns the type information on the object, a bit similar to the standard type_info information.

Reimplemented from frepple::Solver.

Definition at line 870 of file forecast.h.

void module_forecast::ForecastSolver::solve ( void *  v = NULL  )  [virtual]

This is the main solver method that will appropriately call the other solve methods.

Implements frepple::Solver.

Definition at line 91 of file forecastsolver.cpp.

void module_forecast::ForecastSolver::solve ( const Demand l,
void *  v = NULL 
) [virtual]

This method handles the search for a matching forecast, followed by decreasing the net forecast.

Reimplemented from frepple::Solver.

Definition at line 62 of file forecastsolver.cpp.

void module_forecast::ForecastSolver::writeElement ( XMLOutput ,
const Keyword ,
mode  = DEFAULT 
) const [virtual]

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::Solver.

Definition at line 43 of file forecastsolver.cpp.


Friends And Related Function Documentation

friend class Forecast [friend]

Definition at line 855 of file forecast.h.


Member Data Documentation

Reimplemented from frepple::Solver.

Definition at line 871 of file forecast.h.


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

Generated on 25 Feb 2010 for frePPLe by  doxygen 1.6.1