QueryOptions.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/

#ifndef IGNITION_TRANSPORT_LOG_QUERYOPTIONS_HH_
#define IGNITION_TRANSPORT_LOG_QUERYOPTIONS_HH_

#include <memory>
#include <regex>
#include <set>
#include <string>
#include <vector>

#include <ignition/transport/config.hh>
#include <ignition/transport/log/Export.hh>
#include <ignition/transport/log/Descriptor.hh>
#include <ignition/transport/log/QualifiedTime.hh>
#include <ignition/transport/log/SqlStatement.hh>

namespace ignition
{
  namespace transport
  {
    namespace log
    {
      // Inline bracket to help doxygen filtering.
      inline namespace IGNITION_TRANSPORT_VERSION_NAMESPACE {
      //
      class IGNITION_TRANSPORT_LOG_VISIBLE QueryOptions
      {
        public: virtual std::vector<SqlStatement> GenerateStatements(
          const Descriptor &_descriptor) const = 0;

        public: static SqlStatement StandardMessageQueryPreamble();

        public: static SqlStatement StandardMessageQueryClose();

        public: virtual ~QueryOptions() = default;
      };

      class IGNITION_TRANSPORT_LOG_VISIBLE TimeRangeOption
      {
        public: explicit TimeRangeOption(const QualifiedTimeRange &_timeRange);

        public: TimeRangeOption(const TimeRangeOption &_other);

        public: TimeRangeOption(TimeRangeOption &&_other);  // NOLINT

        public: QualifiedTimeRange &TimeRange();

        public: const QualifiedTimeRange &TimeRange() const;

        public: SqlStatement GenerateTimeConditions() const;

        public: ~TimeRangeOption();

        private: class Implementation;

#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::*
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
        private: std::unique_ptr<Implementation> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
      };

      class IGNITION_TRANSPORT_LOG_VISIBLE TopicList final
          : public virtual QueryOptions,
            public virtual TimeRangeOption
      {
        public: TopicList(
          const std::set<std::string> &_topics = { },
          const QualifiedTimeRange &_timeRange = QualifiedTimeRange::AllTime());

        public: template <typename Container>
        static TopicList Create(
          const Container &_topics,
          const QualifiedTimeRange &_timeRange = QualifiedTimeRange::AllTime());

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

        public: TopicList(const TopicList &_other);

        public: TopicList(TopicList &&_other);  // NOLINT(whitespace/operators)

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

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

        // Documentation inherited
        public: std::vector<SqlStatement> GenerateStatements(
          const Descriptor &_descriptor) const override;

        public: ~TopicList();

        private: class Implementation;

#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::*
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
        private: std::unique_ptr<Implementation> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
      };

      class IGNITION_TRANSPORT_LOG_VISIBLE TopicPattern final
          : public virtual QueryOptions,
            public virtual TimeRangeOption
      {
        public: TopicPattern(
          const std::regex &_pattern,
          const QualifiedTimeRange &_timeRange = QualifiedTimeRange::AllTime());

        public: TopicPattern(const TopicPattern &_other);

        public: TopicPattern(TopicPattern &&_other);  // NOLINT

        public: std::regex &Pattern();

        public: const std::regex &Pattern() const;

        // Documentation inherited
        public: std::vector<SqlStatement> GenerateStatements(
          const Descriptor &_descriptor) const override;

        public: ~TopicPattern();

        private: class Implementation;

#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::*
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
        private: std::unique_ptr<Implementation> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
      };

      class IGNITION_TRANSPORT_LOG_VISIBLE AllTopics final
          : public virtual QueryOptions,
            public virtual TimeRangeOption
      {
        public: explicit AllTopics(
          const QualifiedTimeRange &_timeRange = QualifiedTimeRange::AllTime());

        public: AllTopics(const AllTopics &_other);

        public: AllTopics(AllTopics &&_other);  // NOLINT(whitespace/operators)

        // Documentation inherited
        public: std::vector<SqlStatement> GenerateStatements(
          const Descriptor &_descriptor) const override;

        public: ~AllTopics();

        private: class Implementation;

#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::*
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
        private: std::unique_ptr<Implementation> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
      };
      }
    }
  }
}

#include <ignition/transport/log/detail/QueryOptions.hh>

#endif