frepple::HasProblems Class Referenceabstract

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

#include <model.h>

Inheritance diagram for frepple::HasProblems:

Classes

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

Public Member Functions

virtual PlannablegetEntity () 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
 

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

Constructor & Destructor Documentation

frepple::HasProblems::HasProblems ( )
inline

Constructor.

Definition at line 754 of file model.h.

virtual frepple::HasProblems::~HasProblems ( )
inlinevirtual

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

Definition at line 758 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 472 of file problem.cpp.

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

Returns an iterator pointing beyond the last HasProblem object.

Definition at line 478 of file problem.cpp.

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

Returns the plannable entity relating to this problem container.

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

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::Demand, frepple::Plan, frepple::Resource, frepple::Buffer, frepple::OperationPlan, and frepple::Operation.

Friends And Related Function Documentation

friend class Problem
friend

Definition at line 743 of file model.h.

friend class Problem::const_iterator
friend

Definition at line 742 of file model.h.


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