recording_merger.h

Go to the documentation of this file.

// === recording_merger.h ==============================================================================================
//                                               Sen Infrastructure
//                   Released under the Apache License v2.0 (SPDX-License-Identifier Apache-2.0).
//                                    See the LICENSE.txt file for more information.
//                   © Airbus SAS, Airbus Helicopters, and Airbus Defence and Space SAU/GmbH/SAS.
// =====================================================================================================================
 
#ifndef SEN_DB_RECORDING_MERGER_H
#define SEN_DB_RECORDING_MERGER_H
 
// sen
#include "sen/core/base/duration.h"
 
// std
#include <cstddef>
#include <cstdint>
#include <filesystem>
#include <functional>
#include <string>
#include <variant>
#include <vector>
 
namespace sen::db
{

enum class RecordingMergeMode
{
  normalMerge,
  zeroAligned,
  offsetAligned
};

class RecordingMergeObject
{
public:
  RecordingMergeObject(std::filesystem::path archivePath,
                       uint32_t objectId,
                       std::string session,
                       std::string bus,
                       std::string name,
                       std::string type);
 
  [[nodiscard]] const std::filesystem::path& getArchivePath() const noexcept;
 
  [[nodiscard]] uint32_t getObjectId() const noexcept;
 
  [[nodiscard]] const std::string& getSession() const noexcept;
 
  [[nodiscard]] const std::string& getBus() const noexcept;
 
  [[nodiscard]] const std::string& getName() const noexcept;
 
  [[nodiscard]] const std::string& getType() const noexcept;

  [[nodiscard]] std::string formatFullName() const;
 
private:
  std::filesystem::path archivePath_;
  uint32_t objectId_;
  std::string session_;
  std::string bus_;
  std::string name_;
  std::string type_;
};

struct RecordingMergeDuplicateObject
{
  std::vector<RecordingMergeObject> objects;
};

struct RecordingMergeObjectRename
{
  std::size_t objectIndex = 0U;
  std::string name;
};

struct RecordingMergeKeepSelectedObject
{
  std::size_t selectedObjectIndex = 0U;
};

struct RecordingMergeRenameObjects
{
  std::vector<RecordingMergeObjectRename> renamedObjects;
};

using RecordingMergeDuplicateObjectResolution =
  std::variant<RecordingMergeKeepSelectedObject, RecordingMergeRenameObjects>;

using RecordingMergeDuplicateObjectResolver =
  std::function<RecordingMergeDuplicateObjectResolution(const RecordingMergeDuplicateObject& duplicateObject)>;

using RecordingMergeProgressReporter = std::function<void(std::size_t bytesDone, std::size_t bytesTotal)>;

struct RecordingMergeInput
{
  std::filesystem::path archivePath;
  Duration offset {};
};

struct RecordingMergeSettings
{
  std::vector<RecordingMergeInput> inputArchives;
  std::filesystem::path outputArchive;
  RecordingMergeMode mode = RecordingMergeMode::normalMerge;
  RecordingMergeDuplicateObjectResolver duplicateObjectResolver;
  bool force = false;
  RecordingMergeProgressReporter progressReporter;
};

void mergeRecordings(const RecordingMergeSettings& settings);
 
}  // namespace sen::db
 
#endif  // SEN_DB_RECORDING_MERGER_H