utils_module.h

Go to the documentation of this file.

/* Author (s) :     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2011-01-09
 * Last modified: 2013-05-15
 *
 * License:
 *
 * Description:
 *
 *   Utility processing module
 *
 */

#ifndef DPP_UTILS_MODULE_H
#define DPP_UTILS_MODULE_H 1

// Standard library:
#include <cstdlib>
#include <stdexcept>
#include <iostream>
#include <string>

// Third party:
// - Bayeux/datatools:
#include <datatools/properties.h>

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

namespace dpp {

  class utils_module
    : public base_module
  {
  public:

    enum mode_type {
      MODE_INVALID         = 0, 
      MODE_CLEAR           = 0x1, 
      MODE_REMOVE_ONE_TYPED_BANK = 0x2, 
      MODE_REMOVE_BANKS    = 0x4, 
      MODE_ADD_PROPERTY    = 0x8 
    };

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

    virtual ~utils_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_ */);

  protected:

    void _set_defaults();

    void _process_clear(datatools::things & a_event_record_);

    void _process_remove_one_typed_bank(datatools::things & a_event_record_);

    void _process_remove_banks(datatools::things & a_event_record_);

    void _process_add_property (datatools::things & a_event_record_);

  private:

    mode_type                _mode_; 
    std::string              _remove_one_typed_bank_label_; 
    std::string              _remove_one_typed_bank_type_;  
    std::vector<std::string> _remove_bank_labels_; 
    std::string              _add_property_bank_label_; 
    std::string              _add_property_key_; 
    datatools::properties    _add_property_value_; 
    std::string              _add_property_description_; 
    bool                     _add_property_update_; 

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

  };

} // end of namespace dpp

#endif // DPP_UTILS_MODULE_H

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