iheader.h

Go to the documentation of this file.

/*
 * Copyright 2021 Ingemar Hedvall
 * SPDX-License-Identifier: MIT
 */
 
#pragma once
#include <optional>
#include <string>
#include <vector>
#include "mdf/iblock.h"
#include "itimestamp.h"
#include "imdftimestamp.h"
 
namespace mdf {
 
class IAttachment;
class IChannelHierarchy;
class IEvent;
class IFileHistory;
class IMetaData;
class IDataGroup;
 
class IHeader : public IBlock {
 public:
  virtual void Author(const std::string& author) = 0;
 
  [[nodiscard]] virtual std::string Author() const = 0;
 
  virtual void Department(const std::string& department) = 0;
 
  [[nodiscard]] virtual std::string Department() const = 0;
 
  virtual void Project(const std::string& name) = 0;
 
  [[nodiscard]] virtual std::string Project() const = 0;
 
  virtual void Subject(const std::string& subject) = 0;
 
  [[nodiscard]] virtual std::string Subject() const = 0;
 
  virtual void Description(const std::string& description) = 0;
 
  [[nodiscard]] virtual std::string Description() const = 0;
 
  virtual void MeasurementId(const std::string& uuid);
 
  [[nodiscard]] virtual std::string MeasurementId() const;
 
  virtual void RecorderId(const std::string& uuid);
 
  [[nodiscard]] virtual std::string RecorderId() const;
 
  virtual void RecorderIndex(int64_t index);
 
  [[nodiscard]] virtual int64_t RecorderIndex() const;
 
  virtual void StartTime(uint64_t ns_since_1970) = 0;
 
  virtual void StartTime(ITimestamp& timestamp) = 0;
 
  [[nodiscard]] virtual uint64_t StartTime() const = 0;
 
  [[nodiscard]] virtual const IMdfTimestamp* StartTimestamp() const = 0;
 
  [[nodiscard]] virtual IMetaData* CreateMetaData();
 
  [[nodiscard]] virtual IMetaData* MetaData() const;
 
  [[nodiscard]] virtual IAttachment* CreateAttachment();
 
  [[nodiscard]] virtual std::vector<IAttachment*> Attachments() const;
 
  [[nodiscard]] virtual IFileHistory* CreateFileHistory();
 
  [[nodiscard]] virtual std::vector<IFileHistory*> FileHistories() const;
 
#undef CreateEvent
  [[nodiscard]] virtual IEvent* CreateEvent();
 
  [[nodiscard]] virtual std::vector<IEvent*> Events() const;
 
  [[nodiscard]] virtual IChannelHierarchy* CreateChannelHierarchy();
 
  [[nodiscard]] virtual std::vector<IChannelHierarchy*> ChannelHierarchies()
      const;
 
  [[nodiscard]] virtual IDataGroup* CreateDataGroup() = 0;
 
  [[nodiscard]] virtual std::vector<IDataGroup*> DataGroups() const = 0;
 
  [[nodiscard]] virtual IDataGroup* LastDataGroup() const = 0;
 
  virtual void StartAngle(double angle);
 
  [[nodiscard]] virtual std::optional<double> StartAngle() const;
 
  virtual void StartDistance(double distance);
 
  [[nodiscard]] virtual std::optional<double> StartDistance() const;
 
 protected:
  ~IHeader() override = default;  
};
 
}  // end namespace mdf