writer.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 to ROOT file writer
 *
 */

#ifndef BRIO_WRITER_H
#define BRIO_WRITER_H 1

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

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

#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunused-parameter"
#endif
#include <boost/archive/text_oarchive.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 writer
    : public detail::base_io
  {
  public:
    writer();

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

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

    virtual ~writer();

    void lock();

    void unlock();

    bool is_locked() const;

    bool is_allow_mixed_types_in_stores() const;

    bool is_allow_automatic_store() const;

    bool is_existing_file_protected() const;

    void set_allow_mixed_types_in_stores(bool new_value_ = true);

    void set_allow_automatic_store(bool new_value_ = true);

    void set_existing_file_protected(bool new_value_ = true);

    int add_store(const std::string & label_,
                  const std::string & serial_tag_,
                  size_t buffer_size_ = 256000);

    int add_store(const std::string & label_,
                  size_t buffer_size_ = 256000);

    int add_mixed_store(const std::string & label_,
                        size_t buffer_size_ = 0);

    // Store template method
    template <typename T>
    int store(const T & data_, const std::string & label_ = "");

    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:

    void _set_default();

    store_info * _add_store(const std::string & label_,
                            const std::string & serial_tag_,
                            size_t buffer_size_);

    template <typename T>
    int _at_store(const T & dat, store_info * store_info_);

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

  private:

    bool _locked_;                      
    bool _allow_mixed_types_in_stores_; 
    bool _allow_automatic_store_;       
    bool _existing_file_protected_;     
    store_info * _automatic_store_ = nullptr; 

  };

} // end of namespace brio

#include <brio/writer-inl.h>

#endif // BRIO_WRITER_H

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