dump_module.h

Go to the documentation of this file.

/* Author(s)     : Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date : 2011-06-19
 * Last modified : 2015-05-13
 *
 * Copyright (C) 2011-2015 Francois Mauger <mauger@lpccaen.in2p3.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * Description:
 *
 *   A dump data processing module.
 *
 */

#ifndef DPP_DUMP_MODULE_H
#define DPP_DUMP_MODULE_H 1

// Third party:
// - Boost:
#include <boost/scoped_ptr.hpp>

// This project:
#include <dpp/base_module.h>

namespace dpp {

  class dump_module
    : public base_module
  {
  public:

    enum output_type
      {
        OUTPUT_INVALID = 0,
        OUTPUT_COUT,
        OUTPUT_CLOG,
        OUTPUT_FILE,
        OUTPUT_DEFAULT = OUTPUT_COUT
      };

  public:

    void set_title(const std::string & title_);

    void set_indent(const std::string & indent_);

    // Set the output:
    void set_output(const std::string & output_,
                    const std::string & file_ = "");

    dump_module(datatools::logger::priority = datatools::logger::PRIO_FATAL);

    virtual ~dump_module();

    virtual void initialize(const ::datatools::properties & /* config_ */,
                            datatools::service_manager & /* service_mgr_ */,
                            dpp::module_handle_dict_type & /* modules_map_ */);

    virtual void reset();

    virtual process_status process(::datatools::things & /* data_ */);

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

  protected:

    void _set_defaults ();

    std::ostream & _grab_output ();

  private:

    std::string    _indent_; 
    std::string    _title_; 
    int            _output_;          
    std::string    _output_filename_; 
    boost::scoped_ptr<std::ofstream > _fout_; 
    std::ostream * _out_;             //<! Output stream handle

    // Macro to automate the registration of the module :
    DPP_MODULE_REGISTRATION_INTERFACE(dump_module)

  };

}  // end of namespace dpp

#endif // DPP_DUMP_MODULE_H

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