frepple::FlowEnd Class Reference

This class defines a material flow to/from a buffer, linked with an operation. This subclass represents a flow that is at end date of the operation. More...

#include <model.h>

Inheritance diagram for frepple::FlowEnd:

List of all members.

Public Member Functions

 FlowEnd (Operation *o, Buffer *b, double q)
 FlowEnd (Operation *o, Buffer *b, double q, DateRange e)
 FlowEnd ()
virtual Date getFlowplanDate (const FlowPlan *fl) const
virtual size_t getSize () const
virtual const MetaClassgetType () const
virtual void solve (Solver &s, void *v=NULL) const
virtual void writeElement (XMLOutput *, const Keyword &, mode=DEFAULT) const
- Public Member Functions inherited from frepple::Flow
void beginElement (XMLInput &, const Attribute &)
void endElement (XMLInput &, const Attribute &, const DataElement &)
 Flow (Operation *o, Buffer *b, double q)
 Flow (Operation *o, Buffer *b, double q, DateRange e)
FlowgetAlternate () const
BuffergetBuffer () const
virtual double getFlowplanQuantity (const FlowPlan *) const
virtual bool getHidden () const
OperationgetOperation () const
double getQuantity () const
SearchMode getSearch () const
bool hasAlternates () const
bool isConsumer () const
bool isProducer () const
void setAlternate (Flow *)
void setAlternate (const string &n)
void setBuffer (Buffer *b)
void setOperation (Operation *o)
void setQuantity (double f)
void setSearch (const string a)
virtual ~Flow ()
- Public Member Functions inherited from frepple::utils::Object
 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 PyObject * str () const
virtual ~PythonExtensionBase ()
- Public Member Functions inherited from frepple::utils::Association< A, B, C >::Node
DateRange getEffective () const
const string & getName () const
int getPriority () const
A * getPtrA () const
B * getPtrB () const
 Node ()
 Node (A *a, B *b, const ListA &al, const ListB &bl)
void setEffective (DateRange dr)
void setEffectiveEnd (Date d)
void setEffectiveStart (Date d)
void setName (const string x)
void setPriority (int i)
void setPtrA (A *a, const ListA &al)
void setPtrAB (A *a, B *b, const ListA &al, const ListB &bl)
void setPtrB (B *b, const ListB &bl)
- Public Member Functions inherited from frepple::Solvable
virtual ~Solvable ()

Static Public Attributes

static const MetaClassmetadata
- Static Public Attributes inherited from frepple::Flow

Additional Inherited Members

- Static Public Member Functions inherited from frepple::Flow
static int initialize ()
static void writer (const MetaCategory *, XMLOutput *)
- Static Public Member Functions inherited from frepple::utils::Object
template<class T >
static ObjectcreateDefault ()
template<class T >
static ObjectcreateString (const string &n)
static PyObject * toXML (PyObject *, PyObject *)
- Protected Member Functions inherited from frepple::Flow
 Flow ()

Detailed Description

This class defines a material flow to/from a buffer, linked with an operation. This subclass represents a flow that is at end date of the operation.

Definition at line 3364 of file model.h.


Constructor & Destructor Documentation

frepple::FlowEnd::FlowEnd ( Operation o,
Buffer b,
double  q 
)
inlineexplicit

Constructor.

Definition at line 3368 of file model.h.

frepple::FlowEnd::FlowEnd ( Operation o,
Buffer b,
double  q,
DateRange  e 
)
inlineexplicit

Constructor.

Definition at line 3371 of file model.h.

frepple::FlowEnd::FlowEnd ( )
inlineexplicit

This constructor is called from the plan begin_element function.

Definition at line 3374 of file model.h.


Member Function Documentation

Date frepple::FlowEnd::getFlowplanDate ( const FlowPlan fl) const
inlinevirtual

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

Reimplemented from frepple::Flow.

Definition at line 3489 of file model.h.

virtual size_t frepple::FlowEnd::getSize ( ) const
inlinevirtual

Return the memory size of the object in bytes.

Reimplemented from frepple::Flow.

Definition at line 3385 of file model.h.

virtual const MetaClass& frepple::FlowEnd::getType ( ) const
inlinevirtual

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

Reimplemented from frepple::Flow.

Definition at line 3383 of file model.h.

virtual void frepple::FlowEnd::solve ( Solver s,
void *  v = NULL 
) const
inlinevirtual

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::Flow.

Definition at line 3381 of file model.h.

void frepple::FlowEnd::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::Flow.

Definition at line 329 of file flow.cpp.


Member Data Documentation

const MetaClass * frepple::FlowEnd::metadata
static

Reimplemented from frepple::Flow.

Definition at line 3384 of file model.h.


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