TimeRangeOption Class Reference
Base class which manages the time range settings for the native QueryOptions classes. More...
#include <QueryOptions.hh>
Public Member Functions | |
TimeRangeOption (const QualifiedTimeRange &_timeRange) | |
Constructor that sets the initial time range option. More... | |
TimeRangeOption (const TimeRangeOption &_other) | |
Copy constructor. More... | |
TimeRangeOption (TimeRangeOption &&_other) | |
Move constructor. More... | |
~TimeRangeOption () | |
Destructor. More... | |
SqlStatement | GenerateTimeConditions () const |
Generate a SQL string to represent the time conditions. This should be appended to a SQL statement after a WHERE keyword. More... | |
QualifiedTimeRange & | TimeRange () |
Chosen time range. More... | |
const QualifiedTimeRange & | TimeRange () const |
Chosen time range. More... | |
Detailed Description
Base class which manages the time range settings for the native QueryOptions classes.
Constructor & Destructor Documentation
◆ TimeRangeOption() [1/3]
|
explicit |
Constructor that sets the initial time range option.
- Parameters
-
[in] _timeRange The time range.
◆ TimeRangeOption() [2/3]
TimeRangeOption | ( | const TimeRangeOption & | _other | ) |
Copy constructor.
- Parameters
-
[in] _other Another TimeRangeOption
◆ TimeRangeOption() [3/3]
TimeRangeOption | ( | TimeRangeOption && | _other | ) |
Move constructor.
- Parameters
-
[in] _other Another TimeRangeOption
◆ ~TimeRangeOption()
~TimeRangeOption | ( | ) |
Destructor.
Member Function Documentation
◆ GenerateTimeConditions()
SqlStatement GenerateTimeConditions | ( | ) | const |
Generate a SQL string to represent the time conditions. This should be appended to a SQL statement after a WHERE keyword.
- Returns
- A partial SqlStatement that specifies the time conditions that this TimeRangeOption has been set with.
◆ TimeRange() [1/2]
QualifiedTimeRange& TimeRange | ( | ) |
Chosen time range.
- Returns
- A mutable reference to the time range that should be queried for.
◆ TimeRange() [2/2]
const QualifiedTimeRange& TimeRange | ( | ) | const |
Chosen time range.
- Returns
- A const reference to the time range that should be queried for.
The documentation for this class was generated from the following file: