List of all members.
Detailed Description
This class represents a time bucket as a part of a calendar.
Manipulation of instances of this class need to be handled with the methods on the friend class Calendar.
- See also:
- Calendar
Definition at line 106 of file model.h.
Constructor & Destructor Documentation
frepple::Calendar::Bucket::Bucket |
( |
Calendar * |
c, |
|
|
Date |
start, |
|
|
Date |
end, |
|
|
string |
name | |
|
) |
| | [inline, protected] |
Constructor.
Definition at line 149 of file model.h.
Member Function Documentation
bool frepple::Calendar::Bucket::checkValid |
( |
Date |
d |
) |
const [inline] |
Verifies whether this entry is effective on a given date.
Definition at line 215 of file model.h.
PyObject * frepple::Calendar::Bucket::getattro |
( |
const Attribute & |
attr |
) |
[virtual] |
virtual bool frepple::Calendar::Bucket::getBool |
( |
|
) |
const [inline, virtual] |
Calendar* frepple::Calendar::Bucket::getCalendar |
( |
|
) |
const [inline] |
Return the calendar to whom the bucket belongs.
Definition at line 158 of file model.h.
Date frepple::Calendar::Bucket::getEnd |
( |
|
) |
const [inline] |
Returns the end date of the bucket.
Definition at line 189 of file model.h.
string frepple::Calendar::Bucket::getName |
( |
|
) |
const [inline] |
Returns the name of the bucket. If no name was ever explicitly specified with the setName() method, a default name is generated by converting the start date into a string.
To reduce the memory needs, this default string is computed with every call to the getName() method and never stored internally. Only explicitly specified names are kept in memory.
Definition at line 179 of file model.h.
int frepple::Calendar::Bucket::getPriority |
( |
|
) |
const [inline] |
Returns the priority of this bucket, compared to other buckets effective at a certain time.
Lower numbers indicate a higher priority level.
The default value is 0.
Definition at line 205 of file model.h.
virtual size_t frepple::Calendar::Bucket::getSize |
( |
|
) |
const [inline, virtual] |
Date frepple::Calendar::Bucket::getStart |
( |
|
) |
const [inline] |
Returns the start date of the bucket.
Definition at line 195 of file model.h.
virtual const MetaClass& frepple::Calendar::Bucket::getType |
( |
|
) |
const [inline, virtual] |
void frepple::Calendar::Bucket::getValue |
( |
|
) |
const [inline] |
int frepple::Calendar::Bucket::initialize |
( |
|
) |
[static] |
void frepple::Calendar::Bucket::setEnd |
( |
const Date & |
d |
) |
[inline] |
Updates the end date of the bucket.
Definition at line 192 of file model.h.
void frepple::Calendar::Bucket::setName |
( |
const string & |
s |
) |
[inline] |
Updates the name of a bucket.
Definition at line 186 of file model.h.
void frepple::Calendar::Bucket::setPriority |
( |
int |
f |
) |
[inline] |
Updates the priority of this bucket, compared to other buckets effective at a certain time.
Lower numbers indicate a higher priority level.
The default value is 0.
Definition at line 212 of file model.h.
void frepple::Calendar::Bucket::setStart |
( |
const Date & |
d |
) |
[inline] |
Updates the end date of the bucket.
Definition at line 198 of file model.h.
void frepple::Calendar::Bucket::setValue |
( |
|
) |
[inline] |
This method is here only to keep the API of all calendar classes consistent.
Definition at line 170 of file model.h.
bool frepple::Calendar::Bucket::useDefaultName |
( |
|
) |
const [inline] |
Returns true if the name of the bucket has not been explicitly specified.
Definition at line 183 of file model.h.
void frepple::Calendar::Bucket::writeElement |
( |
XMLOutput * |
o, |
|
|
const Keyword & |
tag, |
|
|
mode |
m = DEFAULT | |
|
) |
| | const [virtual] |
void frepple::Calendar::Bucket::writeHeader |
( |
XMLOutput * |
o, |
|
|
const Keyword & |
tag | |
|
) |
| | const [protected] |
Auxilary function to write out the start of the XML.
Definition at line 387 of file calendar.cpp.
Friends And Related Function Documentation
Member Data Documentation
The documentation for this class was generated from the following files: