ListModeData.h

Go to the documentation of this file.

/*
    Copyright (C) 2003 - 2011-06-24, Hammersmith Imanet Ltd
    Copyright (C) 2011-07-01 - 2014, Kris Thielemans
    Copyright (C) 2019, National Physical Laboratory
    Copyright (C) 2019, University College of London
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0

    See STIR/LICENSE.txt for details
*/
#ifndef __stir_listmode_ListModeData_H__
#define __stir_listmode_ListModeData_H__

#include <string>
#include <ctime>
#include "stir/ProjDataInfo.h"
#include "stir/ExamData.h"
#include "stir/RegisteredParsingObject.h"
#include "stir/listmode/ListRecord.h"
#include "stir/error.h"
#ifdef BOOST_NO_STDC_NAMESPACE
namespace std
{
using ::time_t;
}
#endif

START_NAMESPACE_STIR
class ListRecord;
class Succeeded;
class ExamInfo;

class ListModeData : public ExamData
{
public:
  typedef ListModeData hierarchy_base_type;

  typedef unsigned int SavedPosition;

  ListModeData();

  ~ListModeData() override;


  virtual std::string get_name() const = 0;

  //  //! Get const pointer to exam info
  //  const ExamInfo*
  //    get_exam_info_ptr() const;
  //  //! Get shared pointer to exam info
  //  /*! \warning Use with care. If you modify the object pointer to by a shared ptr, all objects using the same
  //    shared pointer will be affected. */
  //  shared_ptr<ExamInfo>
  //    get_exam_info_sptr() const;

#if 0

  virtual
    std::time_t
    get_scan_start_time_in_secs_since_1970() const;
#endif


  shared_ptr<ListRecord> get_empty_record_sptr() const
  {
    return this->get_empty_record_helper_sptr();
  }

  virtual Succeeded get_next_record(ListRecord& event) const
  {
    return get_next(event);
  }

  virtual Succeeded reset() = 0;


  virtual SavedPosition save_get_position() = 0;


  virtual Succeeded set_get_position(const SavedPosition&) = 0;


  const Scanner& get_scanner() const;

  virtual bool has_delayeds() const = 0;
  virtual inline unsigned long int get_total_number_of_events() const
  {
    error("ListModeData: The function get_total_number_of_events() is currently not supported for this file format.");
    return 0;
  }

  virtual shared_ptr<const ProjDataInfo> get_proj_data_info_sptr() const;

protected:
  virtual shared_ptr<ListRecord> get_empty_record_helper_sptr() const = 0;
  virtual Succeeded get_next(ListRecord& event) const = 0;
  virtual void set_proj_data_info_sptr(shared_ptr<const ProjDataInfo>);
  //  shared_ptr<ExamInfo> exam_info_sptr;
  shared_ptr<const ProjDataInfo> proj_data_info_sptr;
};

END_NAMESPACE_STIR

#endif