A basic module to add informations into the event header bank. More...
#include <falaise/snemo/processing/event_header_utils_module.h>
Inheritance diagram for snemo::processing::event_header_utils_module:
Public Types | |
| enum | mode_type { MODE_INVALID = 0, MODE_ADD_HEADER = 0x1 } |
| Processing mode. More... | |
 Public Types inherited from dpp::base_module | |
| enum | process_status |
| Public Types inherited from datatools::i_tree_dumpable | |
| enum | ostream_type |
Public Member Functions | |
| event_header_utils_module (datatools::logger::priority=datatools::logger::PRIO_FATAL) | |
| Constructor. More... | |
| virtual | ~event_header_utils_module () |
| Destructor. More... | |
| virtual void | initialize (const datatools::properties &setup_, datatools::service_manager &service_manager_, dpp::module_handle_dict_type &module_dict_) |
| Initialization. More... | |
| virtual void | reset () |
| Reset. More... | |
| virtual process_status | process (datatools::things &data_) |
| Data record processing. More... | |
| bool | is_add_header_mode () const |
| Check add header mode. More... | |
| void | ah_increment_run_number (int incr_=1) |
| Increment run number by one unit. More... | |
| void | ah_increment_event_number (int incr_=1) |
| Increment event number by one unit. More... | |
| bool | ah_is_real () const |
| Check real event type. More... | |
| bool | ah_is_simulated () const |
| Check simulated event type. More... | |
| Public Member Functions inherited from dpp::base_module | |
| base_module (datatools::logger::priority p_=datatools::logger::PRIO_FATAL) | |
| virtual | ~base_module () |
| bool | has_name () const |
| void | set_name (const std::string &) |
| const std::string & | get_name () const |
| bool | has_description () const |
| const std::string & | get_description () const |
| void | set_description (const std::string &description_) |
| bool | has_last_error_message () const |
| void | set_last_error_message (const std::string &) |
| void | append_last_error_message (const std::string &errmsg_) |
| void | reset_last_error_message () |
| const std::string & | get_last_error_message () const |
| bool | is_initialized () const |
| virtual void | initialize_simple () |
| virtual void | initialize_simple_with_service (datatools::service_manager &service_manager_) |
| virtual void | initialize_standalone (const datatools::properties &config_) |
| virtual void | initialize_with_service (const datatools::properties &config_, datatools::service_manager &service_manager_) |
| virtual void | initialize_without_service (const datatools::properties &config, module_handle_dict_type &module_dictionnary_) |
| virtual void | tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const |
| void | print (std::ostream &out_=std::clog) const |
| void | set_logging_priority (datatools::logger::priority p_) |
| datatools::logger::priority | get_logging_priority () const |
| Public Member Functions inherited from datatools::i_tree_dumpable | |
| i_tree_dumpable () | |
| virtual | ~i_tree_dumpable () |
| virtual void | print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const |
| void | print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const |
| void | print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const |
| void | tree_dump_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="", const bool inherit_=false) const |
| void | tree_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="") const |
| void | smart_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="") const |
Protected Member Functions | |
| void | _set_defaults () |
| Set default values for attributes. More... | |
| void | _process_add_header (datatools::things &data_record_) |
| Process for the 'add header' mode. More... | |
| Protected Member Functions inherited from dpp::base_module | |
| void | _set_name (const std::string &name_) |
| void | _set_initialized (bool initialized_) |
| void | _common_initialize (const datatools::properties &config_) |
Additional Inherited Members | |
| Static Public Member Functions inherited from dpp::base_module | |
| static void | common_ocd (datatools::object_configuration_description &ocd_) |
| Static Public Member Functions inherited from datatools::i_tree_dumpable | |
| static const boost::property_tree::ptree & | empty_options () |
| static boost::property_tree::ptree | make_base_print_options (const std::string &title_, const std::string &indent_="", const bool inherit_=false) |
| static std::ostream & | last_skip_tag (std::ostream &out_) |
| static std::ostream & | skip_tag (std::ostream &out_) |
| static std::ostream & | last_tag (std::ostream &out_) |
| static std::ostream & | tag (std::ostream &out_) |
| Public Attributes inherited from dpp::base_module | |
| PROCESS_OK | |
| PROCESS_SUCCESS | |
| PROCESS_CONTINUE | |
| PROCESS_ERROR | |
| PROCESS_FAILURE | |
| PROCESS_STOP | |
| PROCESS_ERROR_STOP | |
| PROCESS_FATAL | |
| PROCESS_INVALID | |
| Public Attributes inherited from datatools::i_tree_dumpable | |
| OSTREAM_COUT | |
| OSTREAM_CERR | |
| OSTREAM_CLOG | |
| Protected Attributes inherited from dpp::base_module | |
| std::string | _name |
| std::string | _description |
| datatools::logger::priority | _logging |
| bool | _initialized |
| std::string | _last_error_message |
Detailed Description
A basic module to add informations into the event header bank.
Member Enumeration Documentation
◆ mode_type
Constructor & Destructor Documentation
◆ event_header_utils_module()
| snemo::processing::event_header_utils_module::event_header_utils_module | ( | datatools::logger::priority | = datatools::logger::PRIO_FATAL | ) |
Constructor.
◆ ~event_header_utils_module()
|
virtual |
Destructor.
Member Function Documentation
◆ _process_add_header()
|
protected |
Process for the 'add header' mode.
◆ _set_defaults()
|
protected |
Set default values for attributes.
◆ ah_increment_event_number()
| void snemo::processing::event_header_utils_module::ah_increment_event_number | ( | int | incr_ = 1 | ) |
Increment event number by one unit.
◆ ah_increment_run_number()
| void snemo::processing::event_header_utils_module::ah_increment_run_number | ( | int | incr_ = 1 | ) |
Increment run number by one unit.
◆ ah_is_real()
| bool snemo::processing::event_header_utils_module::ah_is_real | ( | ) | const |
Check real event type.
◆ ah_is_simulated()
| bool snemo::processing::event_header_utils_module::ah_is_simulated | ( | ) | const |
Check simulated event type.
◆ initialize()
|
virtual |
Initialization.
Implements dpp::base_module.
◆ is_add_header_mode()
| bool snemo::processing::event_header_utils_module::is_add_header_mode | ( | ) | const |
Check add header mode.
◆ process()
|
virtual |
Data record processing.
Implements dpp::base_module.
◆ reset()
|
virtual |
Reset.
Implements dpp::base_module.
The documentation for this class was generated from the following file:
- falaise/snemo/processing/event_header_utils_module.h
