A qualified value representing the time and location of an event.
More...
#include <value-types.hh>
|
int | when |
| The year in which the event occurred, if defined.
|
|
ustring | where |
| The place in which the event occurred, if defined.
|
|
Qualifier | qualifier |
| The qualification of the value's meaning.
|
|
|
bool | always |
| Whether an undefined value should make an entry.
|
|
static const int | YIELD_COMPARE |
| Indicates that comparison should be based on values, not definedness.
|
|
A qualified value representing the time and location of an event.
Events are compared by year of occurrence.
◆ Event() [1/2]
Elemental::Event::Event |
( |
int |
when, |
|
|
const ustring & |
where, |
|
|
Qualifier |
qualifier = Q_NEUTRAL |
|
) |
| |
throw | ( | |
| ) | | |
Constructs a new defined event.
- Parameters
-
when | The year in which the event occurred. |
where | The place in which the event occurred. |
qualifier | The qualification of the event. |
◆ Event() [2/2]
Constructs a new undefined or empty event.
- Parameters
-
qualifier | The qualification of the event. |
◆ compare()
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.
- Parameters
-
other | The qualified value for comparison. |
- Returns
-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.
◆ compare_base()
virtual int Elemental::Event::compare_base |
( |
const value_base & |
other | ) |
const |
throw | ( | |
| ) | | |
|
protectedvirtual |
◆ do_get_string()
virtual ustring Elemental::Event::do_get_string |
( |
const ustring & |
format | ) |
const |
throw | ( | |
| ) | | |
|
protectedvirtual |
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.
- Parameters
-
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. |
- Returns
- A UTF-8 string containing the localized representation.
Implements Elemental::value_base.
◆ get_string()
virtual ustring Elemental::Event::get_string |
( |
const ustring & |
format = ustring() | ) |
const |
throw | ( | |
| ) | | |
|
virtual |
Returns a localized text representation of the event.
- Parameters
-
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)" . |
- Returns
- A UTF-8 string containing the localized representation.
Reimplemented from Elemental::value_base.
The documentation for this class was generated from the following file: