Models an operation to convert a setup on a resource. More...

#include <model.h>

Inheritance diagram for frepple::OperationSetup:

Public Member Functions
virtual size_t	getSize () const

virtual const MetaClass &	getType () const

	OperationSetup (const string &s)

OperationPlanState	setOperationPlanParameters (OperationPlan *, double, Date, Date, bool=true, bool=true) const

virtual void	solve (Solver &s, void *v=NULL) const

void	writeElement (XMLOutput *, const Keyword &, mode=DEFAULT) const

Public Member Functions inherited from frepple::Operation
void	addSuperOperation (Operation *o)

void	beginElement (XMLInput &, const Attribute &)

DateRange	calculateOperationTime (Date thedate, TimePeriod duration, bool forward, TimePeriod *actualduration=NULL) const

DateRange	calculateOperationTime (Date start, Date end, TimePeriod *actualduration=NULL) const

OperationPlan *	createOperationPlan (double, Date, Date, Demand =NULL, OperationPlan =NULL, unsigned long=0, bool makeflowsloads=true) const

void	deleteOperationPlans (bool deleteLockedOpplans=false)

void	endElement (XMLInput &, const Attribute &, const DataElement &)

size_t	extrasize () const

Flow *	findFlow (const Buffer *b, Date d) const

Load *	findLoad (const Resource *r, Date d) const

virtual PyObject *	getattro (const Attribute &)

double	getCost () const

TimePeriod	getFence () const

OperationPlan *	getFirstOpPlan () const

const flowlist &	getFlows () const

bool	getHidden () const

const loadlist &	getLoads () const

Location *	getLocation () const

TimePeriod	getPostTime () const

TimePeriod	getPreTime () const

double	getSizeMaximum () const

double	getSizeMinimum () const

double	getSizeMultiple () const

virtual const Operationlist &	getSubOperations () const

const Operationlist &	getSuperOperations () const

virtual void	removeSubOperation (Operation *o)

void	removeSuperOperation (Operation *o)

virtual int	setattro (const Attribute &, const PythonObject &)

void	setCost (const double c)

void	setFence (TimePeriod t)

void	setHidden (bool b)

void	setLocation (Location *l)

void	setPostTime (TimePeriod t)

void	setPreTime (TimePeriod t)

void	setSizeMaximum (double f)

void	setSizeMinimum (double f)

void	setSizeMultiple (double f)

virtual void	updateProblems ()

virtual	~Operation ()

Public Member Functions inherited from frepple::utils::HasName< Operation >
int	compare (const PyObject *other) const

void	endElement (XMLInput &pIn, const Attribute &pAttr, const DataElement &pElement)

	HasName (const string &n)

	HasName (const char *n)

void	setName (const string &newname)

virtual PyObject *	str () const

	~HasName ()

Public Member Functions inherited from frepple::utils::Tree::TreeNode
TreeNode *	decrement () const

const string &	getName () const

TreeNode *	increment () const

bool	operator< (const TreeNode &o)

	TreeNode (const string &n)

virtual	~TreeNode ()

Public Member Functions inherited from frepple::utils::Object
	Object ()

virtual	~Object ()

Public Member Functions inherited from frepple::utils::PythonExtensionBase
virtual PyObject *	call (const PythonObject &args, const PythonObject &kwds)

Py_ssize_t	getReferenceCount () const

void	initType (const MetaClass *t)

void	initType (PyTypeObject *t)

virtual PyObject *	iternext ()

	PythonExtensionBase ()

void	resetReferenceCount ()

virtual	~PythonExtensionBase ()

Public Member Functions inherited from frepple::HasLevel
unsigned short	getCluster () const

short	getLevel () const

Public Member Functions inherited from frepple::Plannable
bool	getChanged () const

bool	getDetectProblems () const

Plannable *	getEntity () const

	Plannable ()

void	setChanged (bool b=true)

void	setDetectProblems (bool b)

Public Member Functions inherited from frepple::HasProblems
	HasProblems ()

virtual	~HasProblems ()

Public Member Functions inherited from frepple::Solvable
virtual	~Solvable ()

Public Member Functions inherited from frepple::utils::HasDescription
void	endElement (XMLInput &, const Attribute &, const DataElement &)

string	getCategory () const

string	getDescription () const

string	getSubCategory () const

void	setCategory (const string &f)

void	setDescription (const string &f)

void	setSubCategory (const string &f)

void	writeElement (XMLOutput *, const Keyword &, mode=DEFAULT) const

Static Public Member Functions
static int	initialize ()

Static Public Member Functions inherited from frepple::Operation
static int	initialize ()

Static Public Member Functions inherited from frepple::utils::HasName< Operation >
static Operation *	add (const string &k, const MetaClass &cls)

static Operation *	add (Operation *t)

static Operation *	add (Operation t, Operation hint)

static iterator	begin ()

static void	clear ()

static bool	empty ()

static iterator	end ()

static Operation *	find (const string &k)

static Operation *	findLowerBound (const string &k, bool *f=NULL)

static Object *	reader (const MetaClass *cat, const AttributeList &in)

static size_t	size ()

static void	verify ()

static void	writer (const MetaCategory c, XMLOutput o)

Static Public Member Functions inherited from frepple::utils::Object
template<class T >
static PyObject *	create (PyTypeObject pytype, PyObject args, PyObject *kwds)

template<class T >
static Object *	createDefault ()

template<class T >
static Object *	createString (const string &n)

static PyObject *	toXML (PyObject , PyObject )

Static Public Member Functions inherited from frepple::HasLevel
static unsigned short	getNumberOfClusters ()

static unsigned short	getNumberOfHangingClusters ()

static void	triggerLazyRecomputation ()

Static Public Member Functions inherited from frepple::Plannable
static void	computeProblems ()

Static Public Member Functions inherited from frepple::HasProblems
static EntityIterator	beginEntity ()

static EntityIterator	endEntity ()

Static Public Attributes
static const MetaClass *	metadata

static const Operation *	setupoperation

Static Public Attributes inherited from frepple::Operation
static const MetaCategory *	metadata

Additional Inherited Members
Public Types inherited from frepple::Operation
typedef Association< Operation, Buffer, Flow >::ListA	flowlist

typedef Association< Operation, Resource, Load >::ListA	loadlist

typedef list< Operation * >	Operationlist

Protected Member Functions inherited from frepple::Operation
virtual bool	extraInstantiate (OperationPlan *o)

void	initOperationPlan (OperationPlan , double, const Date &, const Date &, Demand , OperationPlan *, unsigned long, bool=true) const

	Operation (const string &str)

Static Protected Member Functions inherited from frepple::utils::PythonExtensionBase
static PythonType *	registerPythonType (int, const type_info *)

Static Protected Member Functions inherited from frepple::HasLevel
static void	computeLevels ()

Static Protected Attributes inherited from frepple::utils::PythonExtensionBase
static vector< PythonType * >	table

Detailed Description

Models an operation to convert a setup on a resource.

Definition at line 2257 of file model.h.

Constructor & Destructor Documentation

frepple::OperationSetup::OperationSetup ( const string & s )

inlineexplicit

Constructor.

Definition at line 2261 of file model.h.

Member Function Documentation

virtual size_t frepple::OperationSetup::getSize ( ) const

inlinevirtual

Return the memory size of the object in bytes.

Implements frepple::utils::Object.

Definition at line 2271 of file model.h.

virtual const MetaClass& frepple::OperationSetup::getType ( ) const

inlinevirtual

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

Implements frepple::utils::Object.

Definition at line 2269 of file model.h.

int frepple::OperationSetup::initialize ( )

static

Definition at line 97 of file operation.cpp.

OperationPlanState frepple::OperationSetup::setOperationPlanParameters	(	OperationPlan *	opplan,
		double	q,
		Date	s,
		Date	e,
		bool	preferEnd = `true`,
		bool	execute = `true`
	)		const

virtual

A operation of this type enforces the following rules on its operationplans:

The duration is calculated based on the conversion type.

Implements frepple::Operation.

Definition at line 1305 of file operation.cpp.

virtual void frepple::OperationSetup::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::Operation.

Definition at line 2267 of file model.h.

void frepple::OperationSetup::writeElement	(	XMLOutput *	,
		const Keyword &	,
		mode	= `DEFAULT`
	)		const

inlinevirtual

Reimplemented from frepple::Operation.

Definition at line 2264 of file model.h.

Member Data Documentation

const MetaClass * frepple::OperationSetup::metadata

static

Definition at line 2270 of file model.h.

const Operation * frepple::OperationSetup::setupoperation

static

A pointer to the operation that is instantiated for all conversions.

Definition at line 2282 of file model.h.

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

C++ API - frepple::OperationSetup Class Reference

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation