Program Listing for File metadata_io.hpp

↰ Return to documentation for file (include/rosbag2_storage/metadata_io.hpp)

// Copyright 2018, Bosch Software Innovations GmbH.
//
// 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 ROSBAG2_STORAGE__METADATA_IO_HPP_
#define ROSBAG2_STORAGE__METADATA_IO_HPP_

#include <string>

#include "rosbag2_storage/bag_metadata.hpp"
#include "rosbag2_storage/visibility_control.hpp"

namespace rosbag2_storage
{

class MetadataIo
{
public:
  static constexpr const char * const metadata_filename = "metadata.yaml";

  virtual ~MetadataIo() = default;

  ROSBAG2_STORAGE_PUBLIC
  virtual void write_metadata(const std::string & uri, const BagMetadata & metadata);

  ROSBAG2_STORAGE_PUBLIC
  virtual BagMetadata read_metadata(const std::string & uri);

  ROSBAG2_STORAGE_PUBLIC
  virtual bool metadata_file_exists(const std::string & uri);

  ROSBAG2_STORAGE_PUBLIC
  virtual std::string serialize_metadata(const BagMetadata & metadata);

  ROSBAG2_STORAGE_PUBLIC
  virtual BagMetadata deserialize_metadata(const std::string & serialized_metadata);

private:
  std::string get_metadata_file_name(const std::string & uri);
};

}  // namespace rosbag2_storage

#endif  // ROSBAG2_STORAGE__METADATA_IO_HPP_