frepple::HasProblems Class Reference

Classes that keep track of problem conditions need to implement this class. More...

#include <model.h>

Inheritance diagram for frepple::HasProblems:

frepple::OperationPlan frepple::Plannable frepple::OperationPlanAlternate frepple::OperationPlanRouting frepple::Buffer frepple::Demand frepple::Operation frepple::Plan frepple::Resource frepple::BufferDefault frepple::BufferInfinite frepple::BufferProcure frepple::DemandDefault module_forecast::Forecast module_forecast::ForecastBucket frepple::OperationAlternate frepple::OperationFixedTime frepple::OperationRouting frepple::OperationTimePer frepple::ResourceDefault frepple::ResourceInfinite

List of all members.


Public Member Functions

virtual Plannable * getEntity () const =0
 HasProblems ()
virtual void updateProblems ()=0
virtual ~HasProblems ()

Static Public Member Functions

static EntityIterator beginEntity ()
static EntityIterator endEntity ()

Friends

class Problem
class Problem::const_iterator

Classes

class  EntityIterator
 This class models a iterator that walks over all available HasProblem entities. More...

Detailed Description

Classes that keep track of problem conditions need to implement this class.

This class is closely related to the Problem class.

See also:
Problem

Definition at line 906 of file model.h.

Constructor & Destructor Documentation

frepple::HasProblems::HasProblems (  )  [inline]

Constructor.

Definition at line 920 of file model.h.

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

Destructor. It needs to take care of making sure all problems objects are being deleted as well.

Definition at line 924 of file model.h.

Member Function Documentation

HasProblems::EntityIterator frepple::HasProblems::beginEntity (  )  [static]

Returns an iterator pointing to the first HasProblem object.

Definition at line 420 of file problem.cpp.

HasProblems::EntityIterator frepple::HasProblems::endEntity (  )  [static]

Returns an iterator pointing beyond the last HasProblem object.

Definition at line 426 of file problem.cpp.

virtual Plannable* frepple::HasProblems::getEntity (  )  const [pure virtual]

Returns the plannable entity relating to this problem container.

Implemented in frepple::Plannable, and frepple::OperationPlan.

virtual void frepple::HasProblems::updateProblems (  )  [pure 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

Implemented in frepple::Operation, frepple::OperationPlan, frepple::OperationPlanRouting, frepple::Buffer, frepple::Resource, frepple::Plan, and frepple::Demand.

Friends And Related Function Documentation

friend class Problem [friend]

Definition at line 909 of file model.h.

friend class Problem::const_iterator [friend]

Definition at line 908 of file model.h.

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