Class MdfReader

lib/mdflib/include/mdf/mdfreader.h:84–278

\class MdfReader mdfreader.h "mdf/mdfreader.h" * \brief Reader interface to an MDF file. * * This is the main interface when reading MDF3 and MDF4 files. */

 * This is the main interface when reading MDF3 and MDF4 files.
 */
class MdfReader {
 public:
  /** \brief Constructor for readers using an external file.
   *
   * This constructor is used when reading from an external file. The other
   * way of reading from a C++ stream buffer. The latter is more complicated
   * but more generic as it support environment without a file block
   * storage.
   *
   * @param filename Full file path to the input file.
   */
  explicit MdfReader(std::string filename);

  explicit MdfReader(const std::shared_ptr<std::streambuf>& buffer);
  virtual ~MdfReader();  ///< Destructor that close any open file and destructs.

  MdfReader() = delete;
  MdfReader(const MdfReader&) = delete;
  MdfReader(MdfReader&&) = delete;
  MdfReader& operator=(const MdfReader&) = delete;
  MdfReader& operator=(MdfReader&&) = delete;

  /**
   * Unique index for this reader. This index is typically used when fetching
   * files from a database. The index itself is not used by the reader.
   * @return An unique index.
   */
  [[nodiscard]] int64_t Index() const { return index_; }

  /**
   * Sets a unique index to this reader or actually its file. This index is
   * typically retrieved from a database and makes finding files much easier
   * than comparing paths.
   * @param index Unique index.
   */
  void Index(int64_t index) { index_ = index; }

  /// Checks if the file was read without errors.
  /// \return True if the file was read OK.
  [[nodiscard]] bool IsOk() const { return static_cast<bool>(instance_); }

  /** \brief Return true if the file is marked as finalized
   *
   * This function returns true if the file is marked as finalized. This
   * is done by checking the ID block.
   * @return True if the file is marked as finalized.
   */
  [[nodiscard]] bool IsFinalized() const;

  /// Returns a pointer to the MDF file. This file holds references to the MDF
  /// blocks. \return Pointer to the MDF file object. Note it may return a null
  /// pointer.
  [[nodiscard]] const MdfFile* GetFile() const { return instance_.get(); }

  /** \brief Returns the header (HD) block. */
  [[nodiscard]] const IHeader* GetHeader() const;
  /** \brief Returns the data group (DG) block. */
  [[nodiscard]] IDataGroup* GetDataGroup(size_t order) const;