C++ API - frepple::ProblemCapacityUnderload Class Reference

Public Member Functions | Static Public Attributes | List of all members
frepple::ProblemCapacityUnderload Class Reference

A problem of this class is created when a resource is loaded below its minimum during a certain period of time. More...

#include <model.h>

Inheritance diagram for frepple::ProblemCapacityUnderload:
Inheritance graph
[legend]

Public Member Functions

const DateRange getDates () const
 
string getDescription () const
 
string getEntity () const
 
Object * getOwner () const
 
Resource * getResource () const
 
size_t getSize () const
 
const MetaClass & getType () const
 
double getWeight () const
 
bool isFeasible () const
 
 ProblemCapacityUnderload (Resource *r, DateRange d, double q, bool add=true)
 
 ~ProblemCapacityUnderload ()
 
- 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 MetaClass * metadata
 
- Static Public Attributes inherited from frepple::Problem
static const MetaCategory * metadata
 

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 PythonType * registerPythonType (int, const type_info *)
 
- Protected Attributes inherited from frepple::Problem
Problem * nextProblem
 
HasProblems * owner
 
- Static Protected Attributes inherited from frepple::utils::PythonExtensionBase
static vector< PythonType * > table
 

Detailed Description

A problem of this class is created when a resource is loaded below its minimum during a certain period of time.

Definition at line 5204 of file model.h.

Constructor & Destructor Documentation

frepple::ProblemCapacityUnderload::ProblemCapacityUnderload ( Resource *  r,
DateRange  d,
double  q,
bool  add = true 
)
inline

Definition at line 5210 of file model.h.

frepple::ProblemCapacityUnderload::~ProblemCapacityUnderload ( )
inline

Definition at line 5212 of file model.h.

Member Function Documentation

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

Returns the duration of this problem.

Implements frepple::Problem.

Definition at line 5215 of file model.h.

string frepple::ProblemCapacityUnderload::getDescription ( ) const
virtual

Returns a text description of this problem.

Implements frepple::Problem.

Definition at line 126 of file problems_resource.cpp.

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

Returns the object type having this problem.

Implements frepple::Problem.

Definition at line 5213 of file model.h.

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

Returns a pointer to the object that owns this problem.

Implements frepple::Problem.

Definition at line 5214 of file model.h.

Resource* frepple::ProblemCapacityUnderload::getResource ( ) const
inline

Definition at line 5216 of file model.h.

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

Return the memory size of the object in bytes.

Implements frepple::utils::Object.

Definition at line 5217 of file model.h.

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

Return a reference to the metadata structure.

Reimplemented from frepple::Problem.

Definition at line 5220 of file model.h.

double frepple::ProblemCapacityUnderload::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 5209 of file model.h.

bool frepple::ProblemCapacityUnderload::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 5208 of file model.h.

Member Data Documentation

const MetaClass * frepple::ProblemCapacityUnderload::metadata
static

Storing metadata on this class.

Definition at line 5223 of file model.h.

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