A calendar storing double values in its buckets. More...

#include <model.h>

Inheritance diagram for frepple::CalendarDouble:

Classes
class	BucketDouble
	A special type of calendar bucket, designed to hold a a value. More...
class	EventIterator
	A special event iterator, providing also access to the current value. More...

Public Member Functions
	CalendarDouble (const string &n)
void	endElement (XMLInput &, const Attribute &, const DataElement &)
virtual PyObject *	getattro (const Attribute &)
virtual bool	getBool () const
double	getDefault () const
virtual const MetaClass &	getType () const
double	getValue (const Date d) const
double	getValue (Calendar::BucketIterator &i) const
virtual int	setattro (const Attribute &, const PythonObject &)
virtual void	setDefault (const double v)
void	setValue (Date start, Date end, const double v)
void	writeElement (XMLOutput *, const Keyword &, mode m=DEFAULT) const
	~CalendarDouble ()
Public Member Functions inherited from frepple::Calendar
Bucket *	addBucket (Date, Date, int=1)
BucketIterator	beginBuckets () const
void	beginElement (XMLInput &, const Attribute &)
	Calendar (const string &n)
Bucket *	createBucket (const AttributeList &)
BucketIterator	endBuckets () const
Bucket *	findBucket (Date d, bool fwd=true) const
Bucket *	findBucket (int ident) const
virtual size_t	getSize () const
void	removeBucket (Bucket *bkt)
	~Calendar ()
Public Member Functions inherited from frepple::utils::HasName< Calendar >
int	compare (const PyObject *other) const
	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
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)
Py_ssize_t	getReferenceCount () const
void	initType (const MetaClass *t)
void	initType (PyTypeObject *t)
virtual PyObject *	iternext ()
	PythonExtensionBase ()
void	resetReferenceCount ()
virtual	~PythonExtensionBase ()

Static Public Member Functions
static int	initialize ()
static PyObject *	setPythonValue (PyObject , PyObject , PyObject *)
Static Public Member Functions inherited from frepple::Calendar
static PyObject *	addPythonBucket (PyObject , PyObject , PyObject *)
static PyObject *	getEvents (PyObject , PyObject )
Static Public Member Functions inherited from frepple::utils::HasName< Calendar >
static Calendar *	add (const string &k, const MetaClass &cls)
static Calendar *	add (Calendar *t)
static Calendar *	add (Calendar t, Calendar hint)
static iterator	begin ()
static void	clear ()
static bool	empty ()
static iterator	end ()
static Calendar *	find (const string &k)
static Calendar *	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 Attributes
static const MetaClass *	metadata
Static Public Attributes inherited from frepple::Calendar

Additional Inherited Members
Protected Member Functions inherited from frepple::Calendar
int	lowestPriority () const

Detailed Description

A calendar storing double values in its buckets.

Definition at line 445 of file model.h.

Constructor & Destructor Documentation

frepple::CalendarDouble::CalendarDouble ( const string & n )

inline

Default constructor.

Definition at line 520 of file model.h.

frepple::CalendarDouble::~CalendarDouble ( )

Destructor.

Definition at line 175 of file calendar.cpp.

Member Function Documentation

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

Reimplemented from frepple::Calendar.

Definition at line 147 of file calendar.cpp.

PyObject * frepple::CalendarDouble::getattro ( const Attribute & attr )

virtual

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

Reimplemented from frepple::Calendar.

Definition at line 818 of file calendar.cpp.

virtual bool frepple::CalendarDouble::getBool ( ) const

inlinevirtual

Convert the value of the calendar to a boolean value.

Reimplemented from frepple::Calendar.

Definition at line 558 of file model.h.

double frepple::CalendarDouble::getDefault ( ) const

inline

Returns the default calendar value when no entry is matching.

Definition at line 555 of file model.h.

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

inlinevirtual

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

Reimplemented from frepple::Calendar.

Definition at line 526 of file model.h.

double frepple::CalendarDouble::getValue ( const Date d ) const

inline

Returns the value on the specified date.

Definition at line 538 of file model.h.

double frepple::CalendarDouble::getValue ( Calendar::BucketIterator & i ) const

inline

Definition at line 549 of file model.h.

int frepple::CalendarDouble::initialize ( )

static

Reimplemented from frepple::Calendar.

Definition at line 68 of file calendar.cpp.

int frepple::CalendarDouble::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::Calendar.

Definition at line 826 of file calendar.cpp.

virtual void frepple::CalendarDouble::setDefault ( const double v )

inlinevirtual

Update the default calendar value when no entry is matching.

Definition at line 561 of file model.h.

PyObject * frepple::CalendarDouble::setPythonValue	(	PyObject *	self,
		PyObject *	args,
		PyObject *	kwdict
	)

static

Definition at line 836 of file calendar.cpp.

void frepple::CalendarDouble::setValue	(	Date	start,
		Date	end,
		const double	v
	)

Updates the value in a certain date range.
This will create a new bucket if required.

Definition at line 105 of file calendar.cpp.

void frepple::CalendarDouble::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::Calendar.

Definition at line 120 of file calendar.cpp.

Member Data Documentation

const MetaClass * frepple::CalendarDouble::metadata

static

Reimplemented from frepple::Calendar.

Definition at line 527 of file model.h.

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

C++ API - frepple::CalendarDouble Class Reference

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation