ifilehistory.h

Go to the documentation of this file.

/*
 * Copyright 2022 Ingemar Hedvall
 * SPDX-License-Identifier: MIT
 */
 
#pragma once
#include <cstdint>
#include <string>
 
#include "imdftimestamp.h"
#include "itimestamp.h"
#include "mdf/iblock.h"
#include "mdf/imetadata.h"
 
namespace mdf {
 
class IFileHistory : public IBlock {
 public:
  virtual void Time(uint64_t ns_since_1970) = 0;
 
  virtual void Time(ITimestamp& timestamp) = 0;
 
  [[nodiscard]] virtual uint64_t Time() const = 0;
  
  [[nodiscard]] virtual const mdf::IMdfTimestamp* StartTimestamp() const = 0;
 
  [[nodiscard]] virtual IMetaData* CreateMetaData() = 0;
 
  [[nodiscard]] virtual const IMetaData* MetaData() const = 0;
 
  void Description(const std::string& description) {
    auto* md4 = CreateMetaData();
    if (md4 != nullptr) {
      md4->StringProperty("TX", description);
    }
  }
 
  [[nodiscard]] std::string Description() const {
    const auto* md4 = MetaData();
    return md4 != nullptr ? md4->StringProperty("TX") : std::string();
  }
 
  void ToolName(const std::string& tool_name) {
    auto* md4 = CreateMetaData();
    if (md4 != nullptr) {
      md4->StringProperty("tool_id", tool_name);
    }
  }
 
  [[nodiscard]] std::string ToolName() const {
    const auto* md4 = MetaData();
    return md4 != nullptr ? md4->StringProperty("tool_id") : std::string();
  }
 
  void ToolVendor(const std::string& tool_vendor) {
    auto* md4 = CreateMetaData();
    if (md4 != nullptr) {
      md4->StringProperty("tool_vendor", tool_vendor);
    }
  }
 
  [[nodiscard]] std::string ToolVendor() const {
    const auto* md4 = MetaData();
    return md4 != nullptr ? md4->StringProperty("tool_vendor") : std::string();
  }
 
  void ToolVersion(const std::string& tool_version) {
    auto* md4 = CreateMetaData();
    if (md4 != nullptr) {
      md4->StringProperty("tool_version", tool_version);
    }
  }
 
  [[nodiscard]] std::string ToolVersion() const {
    const auto* md4 = MetaData();
    return md4 != nullptr ? md4->StringProperty("tool_version") : std::string();
  }
 
  void UserName(const std::string& user) {
    auto* md4 = CreateMetaData();
    if (md4 != nullptr) {
      md4->StringProperty("user_name", user);
    }
  }
 
  [[nodiscard]] std::string UserName() const {
    const auto* md4 = MetaData();
    return md4 != nullptr ? md4->StringProperty("user_name") : std::string();
  }
};
 
}  // namespace mdf