Gazebo Transport

API Reference

13.4.0

Specify a list of topics to query. More...

#include <QueryOptions.hh>

Public Member Functions

 TopicList (const std::set< std::string > &_topics={ }, const QualifiedTimeRange &_timeRange=QualifiedTimeRange::AllTime())
 Query for a list of topics over the specified time range (by default, all time). More...
 
 TopicList (const std::string &_singleTopic, const QualifiedTimeRange &_timeRange=QualifiedTimeRange::AllTime())
 Query for a single topic over the specified time range (by default, all time). More...
 
 TopicList (const TopicList &_other)
 Copy constructor. More...
 
 TopicList (TopicList &&_other)
 Move constructor. More...
 
 ~TopicList ()
 Destructor. More...
 
std::vector< SqlStatementGenerateStatements (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::set< std::string > & Topics ()
 Topics of this TopicList. More...
 
const std::set< std::string > & Topics () const
 Topics of this TopicList. 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...
 
QualifiedTimeRangeTimeRange ()
 Chosen time range. More...
 
const QualifiedTimeRangeTimeRange () const
 Chosen time range. More...
 

Static Public Member Functions

template<typename Container >
static TopicList Create (const Container &_topics, const QualifiedTimeRange &_timeRange=QualifiedTimeRange::AllTime())
 Factory function that accepts any container type that can be passed through a range-for loop. This will insert the contents of _topics into a blank TopicList and then return it. More...
 
- 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 list of topics to query.

Constructor & Destructor Documentation

◆ TopicList() [1/4]

TopicList ( const std::set< std::string > &  _topics = { },
const QualifiedTimeRange _timeRange = QualifiedTimeRange::AllTime() 
)

Query for a list of topics over the specified time range (by default, all time).

Parameters
[in]_topicsThe topics to include
[in]_timeRangeThe time range to query over

◆ TopicList() [2/4]

TopicList ( const std::string _singleTopic,
const QualifiedTimeRange _timeRange = QualifiedTimeRange::AllTime() 
)

Query for a single topic over the specified time range (by default, all time).

Parameters
[in]_singleTopicThe one topic to query for
[in]_timeRangeThe time range to query over

◆ TopicList() [3/4]

TopicList ( const TopicList _other)

Copy constructor.

Parameters
[in]_otherAnother TopicList

◆ TopicList() [4/4]

TopicList ( TopicList &&  _other)

Move constructor.

Parameters
[in]_otherAnother TopicList

◆ ~TopicList()

~TopicList ( )

Destructor.

Member Function Documentation

◆ Create()

static TopicList Create ( const Container &  _topics,
const QualifiedTimeRange _timeRange = QualifiedTimeRange::AllTime() 
)
static

Factory function that accepts any container type that can be passed through a range-for loop. This will insert the contents of _topics into a blank TopicList and then return it.

Parameters
[in]_topicsThe topics to include
[in]_timeRangeThe time range to query over

◆ GenerateStatements()

std::vector<SqlStatement> GenerateStatements ( const Descriptor _descriptor) const
overridevirtual

Generate one or more SQL query statements to be used by the log file to produce a Batch of messages.

Parameters
[in]_descriptorA Descriptor to help form the SQL statements
Returns
One or more SQL statements.

Implements QueryOptions.

◆ Topics() [1/2]

std::set<std::string>& Topics ( )

Topics of this TopicList.

Returns
A mutable reference to the topics that this TopicList should query for.

◆ Topics() [2/2]

const std::set<std::string>& Topics ( ) const

Topics of this TopicList.

A const reference to the topics that this TopicList should query for.


The documentation for this class was generated from the following file: