Log.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_LOG_HH_
#define IGNITION_TRANSPORT_LOG_LOG_HH_

#include <chrono>
#include <ios>
#include <memory>
#include <string>

#include <ignition/transport/config.hh>
#include <ignition/transport/log/Batch.hh>
#include <ignition/transport/log/QueryOptions.hh>
#include <ignition/transport/log/Descriptor.hh>
#include <ignition/transport/log/Export.hh>

namespace ignition
{
  namespace transport
  {
    namespace log
    {
      // Inline bracket to help doxygen filtering.
      inline namespace IGNITION_TRANSPORT_VERSION_NAMESPACE {
      //
      const std::string SchemaLocationEnvVar = "IGN_TRANSPORT_LOG_SQL_PATH";

      class IGNITION_TRANSPORT_LOG_VISIBLE Log
      {
        public: Log();

        public: Log(Log &&_old);  // NOLINT

        public: ~Log();

        public: bool Valid() const;

        public: std::string Version() const;

        public: bool Open(const std::string &_file,
            std::ios_base::openmode _mode = std::ios_base::in);

        public: std::string Filename() const;

        public: const log::Descriptor *Descriptor() const;

        public: bool InsertMessage(
            const std::chrono::nanoseconds &_time,
            const std::string &_topic, const std::string &_type,
            const void *_data, std::size_t _len);

        public: Batch QueryMessages(
            const QueryOptions &_options = AllTopics());

        public: std::chrono::nanoseconds StartTime() const;

        public: std::chrono::nanoseconds EndTime() const;

        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
      };
      }
    }
  }
}
#endif