frepple::Load Class Reference

This class links a resource to a certain operation. More...

#include <model.h>

Inheritance diagram for frepple::Load:

List of all members.

Public Member Functions

void beginElement (XMLInput &, const Attribute &)
void endElement (XMLInput &, const Attribute &, const DataElement &)
LoadgetAlternate () const
PyObject * getattro (const Attribute &)
bool getHidden () const
virtual Date getLoadplanDate (const LoadPlan *) const
virtual double getLoadplanQuantity (const LoadPlan *) const
OperationgetOperation () const
int getPriority () const
double getQuantity () const
ResourcegetResource () const
SearchMode getSearch () const
const string & getSetup () const
virtual size_t getSize () const
virtual const MetaClassgetType () const
bool hasAlternates () const
 Load ()
 Load (Operation *o, Resource *r, double u)
void setAlternate (const string &n)
void setAlternate (Load *)
int setattro (const Attribute &, const PythonObject &)
void setOperation (Operation *o)
void setPriority (int i)
void setQuantity (double f)
void setResource (Resource *r)
void setSearch (const string a)
void setSetup (const string)
virtual void solve (Solver &s, void *v=NULL) const
virtual void writeElement (XMLOutput *, const Keyword &, mode=DEFAULT) const
 ~Load ()

Static Public Member Functions

static int initialize ()
static void writer (const MetaCategory *, XMLOutput *)

Static Public Attributes

static const MetaCategorymetadata

Friends

class Operation
class Resource

Detailed Description

This class links a resource to a certain operation.

Definition at line 4058 of file model.h.


Constructor & Destructor Documentation

frepple::Load::Load ( Operation o,
Resource r,
double  u 
) [inline, explicit]

Constructor.

Definition at line 4067 of file model.h.

frepple::Load::~Load (  ) 

Destructor.

Definition at line 148 of file load.cpp.

frepple::Load::Load (  )  [inline]

Default constructor.

Definition at line 4160 of file model.h.


Member Function Documentation

void frepple::Load::beginElement ( XMLInput ,
const Attribute  
) [virtual]

Called while restoring the model from an XML-file.
This is called for each element within the "this" element, for which the "this" element is immediate parent.
It is called when the open element tag is encountered.

Reimplemented from frepple::utils::Object.

Definition at line 308 of file load.cpp.

void frepple::Load::endElement ( XMLInput ,
const Attribute ,
const DataElement  
) [virtual]

Called while restoring the model from an XML-file.
This is called when the corresponding close element tag is encountered, and the Data() member of pElement is valid.

Implements frepple::utils::Object.

Definition at line 317 of file load.cpp.

Load* frepple::Load::getAlternate (  )  const [inline]

Returns the load of which this one is an alternate.
NULL is return where there is none.

Definition at line 4119 of file model.h.

PyObject * frepple::Load::getattro ( const Attribute attr  )  [virtual]

Default getattro method.
Subclasses are expected to implement an override if the type supports gettattro.

Reimplemented from frepple::utils::PythonExtensionBase.

Definition at line 366 of file load.cpp.

bool frepple::Load::getHidden (  )  const [inline, virtual]

Returns whether an entity is real or dummy.

Reimplemented from frepple::utils::Object.

Definition at line 4147 of file model.h.

Date frepple::Load::getLoadplanDate ( const LoadPlan lp  )  const [inline, virtual]

This method holds the logic the compute the date of a loadplan.

Definition at line 4893 of file model.h.

double frepple::Load::getLoadplanQuantity ( const LoadPlan lp  )  const [inline, virtual]

This method holds the logic the compute the quantity of a loadplan.

Definition at line 4907 of file model.h.

Operation* frepple::Load::getOperation (  )  const [inline]

Returns the operation consuming the resource capacity.

Definition at line 4081 of file model.h.

int frepple::Load::getPriority (  )  const [inline]

Return the priority of a load.

Definition at line 4111 of file model.h.

double frepple::Load::getQuantity (  )  const [inline]

Returns how much capacity is consumed during the duration of the operationplan.

Definition at line 4096 of file model.h.

Resource* frepple::Load::getResource (  )  const [inline]

Returns the capacity resource being consumed.

Definition at line 4088 of file model.h.

SearchMode frepple::Load::getSearch (  )  const [inline]

Return the search mode.

Definition at line 4164 of file model.h.

const string& frepple::Load::getSetup (  )  const [inline]

Return the required resource setup.

Definition at line 4131 of file model.h.

virtual size_t frepple::Load::getSize (  )  const [inline, virtual]

Return the memory size of the object in bytes.

Implements frepple::utils::Object.

Definition at line 4156 of file model.h.

virtual const MetaClass& frepple::Load::getType (  )  const [inline, virtual]

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

Implements frepple::utils::Object.

Definition at line 4154 of file model.h.

bool frepple::Load::hasAlternates (  )  const [inline]

Returns true if there are alternates for this load.

Definition at line 4114 of file model.h.

int frepple::Load::initialize (  )  [static]

Definition at line 36 of file load.cpp.

void frepple::Load::setAlternate ( const string &  n  ) 

Define the load of which this one is an alternate.

Definition at line 235 of file load.cpp.

void frepple::Load::setAlternate ( Load f  ) 

Define the load of which this one is an alternate.

Definition at line 221 of file load.cpp.

int frepple::Load::setattro ( const Attribute attr,
const PythonObject field 
) [virtual]

Default setattro method.
Subclasses are expected to implement an override if the type supports settattro.

Reimplemented from frepple::utils::PythonExtensionBase.

Definition at line 396 of file load.cpp.

void frepple::Load::setOperation ( Operation o  )  [inline]

Updates the operation being loaded. This method can only be called once for a load.

Definition at line 4085 of file model.h.

void frepple::Load::setPriority ( int  i  )  [inline]

Update the priority of a load.

Definition at line 4108 of file model.h.

void frepple::Load::setQuantity ( double  f  )  [inline]

Updates the quantity of the load.

Exceptions:
DataException When a negative number is passed.

Definition at line 4101 of file model.h.

void frepple::Load::setResource ( Resource r  )  [inline]

Updates the capacity being consumed. This method can only be called once on a resource.

Definition at line 4092 of file model.h.

void frepple::Load::setSearch ( const string  a  )  [inline]

Update the search mode.

Definition at line 4167 of file model.h.

void frepple::Load::setSetup ( const string  n  ) 

Update the required resource setup.

Definition at line 245 of file load.cpp.

virtual void frepple::Load::solve ( Solver s,
void *  v = NULL 
) const [inline, virtual]

This method is called by solver classes. The implementation of this class simply calls the solve method on the solver class. Using the polymorphism the solver can implement seperate methods for different plannable subclasses.

Reimplemented from frepple::Solvable.

Definition at line 4152 of file model.h.

void frepple::Load::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::utils::Object.

Definition at line 263 of file load.cpp.

void frepple::Load::writer ( const MetaCategory c,
XMLOutput o 
) [static]

Definition at line 58 of file load.cpp.


Friends And Related Function Documentation

friend class Operation [friend]

Definition at line 4063 of file model.h.

friend class Resource [friend]

Definition at line 4062 of file model.h.


Member Data Documentation

Definition at line 4155 of file model.h.


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

Documentation generated for frePPLe by  doxygen