reader.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2010-11-01
 * Last modified: 2019-05-21
 *
 * License: GPL3
 *
 * Description:
 *
 *   A Boost archive from ROOT file reader
 *
 */

#ifndef BRIO_READER_H
#define BRIO_READER_H 1

// Standard Library:
#include <iostream>
#include <stdexcept>
#include <sstream>
#include <string>

// Third Party:
// - Boost:
#include <boost/iostreams/stream.hpp>
#include <boost/iostreams/device/array.hpp>

// Supress known unused parameter warning from Boost's smart_cast header
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunused-parameter"
#endif
#include <boost/archive/text_iarchive.hpp>
#ifdef __clang__
#pragma clang diagnostic pop
#endif

// - Bayeux/datatools:
#include <datatools/portable_archives_support.h>
#include <datatools/logger.h>
#include <datatools/exception.h>

// This Project:
#include <brio/detail/base_io.h>

namespace brio {
  
  class reader
    : public detail::base_io
  {
  public:
    reader();

    reader(const std::string & filename_,
           datatools::logger::priority p_ = datatools::logger::PRIO_FATAL);

    reader(const std::string & filename_,
           const std::string & format_str_,
           datatools::logger::priority p_ = datatools::logger::PRIO_FATAL);

    virtual ~reader();

    void set_check_serial_tag(bool new_value_ = true);

    bool is_check_serial_tag() const;

    void rewind_store(const std::string & label_ = "");

    void unwind_store(const std::string& label_ = "");

    bool has_previous(const std::string & label_ = "") const;

    bool has_next(const std::string & label_ = "") const;

    template<typename T>
    int load_next(T & data_, const std::string & label_ = "");

    template<typename T>
    int load_previous(T & data_, const std::string & label_ = "");

    template<typename T>
    int load(T & data_, int64_t nentry_ = -1);

    template<typename T>
    int load(T & data_, const std::string & label_, int64_t nentry_ = -1);

    virtual void tree_dump(std::ostream & out_ = std::clog,
                           const std::string & title_ = "",
                           const std::string & indent_ = "",
                           bool inherit_ = false) const;

    void print_info(std::ostream& out_ = std::clog) const;

  protected:
    virtual void _at_open(const std::string & filename_);

    template<class T>
    int _at_load(T & data_, store_info * ptr_si_, int64_t nentry_);

    void _set_default();

  private:
    
    const store_info * get_store_or_throw(const std::string & label_) const;
    store_info * get_store_or_throw(const std::string & label_);

  private:
    bool _allow_mixed_types_in_stores_; 
    bool _allow_automatic_store_;       
    bool _check_serial_tag_;            
    store_info * _automatic_store_ = nullptr; 
  };
  
} // end of namespace brio

#include <brio/reader-inl.h>

#endif // BRIO_READER_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --