InputStreamWithRecords.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2003- 2011, Hammersmith Imanet Ltd
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0

    See STIR/LICENSE.txt for details
*/

#ifndef __stir_IO_InputStreamWithRecords_H__
#define __stir_IO_InputStreamWithRecords_H__

#include "stir/shared_ptr.h"
#include "stir/Succeeded.h"

#include <iostream>
#include <string>
#include <vector>

START_NAMESPACE_STIR


template <class RecordT, class OptionsT>
class InputStreamWithRecords
{
public:
  typedef std::vector<std::streampos>::size_type SavedPosition;

  inline InputStreamWithRecords(const shared_ptr<std::istream>& stream_ptr,
                                const std::size_t size_of_record_signature,
                                const std::size_t max_size_of_record,
                                const OptionsT& options);


  inline InputStreamWithRecords(const std::string& filename,
                                const std::size_t size_of_record_signature,
                                const std::size_t max_size_of_record,
                                const OptionsT& options,
                                const std::streampos start_of_data = 0);

  virtual ~InputStreamWithRecords() {}

  inline virtual Succeeded get_next_record(RecordT& record) const;

  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>&);

  inline std::istream& get_stream() { return *this->stream_ptr; }

private:
  shared_ptr<std::istream> stream_ptr;
  const std::string filename;

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

  const std::size_t size_of_record_signature;
  const std::size_t max_size_of_record;

  const OptionsT options;
};

END_NAMESPACE_STIR

#include "stir/IO/InputStreamWithRecords.inl"

#endif