InputStreamWithRecordsFromHDF5.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2016-2018, 2020-2021 University College London
    Copyright (C) 2016-2019, University of Leeds
    Copyright (C) 2016-2018, University of Hull

    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0

    See STIR/LICENSE.txt for details
*/

#ifndef __stir_IO_InputStreamWithRecordsFromHDF5_H__
#define __stir_IO_InputStreamWithRecordsFromHDF5_H__

#include "stir/shared_ptr.h"
#include "stir/Succeeded.h"
#include "stir/IO/GEHDF5Wrapper.h"
#include "boost/shared_array.hpp"
#include <string>
#include <iostream>
#include <vector>

START_NAMESPACE_STIR

namespace GE
{
namespace RDF_HDF5
{


template <class RecordT>
class InputStreamWithRecordsFromHDF5
{
public:
  typedef std::vector<std::streampos>::size_type SavedPosition;

  //  explicit
  //    InputStreamWithRecordsFromHDF5(const shared_ptr<H5::DataSet>& ,
  //                           const std::size_t size_of_record_signature,
  //                           const std::size_t max_size_of_record);

  explicit InputStreamWithRecordsFromHDF5(const std::string& filename,
                                          const std::size_t size_of_record_signature,
                                          const std::size_t max_size_of_record);

  virtual ~InputStreamWithRecordsFromHDF5() {}

  inline virtual Succeeded get_next_record(RecordT& record);

  virtual Succeeded set_up();

  inline Succeeded reset();


  inline SavedPosition save_get_position();

  inline Succeeded set_get_position(const SavedPosition&);


  inline std::vector<std::streampos> get_saved_get_positions() const;

  inline void set_saved_get_positions(const std::vector<std::streampos>&);

private:
  shared_ptr<GEHDF5Wrapper> input_sptr;

  boost::shared_array<char> data_sptr;

  uint64_t m_list_size = 0;

  std::streampos starting_stream_position;
  mutable std::streampos current_offset;
  std::vector<std::streampos> saved_get_positions;

  const std::string m_filename;
  const std::size_t size_of_record_signature;
  const std::size_t max_size_of_record;

  void read_data(char* output, const std::streampos offset, const hsize_t size) const;
  // members for buffering

  boost::shared_array<char> buffer;
  std::size_t max_buffer_size;
  mutable std::size_t buffer_size;
  mutable std::streampos start_of_buffer_offset;
  void fill_buffer(const std::streampos offset) const;
};

} // namespace RDF_HDF5
} // namespace GE
END_NAMESPACE_STIR

#include "stir/IO/InputStreamWithRecordsFromHDF5.inl"

#endif