input.h

Go to the documentation of this file.

// === input.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_INPUT_H
#define SEN_DB_INPUT_H
 
// sen
#include "sen/core/meta/class_type.h"
#include "sen/core/meta/type.h"
#include "sen/core/meta/type_registry.h"
#include "sen/db/annotation.h"
#include "sen/db/creation.h"
#include "sen/db/cursor.h"
#include "sen/db/deletion.h"
#include "sen/db/event.h"
#include "sen/db/keyframe.h"
#include "sen/db/property_change.h"
 
// stl
#include "stl/sen/db/basic_types.stl.h"
 
// std
#include <filesystem>
 
namespace sen::db
{

struct KeyframeIndex
{
  uint64_t offset;
  TimeStamp time;
};

struct ObjectIndexDef
{
  ConstTypeHandle<ClassType> type;
  ObjectId objectId;
  std::string name;
  std::string session;
  std::string bus;
  uint32_t indexId;
};

class End
{
};

using DataCursor = Cursor<End, PropertyChange, Event, Keyframe, Creation, Deletion>;

using AnnotationCursor = Cursor<End, Annotation>;

class Input final
{
  SEN_NOCOPY_NOMOVE(Input)
 
public:
  Input(std::filesystem::path path, CustomTypeRegistry& nativeTypes);
  ~Input();
 
public:
  [[nodiscard]] const std::filesystem::path& getPath() const noexcept;

  [[nodiscard]] const Summary& getSummary() const noexcept;

  [[nodiscard]] const CustomTypeRegistry& getTypes() const noexcept;

  [[nodiscard]] DataCursor begin();

  [[nodiscard]] AnnotationCursor annotationsBegin();

  [[nodiscard]] DataCursor at(const KeyframeIndex& index);

  [[nodiscard]] DataCursor makeCursor(const ObjectIndexDef& indexDef);

  void addAnnotation(TimeStamp time, const Type* type, std::vector<uint8_t>&& value);
 
public:
  [[nodiscard]] Span<const ObjectIndexDef> getObjectIndexDefinitions();

  [[nodiscard]] Span<const KeyframeIndex> getAllKeyframeIndexes();

  [[nodiscard]] std::optional<KeyframeIndex> getKeyframeIndex(TimeStamp time);
 
private:
  class Impl;
  std::unique_ptr<Impl> pimpl_;
};
 
}  // namespace sen::db
 
#endif  // SEN_DB_INPUT_H