Public Member Functions | Static Public Member Functions

frepple::utils::Object Class Reference

Object is the abstract base class for the main entities. More...

#include <utils.h>

Inheritance diagram for frepple::utils::Object:
frepple::utils::PythonExtensionBase frepple::Calendar::Bucket frepple::Flow frepple::Load frepple::OperationPlan frepple::PeggingIterator frepple::Plan frepple::Problem frepple::SetupMatrix::Rule frepple::utils::HasName< T > frepple::utils::HasName< Buffer > frepple::utils::HasName< Calendar > frepple::utils::HasName< Customer > frepple::utils::HasName< Demand > frepple::utils::HasName< Item > frepple::utils::HasName< Location > frepple::utils::HasName< Operation > frepple::utils::HasName< Resource > frepple::utils::HasName< SetupMatrix > frepple::utils::HasName< Solver >

List of all members.

Public Member Functions

virtual void beginElement (XMLInput &, const Attribute &)
virtual void endElement (XMLInput &, const Attribute &, const DataElement &)=0
virtual bool getHidden () const
virtual size_t getSize () const =0
virtual const MetaClassgetType () const =0
 Object ()
virtual void setHidden (bool b)
virtual void writeElement (XMLOutput *, const Keyword &, mode=DEFAULT) const
virtual ~Object ()

Static Public Member Functions

template<class T >
static PyObject * create (PyTypeObject *pytype, PyObject *args, PyObject *kwds)
template<class T >
static ObjectcreateDefault ()
template<class T >
static ObjectcreateString (const string &n)
static PyObject * toXML (PyObject *, PyObject *)

Detailed Description

Object is the abstract base class for the main entities.

It handles to following capabilities:

Definition at line 3145 of file utils.h.


Constructor & Destructor Documentation

frepple::utils::Object::Object (  )  [inline, explicit]

Constructor.

Definition at line 3149 of file utils.h.

virtual frepple::utils::Object::~Object (  )  [inline, virtual]

Destructor.

Definition at line 3152 of file utils.h.


Member Function Documentation

virtual void frepple::utils::Object::beginElement ( XMLInput ,
const Attribute  
) [inline, 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 in frepple::Calendar, frepple::CalendarPointer< T >, frepple::SetupMatrix, frepple::Plan, frepple::utils::HasHierarchy< T >, frepple::utils::HasHierarchy< Item >, frepple::utils::HasHierarchy< Location >, frepple::utils::HasHierarchy< Demand >, frepple::utils::HasHierarchy< Customer >, frepple::utils::HasHierarchy< Resource >, and frepple::utils::HasHierarchy< Buffer >.

Definition at line 3170 of file utils.h.

template<class T >
static PyObject* frepple::utils::Object::create ( PyTypeObject *  pytype,
PyObject *  args,
PyObject *  kwds 
) [inline, static]

Template function that generates a factory method callable from Python.

Definition at line 3212 of file utils.h.

template<class T >
static Object* frepple::utils::Object::createDefault (  )  [inline, static]

This template function can generate a factory method for objects that can be constructed with their default constructor.

Definition at line 3195 of file utils.h.

template<class T >
static Object* frepple::utils::Object::createString ( const string &  n  )  [inline, static]

This template function can generate a factory method for objects that need a string argument in their constructor.

Definition at line 3203 of file utils.h.

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

Returns whether an entity is real or dummy.

Definition at line 3183 of file utils.h.

virtual void frepple::utils::Object::setHidden ( bool  b  )  [inline, virtual]

Mark the object as hidden or not. Hidden objects are not exported and are used only as dummy constructs.

Definition at line 3180 of file utils.h.

PyObject * frepple::utils::Object::toXML ( PyObject *  self,
PyObject *  args 
) [static]

Return an XML representation of the object.
If a file object is passed as argument, the representation is directly written to it.
If no argument is given the representation is returned as a string.

Definition at line 459 of file pythonutils.cpp.

virtual void frepple::utils::Object::writeElement ( XMLOutput ,
const Keyword ,
mode  = DEFAULT 
) const [inline, 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 in frepple::Calendar, frepple::CalendarValue< T >, frepple::CalendarPointer< T >, frepple::Problem, frepple::Solver, frepple::SetupMatrix::Rule, frepple::SetupMatrix, frepple::Plan, frepple::SolverMRP, frepple::utils::HasHierarchy< T >, module_forecast::ForecastSolver, module_lp_solver::LPSolver, frepple::utils::HasHierarchy< Item >, frepple::utils::HasHierarchy< Location >, frepple::utils::HasHierarchy< Demand >, frepple::utils::HasHierarchy< Customer >, frepple::utils::HasHierarchy< Resource >, and frepple::utils::HasHierarchy< Buffer >.

Definition at line 3162 of file utils.h.


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