signal_shape_builder.h

Go to the documentation of this file.

/* Author(s)     : Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Author(s)     : Guillaume Oliviéro <goliviero@lpccaen.in2p3.fr>
 * Creation date : 2016-11-29
 * Last modified : 2016-11-29
 *
 * Copyright (C) 2016 Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Copyright (C) 2016 Guillaume Oliviéro <goliviero@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 signal shape builder
 *
 */

#ifndef MCTOOLS_SIGNAL_SIGNAL_SHAPE_BUILDER_H
#define MCTOOLS_SIGNAL_SIGNAL_SHAPE_BUILDER_H

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

// Third party:
// - Boost:
#include <boost/noncopyable.hpp>
// - Bayeux/datatools:
#include <datatools/properties.h>
#include <datatools/factory.h>
#include <datatools/i_tree_dump.h>
// - Bayeux/mygsl:
#include <mygsl/i_unary_function.h>
// - Bayeux/geomtools:
#include <geomtools/base_hit.h>

namespace datatools {
  class service_manager;
} // end of namespace datatools

namespace mctools {

  namespace signal {

    class signal_shape_builder
      : private boost::noncopyable
      , public datatools::i_tree_dumpable
    {
    public:

      typedef datatools::factory_register<mygsl::i_unary_function> freg_type;

      // Return the prefix for reference functor keys
      static const std::string & reference_functor_prefix();

      signal_shape_builder();

      ~signal_shape_builder();

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

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

      bool has_category() const;

      void set_category(const std::string &);

      void reset_category();

      const std::string & get_category() const;

      void add_registered_shape_type_id(const std::string &);

      bool has_registered_shape_type_id(const std::string & )const;

      bool has_service_mgr() const;

      void set_service_mgr(const datatools::service_manager &);

      const datatools::service_manager & get_service_mgr() const;

      bool is_initialized() const;

      void initialize_simple();

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

      void reset();

      const mygsl::i_unary_function &
      create_signal_shape(const std::string & key_,
                          const std::string & shape_type_id_,
                          const datatools::properties & shape_params_);

      bool has_functor_factory(const std::string & shape_type_id_) const;

      bool has_reference_functor(const std::string & key_) const;

      const mygsl::i_unary_function & get_reference_functor(const std::string & key_) const;

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

      void add_reference_functor(const std::string & key_,
                                 const std::string & shape_type_id_,
                                 const datatools::properties & shape_params_);

      bool has_functor(const std::string & key_) const;

      mygsl::i_unary_function & grab_functor(const std::string & key_);

      const mygsl::i_unary_function & get_functor(const std::string & key_) const;

      mygsl::const_unary_function_handle_type get_functor_handle(const std::string & key_) const;

      void clear_functor(const std::string & key_);

      void clear_functors();

      const mygsl::unary_function_dict_type & get_functors() const;

      void build_list_of_reference_functors(std::set<std::string> &) const;

      void build_list_of_functors(std::set<std::string> &) const;

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

    private:

      void _init_(const datatools::properties * config_);

      void _init_reference_functors_();

      void _init_registration_();

      void _reset_();

      std::string _generate_functor_key();

      void _update_all_functors_();

    private:

      // Management:
      bool _initialized_ = false; 
      datatools::logger::priority _logging_; 

      // Configuration:
      std::string _category_; 
      std::set<std::string> _registered_shape_type_ids_; 
      const datatools::service_manager * _service_mgr_ = nullptr; 

      // Working data:
      datatools::factory_register<mygsl::i_unary_function> _freg_; 
      mygsl::unary_function_dict_type _reference_functors_; 
      mygsl::unary_function_dict_type _functors_; 
      mygsl::unary_function_dict_type _all_functors_; 

      DR_CLASS_RTTI()

    };

  } // end of namespace signal

} // end of namespace mctools

// Activate reflection layer :
DR_CLASS_INIT(::mctools::signal::signal_shape_builder)

#endif // MCTOOLS_SIGNAL_SIGNAL_SHAPE_BUILDER_H

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