frepple::CalendarPointer< T >::BucketPointer Class Reference

A special type of calendar bucket, designed to hold a pointer to an object. More...

#include <model.h>

Inheritance diagram for frepple::CalendarPointer< T >::BucketPointer:
frepple::Calendar::Bucket frepple::utils::Object frepple::utils::NonCopyable frepple::utils::PythonExtensionBase

List of all members.

Public Member Functions

void beginElement (XMLInput &pIn, const Attribute &pAttr)
void endElement (XMLInput &pIn, const Attribute &pAttr, const DataElement &pElement)
bool getBool () const
virtual size_t getSize () const
virtual const MetaClassgetType () const
T * getValue () const
void setValue (T *v)
void writeElement (XMLOutput *o, const Keyword &tag, mode m=DEFAULT) const

Friends

class CalendarPointer< T >

Detailed Description

template<typename T>
class frepple::CalendarPointer< T >::BucketPointer

A special type of calendar bucket, designed to hold a pointer to an object.

See also:
Calendar::Bucket

Definition at line 570 of file model.h.


Member Function Documentation

template<typename T>
void frepple::CalendarPointer< T >::BucketPointer::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 from frepple::utils::Object.

Definition at line 601 of file model.h.

template<typename T>
void frepple::CalendarPointer< T >::BucketPointer::endElement ( XMLInput pIn,
const Attribute pAttr,
const DataElement pElement 
) [inline, virtual]

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 611 of file model.h.

template<typename T>
bool frepple::CalendarPointer< T >::BucketPointer::getBool (  )  const [inline, virtual]

Convert the value of the bucket to a boolean value.

Reimplemented from frepple::Calendar::Bucket.

Definition at line 586 of file model.h.

template<typename T>
virtual size_t frepple::CalendarPointer< T >::BucketPointer::getSize (  )  const [inline, virtual]

Return the memory size of the object in bytes.

Reimplemented from frepple::Calendar::Bucket.

Definition at line 628 of file model.h.

template<typename T>
virtual const MetaClass& frepple::CalendarPointer< T >::BucketPointer::getType (  )  const [inline, virtual]

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 625 of file model.h.

template<typename T>
T* frepple::CalendarPointer< T >::BucketPointer::getValue (  )  const [inline]

Returns the value stored in this bucket.

Reimplemented from frepple::Calendar::Bucket.

Definition at line 583 of file model.h.

template<typename T>
void frepple::CalendarPointer< T >::BucketPointer::setValue ( T *  v  )  [inline]

Updates the value of this bucket.

Definition at line 589 of file model.h.

template<typename T>
void frepple::CalendarPointer< T >::BucketPointer::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 from frepple::Calendar::Bucket.

Definition at line 592 of file model.h.


Friends And Related Function Documentation

template<typename T>
friend class CalendarPointer< T > [friend]

Definition at line 572 of file model.h.


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

Generated on 21 Mar 2010 for frePPLe by  doxygen 1.6.1