TopicPattern Class Referencefinal
Specify a pattern of topics to query. More...
#include <QueryOptions.hh>
Public Member Functions | |
| TopicPattern (const std::regex &_pattern, const QualifiedTimeRange &_timeRange=QualifiedTimeRange::AllTime()) | |
| Query for topics that match a pattern, over a specified time range (by default, all time). More... | |
| TopicPattern (const TopicPattern &_other) | |
| Copy constructor. More... | |
| TopicPattern (TopicPattern &&_other) | |
| Move constructor. More... | |
| ~TopicPattern () | |
| Destructor. More... | |
| std::vector< SqlStatement > | GenerateStatements (const Descriptor &_descriptor) const override |
| Generate one or more SQL query statements to be used by the log file to produce a Batch of messages. More... | |
| std::regex & | Pattern () |
| Pattern for this option. More... | |
| const std::regex & | Pattern () const |
| Pattern for this option. More... | |
 Public Member Functions inherited from QueryOptions | |
| virtual | ~QueryOptions ()=default |
| Virtual destructor. More... | |
| Public Member Functions inherited from TimeRangeOption | |
| 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... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from QueryOptions | |
| static SqlStatement | StandardMessageQueryClose () |
| Get a standard ending to a SQL statement that will instruct the queries to be ordered by the time the messages were received by the logger. It will also end the statement with a semicolon. More... | |
| static SqlStatement | StandardMessageQueryPreamble () |
| Get a standard SQL statement preamble, from the SELECT keyword up to (but not including) the WHERE keyword. This preamble will make sure that the statement is formatted in a way that MsgIter will have the information it needs. More... | |
Detailed Description
Specify a pattern of topics to query.
Constructor & Destructor Documentation
◆ TopicPattern() [1/3]
| TopicPattern | ( | const std::regex & | _pattern, |
| const QualifiedTimeRange & | _timeRange = QualifiedTimeRange::AllTime() |
||
| ) |
Query for topics that match a pattern, over a specified time range (by default, all time).
- Parameters
-
[in] _pattern The initial pattern that this option should use [in] _timeRange The initial range of time for this option
◆ TopicPattern() [2/3]
| TopicPattern | ( | const TopicPattern & | _other | ) |
Copy constructor.
- Parameters
-
[in] _other Another TopicPattern
◆ TopicPattern() [3/3]
| TopicPattern | ( | TopicPattern && | _other | ) |
Move constructor.
- Parameters
-
[in] _other Another TopicPattern
◆ ~TopicPattern()
| ~TopicPattern | ( | ) |
Destructor.
Member Function Documentation
◆ GenerateStatements()
|
overridevirtual |
Generate one or more SQL query statements to be used by the log file to produce a Batch of messages.
- Parameters
-
[in] _descriptor A Descriptor to help form the SQL statements
- Returns
- One or more SQL statements.
Implements QueryOptions.
◆ Pattern() [1/2]
| std::regex& Pattern | ( | ) |
Pattern for this option.
- Returns
- A mutable reference to the regular expression pattern that this option will query for.
◆ Pattern() [2/2]
| const std::regex& Pattern | ( | ) | const |
Pattern for this option.
- Returns
- A const reference to the regular expression pattern that this option will query for.
The documentation for this class was generated from the following file: