#include <value-types.hh>
Events are compared by year of occurrence.
Public Member Functions | |
Event (int when, const ustring &where, Qualifier qualifier=Q_NEUTRAL) throw () | |
Constructs a new defined event. | |
Event (Qualifier qualifier=Q_UNK) throw () | |
Constructs a new undefined or empty event. | |
virtual int | compare (const value_base &other) const throw () |
Compares two qualified values. | |
virtual ustring | get_string (const ustring &format=ustring()) const throw () |
Returns a localized text representation of the event. | |
Public Attributes | |
int | when |
The year in which the event occurred, if defined. | |
ustring | where |
The place in which the event occurred, if defined. | |
Protected Member Functions | |
virtual ustring | do_get_string (const ustring &format) const throw () |
Returns a localized text representation of a defined value. | |
virtual int | compare_base (const value_base &other) const throw () |
Compares the qualifications of two events. |
Elemental::Event::Event | ( | int | when, | |
const ustring & | where, | |||
Qualifier | qualifier = Q_NEUTRAL | |||
) | throw () |
Constructs a new defined event.
when | The year in which the event occurred. | |
where | The place in which the event occurred. | |
qualifier | The qualification of the event. |
Elemental::Event::Event | ( | Qualifier | qualifier = Q_UNK |
) | throw () |
Constructs a new undefined or empty event.
qualifier | The qualification of the event. |
virtual int Elemental::Event::compare | ( | const value_base & | other | ) | const throw () [virtual] |
Compares two qualified values.
Derived classes may override this function, first calling compare_base, and use a dynamic_cast to check other.
other | The qualified value for comparison. |
-1
if this value is undefined or is less than other
; 0
if the values are equal; or 1
if other
is undefined or this value is greater than other
. Reimplemented from Elemental::value_base.
virtual ustring Elemental::Event::get_string | ( | const ustring & | format = ustring() |
) | const throw () [virtual] |
Returns a localized text representation of the event.
format | An optional compose-style format string with which to output the value. The year is "%1" and the place is "%2". By default, the format is the localized version of "%1 (%2)" . |
Reimplemented from Elemental::value_base.
virtual ustring Elemental::Event::do_get_string | ( | const ustring & | format | ) | const throw () [protected, virtual] |
Returns a localized text representation of a defined value.
Derived classes must implement this function to produce a text representation based on the format. It will be called by get_string(), which will then decorate its output as appropriate for the current qualifier. If has_value() is false
, the behavior is undefined.
format | A compose-style format string. Derived classes may define the number of argument references expected in the string; the default is one. If format is empty, a minimal default should be used. |
Implements Elemental::value_base.