Recorder.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2017 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_RECORDER_HH_
#define IGNITION_TRANSPORT_LOG_RECORDER_HH_

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

#include <ignition/transport/Clock.hh>
#include <ignition/transport/config.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 {
      //
      enum class RecorderError : int64_t
      {
        SUCCESS = 0,
        FAILED_TO_OPEN = -1,
        FAILED_TO_SUBSCRIBE = -2,
        ALREADY_RECORDING = -3,
        INVALID_TOPIC = -4,
        TOPIC_NOT_FOUND = -5,
        ALREADY_SUBSCRIBED_TO_TOPIC = -6,
      };

      class IGNITION_TRANSPORT_LOG_VISIBLE Recorder
      {
        public: Recorder();

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

        public: ~Recorder();

        public: RecorderError Sync(const Clock *_clockIn);

        public: RecorderError Start(const std::string &_file);

        public: void Stop();

        public: RecorderError AddTopic(const std::string &_topic);

        public: int64_t AddTopic(const std::regex &_topic);

        public: std::string Filename() const;

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

        public: std::size_t BufferSize() const;

        public: void SetBufferSize(std::size_t _size);

        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