A special type of calendar bucket, designed to hold a a value. More...

#include <model.h>

Inheritance diagram for frepple::CalendarDouble::BucketDouble:

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

bool	getBool () const

virtual size_t	getSize () const

virtual const MetaClass &	getType () const

double	getValue () const

void	setValue (const double v)

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

Public Member Functions inherited from frepple::Calendar::Bucket
virtual PyObject *	getattro (const Attribute &)

Calendar *	getCalendar () const

short	getDays () const

Date	getEnd () const

TimePeriod	getEndTime () const

int	getId () const

int	getPriority () const

Date	getStart () const

TimePeriod	getStartTime () const

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

void	setDays (short p)

void	setEnd (const Date d)

void	setEndTime (TimePeriod t)

void	setId (int ident=INT_MIN)

void	setPriority (int f)

void	setStart (const Date d)

void	setStartTime (TimePeriod t)

Public Member Functions inherited from frepple::utils::Object
virtual void	beginElement (XMLInput &, const Attribute &)

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)

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 ()

Static Public Member Functions
static int	initialize ()

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

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::Bucket
static const MetaCategory *	metadata

Friends
class	CalendarDouble

Additional Inherited Members
Protected Member Functions inherited from frepple::Calendar::Bucket
	Bucket (Calendar *c, Date start, Date end, int ident=INT_MIN, int priority=0)

void	writeHeader (XMLOutput *, const Keyword &) const

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

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

Detailed Description

A special type of calendar bucket, designed to hold a a value.

See Also: Calendar::Bucket

Definition at line 452 of file model.h.

Member Function Documentation

void frepple::CalendarDouble::BucketDouble::endElement	(	XMLInput &	pIn,
		const Attribute &	pAttr,
		const DataElement &	pElement
	)

inlinevirtual

Reads the bucket information from the input. Only the fields "name" and "start" are read in. Other fields as also written out but these are information-only fields.

Reimplemented from frepple::Calendar::Bucket.

Definition at line 483 of file model.h.

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

inlinevirtual

Convert the value of the bucket to a boolean value.

Reimplemented from frepple::Calendar::Bucket.

Definition at line 468 of file model.h.

virtual size_t frepple::CalendarDouble::BucketDouble::getSize ( ) const

inlinevirtual

Return the memory size of the object in bytes.

Reimplemented from frepple::Calendar::Bucket.

Definition at line 492 of file model.h.

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

inlinevirtual

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

Reimplemented from frepple::Calendar::Bucket.

Definition at line 496 of file model.h.

double frepple::CalendarDouble::BucketDouble::getValue ( ) const

inline

Returns the value of this bucket.

Definition at line 465 of file model.h.

int frepple::CalendarDouble::BucketDouble::initialize ( )

static

Definition at line 88 of file calendar.cpp.

void frepple::CalendarDouble::BucketDouble::setValue ( const double v )

inline

Updates the value of this bucket.

Definition at line 471 of file model.h.

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

inlinevirtual

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

Definition at line 474 of file model.h.

Friends And Related Function Documentation

friend class CalendarDouble

friend

Definition at line 454 of file model.h.

Member Data Documentation

const MetaClass * frepple::CalendarDouble::BucketDouble::metadata

static

Definition at line 495 of file model.h.

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

C++ API - frepple::CalendarDouble::BucketDouble Class Reference

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation