frepple::ProblemInvalidData Class Reference

A Problem of this class is created in the model when a data exception prevents planning of certain objects. More...

#include <model.h>

Inheritance diagram for frepple::ProblemInvalidData:

Public Member Functions

const DateRange getDates () const
 
string getDescription () const
 
string getEntity () const
 
ObjectgetOwner () const
 
size_t getSize () const
 
const MetaClassgetType () const
 
double getWeight () const
 
bool isFeasible () const
 
 ProblemInvalidData (HasProblems *o, string d, string e, Date st, Date nd, double q, bool add=true)
 
 ~ProblemInvalidData ()
 
- Public Member Functions inherited from frepple::Problem
void endElement (XMLInput &, const Attribute &, const DataElement &)
 
PyObject * getattro (const Attribute &)
 
 Problem (HasProblems *p=NULL)
 
PyObject * str () const
 
virtual void writeElement (XMLOutput *, const Keyword &, mode=DEFAULT) const
 
virtual ~Problem ()
 
- Public Member Functions inherited from frepple::utils::Object
virtual void beginElement (XMLInput &, const Attribute &)
 
virtual bool getHidden () const
 
 Object ()
 
virtual void setHidden (bool b)
 
virtual ~Object ()
 
- Public Member Functions inherited from frepple::utils::PythonExtensionBase
virtual PyObject * call (const PythonObject &args, const PythonObject &kwds)
 
virtual int compare (const PyObject *other) const
 
Py_ssize_t getReferenceCount () const
 
void initType (const MetaClass *t)
 
void initType (PyTypeObject *t)
 
virtual PyObject * iternext ()
 
 PythonExtensionBase ()
 
void resetReferenceCount ()
 
virtual int setattro (const Attribute &attr, const PythonObject &field)
 
virtual ~PythonExtensionBase ()
 

Static Public Attributes

static const MetaClassmetadata
 
- Static Public Attributes inherited from frepple::Problem
static const MetaCategorymetadata
 

Additional Inherited Members

- Static Public Member Functions inherited from frepple::Problem
static const_iterator begin ()
 
static const_iterator begin (HasProblems *, bool=true)
 
static void clearProblems ()
 
static void clearProblems (HasProblems &p, bool setchanged=true)
 
static const const_iterator end ()
 
static int initialize ()
 
static void writer (const MetaCategory *, XMLOutput *)
 
- Protected Member Functions inherited from frepple::Problem
void addProblem ()
 
bool operator< (const Problem &a) const
 
void removeProblem ()
 
- Static Protected Member Functions inherited from frepple::utils::PythonExtensionBase
static PythonTyperegisterPythonType (int, const type_info *)
 
- Protected Attributes inherited from frepple::Problem
ProblemnextProblem
 
HasProblemsowner
 
- Static Protected Attributes inherited from frepple::utils::PythonExtensionBase
static vector< PythonType * > table
 

Detailed Description

A Problem of this class is created in the model when a data exception prevents planning of certain objects.

Definition at line 5059 of file model.h.

Constructor & Destructor Documentation

frepple::ProblemInvalidData::ProblemInvalidData ( HasProblems o,
string  d,
string  e,
Date  st,
Date  nd,
double  q,
bool  add = true 
)
inlineexplicit

Definition at line 5065 of file model.h.

frepple::ProblemInvalidData::~ProblemInvalidData ( )
inline

Definition at line 5069 of file model.h.

Member Function Documentation

const DateRange frepple::ProblemInvalidData::getDates ( ) const
inlinevirtual

Returns the duration of this problem.

Implements frepple::Problem.

Definition at line 5071 of file model.h.

string frepple::ProblemInvalidData::getDescription ( ) const
inlinevirtual

Returns a text description of this problem.

Implements frepple::Problem.

Definition at line 5062 of file model.h.

string frepple::ProblemInvalidData::getEntity ( ) const
inlinevirtual

Returns the object type having this problem.

Implements frepple::Problem.

Definition at line 5070 of file model.h.

Object* frepple::ProblemInvalidData::getOwner ( ) const
inlinevirtual

Returns a pointer to the object that owns this problem.

Implements frepple::Problem.

Definition at line 5072 of file model.h.

size_t frepple::ProblemInvalidData::getSize ( ) const
inlinevirtual

Return the memory size of the object in bytes.

Implements frepple::utils::Object.

Definition at line 5080 of file model.h.

const MetaClass& frepple::ProblemInvalidData::getType ( ) const
inlinevirtual

Return a reference to the metadata structure.

Reimplemented from frepple::Problem.

Definition at line 5084 of file model.h.

double frepple::ProblemInvalidData::getWeight ( ) const
inlinevirtual

Returns a double number reflecting the magnitude of the problem. This allows us to focus on the significant problems and filter out the small ones.

Implements frepple::Problem.

Definition at line 5064 of file model.h.

bool frepple::ProblemInvalidData::isFeasible ( ) const
inlinevirtual

Returns true if the plan remains feasible even if it contains this problem, i.e. if the problems flags only a warning. Returns false if a certain problem points at an infeasibility of the plan.

Implements frepple::Problem.

Definition at line 5063 of file model.h.

Member Data Documentation

const MetaClass * frepple::ProblemInvalidData::metadata
static

Storing metadata on this class.

Definition at line 5087 of file model.h.


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