simulated_data_reader.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2013-06-22
 * Last modified: 2013-06-22
 *
 * License:
 *
 * Description:
 *   Simulation data reader.
 *
 */

#ifndef MCTOOLS_SIMULATED_DATA_READER_H
#define MCTOOLS_SIMULATED_DATA_READER_H 1

// Standard library:
#include <string>
#include <vector>

// Third party:
// - Boost :
#include <boost/scoped_ptr.hpp>
// - Bayeux/datatools :
#include <datatools/logger.h>
#include <datatools/smart_filename.h>
#include <datatools/utils.h>

namespace datatools {
  class properties;
  class data_reader;
}

namespace brio {
  class reader;
}

namespace mctools {

  class simulated_data;

  class simulated_data_reader
    : public datatools::i_tree_dumpable
  {
  public:

    enum load_status_type {
      LOAD_OK    = 0,
      LOAD_ERROR = 1,
      LOAD_FATAL = 2
    };

    void set_max_files (int max_files_);

    void set_max_record_total (int max_record_total_);

    void set_max_record_per_file (int max_record_per_file_);

    int get_max_record_per_file() const;

    int get_max_record_total() const;

    int get_max_files() const;

    void set_filenames (const datatools::properties & setup_);

    datatools::logger::priority get_logging_priority() const;

    void set_logging_priority(datatools::logger::priority logging_);

    simulated_data_reader(datatools::logger::priority logging_ = datatools::logger::PRIO_FATAL);

    virtual ~simulated_data_reader();

    bool is_initialized() const;

    void initialize(const std::string & filename_);

    void initialize(const std::vector<std::string> & filenames_);

    void initialize(const std::string & path_,
                    const std::string & prefix_,
                    const std::string & extension_,
                    unsigned int stop_,
                    unsigned int start_ = 0,
                    int increment_ = 1);

    void initialize(const datatools::properties & setup_);

    void reset();

    bool is_terminated () const;

    bool has_next() const;

    int load_next(simulated_data & sd_);

    bool has_run_header() const;

    const datatools::properties & get_run_header() const;

    bool has_run_footer() const;

    const datatools::properties & get_run_footer() const;

    bool file_has_changed() const;

    int get_file_index() const;

    int get_file_record_counter() const;

    int get_record_counter() const;

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

  protected:

    void _initialize();

    int _check_input();

    int _load(simulated_data & sd_);

    void _set_defaults();

  private:

    bool                        _initialized_; 
    datatools::logger::priority _logging_;     
    datatools::smart_filename   _filenames_;   
    int _max_record_per_file_;                 
    int _max_record_total_;                    
    int _max_files_;                           

    /* Running/dynamic attributes: */
    bool _terminated_;               
    int  _file_record_counter_;      
    int  _record_counter_;           
    int  _file_index_;               
    bool _file_has_changed_;         
    boost::scoped_ptr<datatools::data_reader> _bio_reader_;  
    boost::scoped_ptr<brio::reader>           _brio_reader_; 
    boost::scoped_ptr<datatools::properties>  _run_header_;
    boost::scoped_ptr<datatools::properties>  _run_footer_;
  };


} // end of namespace mctools

// Object configuration description (OCD) support :
#include <datatools/ocd_macros.h>
DOCD_CLASS_DECLARATION(mctools::simulated_data_reader)

#endif // MCTOOLS_SIMULATED_DATA_READER_H

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