Bayeux  3.4.1
Core Foundation library for SuperNEMO
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
dpp::chain_module Class Reference

A data processing module to chain children data processing modules. More...

#include <bayeux/dpp/chain_module.h>

Inheritance diagram for dpp::chain_module:
dpp::base_module datatools::i_tree_dumpable

Classes

struct  module_entry
 Record for a module using a specific label. More...
 

Public Types

typedef std::list< module_entrymodule_list_type
 
- Public Types inherited from dpp::base_module
enum  process_status {
  PROCESS_OK = 0, PROCESS_SUCCESS = PROCESS_OK, PROCESS_CONTINUE = PROCESS_OK, PROCESS_ERROR = datatools::bit_mask::bit00,
  PROCESS_FAILURE = PROCESS_ERROR, PROCESS_STOP = datatools::bit_mask::bit01, PROCESS_ERROR_STOP = PROCESS_ERROR | PROCESS_STOP, PROCESS_FATAL = datatools::bit_mask::bit02,
  PROCESS_INVALID = datatools::bit_mask::bit31
}
 Processing status flags used as the returned value of data processing methods through the pipeline. More...
 
- Public Types inherited from datatools::i_tree_dumpable
enum  ostream_type { OSTREAM_COUT = 1, OSTREAM_CERR = 2, OSTREAM_CLOG = 3 }
 Enumeration for standard output streams. More...
 

Public Member Functions

void add_module (const std::string &label_, const module_handle_type &handle_module_)
 Add a module in the processing chain. More...
 
bool has_module (const std::string &label_) const
 Check if a module with a given name exists. More...
 
 chain_module (datatools::logger::priority=datatools::logger::PRIO_FATAL)
 Constructor. More...
 
virtual ~chain_module ()
 Destructor. More...
 
virtual void initialize (const ::datatools::properties &, datatools::service_manager &, dpp::module_handle_dict_type &)
 Initialization. More...
 
virtual void reset ()
 Reset. More...
 
virtual process_status process (::datatools::things &)
 Data record processing. More...
 
virtual void tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
 Smart print. More...
 
- Public Member Functions inherited from dpp::base_module
 base_module (datatools::logger::priority p_=datatools::logger::PRIO_FATAL)
 Default constructor : More...
 
virtual ~base_module ()
 Destructor : More...
 
bool has_name () const
 Check the module name. More...
 
void set_name (const std::string &)
 Set the module name. More...
 
const std::string & get_name () const
 Return the module name. More...
 
bool has_description () const
 Check the module description. More...
 
const std::string & get_description () const
 Return the module description. More...
 
void set_description (const std::string &description_)
 Set the module description. More...
 
bool has_last_error_message () const
 Check the module last error message. More...
 
void set_last_error_message (const std::string &)
 Set the module last error message. More...
 
void append_last_error_message (const std::string &errmsg_)
 Append an error message. More...
 
void reset_last_error_message ()
 Reset the module last error message. More...
 
const std::string & get_last_error_message () const
 Return the module last error message. More...
 
bool is_initialized () const
 Check initialization flag. More...
 
virtual void initialize_simple ()
 Initialize the module without external resource. More...
 
virtual void initialize_simple_with_service (datatools::service_manager &service_manager_)
 Initialize the module with a service manager only. More...
 
virtual void initialize_standalone (const datatools::properties &config_)
 Initialize the module only using a set of parameters. More...
 
virtual void initialize_with_service (const datatools::properties &config_, datatools::service_manager &service_manager_)
 Initialize the module using a set of parameters and a service manager. More...
 
virtual void initialize_without_service (const datatools::properties &config, module_handle_dict_type &module_dictionnary_)
 Initialize the module using a set of parameters and a map of modules. More...
 
virtual void initialize (const datatools::properties &config_, datatools::service_manager &service_manager_, module_handle_dict_type &module_dictionary_)=0
 
virtual process_status process (datatools::things &data_model_)=0
 
void print (std::ostream &out_=std::clog) const
 Default print. More...
 
void set_logging_priority (datatools::logger::priority p_)
 Set logging priority. More...
 
datatools::logger::priority get_logging_priority () const
 Returns logging priority. More...
 
- Public Member Functions inherited from datatools::i_tree_dumpable
 i_tree_dumpable ()
 Constructor. More...
 
virtual ~i_tree_dumpable ()
 Destructor. More...
 
virtual void print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const
 Main new interface method for printing. More...
 
void print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const
 Printing with jsonized options. More...
 
void print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const
 Printing with jsonized options. More...
 
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 Attributes

module_list_type _modules_
 The list of data processing modules. More...
 
- Protected Attributes inherited from dpp::base_module
std::string _name
 The name of the module. More...
 
std::string _description
 The description of the module. More...
 
datatools::logger::priority _logging
 The logging priority threshold. More...
 
bool _initialized
 The initialization flag. More...
 
std::string _last_error_message
 Last error message (questionable) More...
 

Additional Inherited Members

- Static Public Member Functions inherited from dpp::base_module
static void common_ocd (datatools::object_configuration_description &ocd_)
 Basic OCD support shared by all inherited modules. More...
 
- 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_)
 
- Protected Member Functions inherited from dpp::base_module
void _set_name (const std::string &name_)
 Set the name of the module. More...
 
void _set_initialized (bool initialized_)
 Set the initialization flag of the module. More...
 
void _common_initialize (const datatools::properties &config_)
 Basic initialization shared by all inherited modules. More...
 

Detailed Description

A data processing module to chain children data processing modules.

Member Typedef Documentation

◆ module_list_type

Constructor & Destructor Documentation

◆ chain_module()

dpp::chain_module::chain_module ( datatools::logger::priority  = datatools::logger::PRIO_FATAL)

Constructor.

◆ ~chain_module()

virtual dpp::chain_module::~chain_module ( )
virtual

Destructor.

Member Function Documentation

◆ add_module()

void dpp::chain_module::add_module ( const std::string &  label_,
const module_handle_type handle_module_ 
)

Add a module in the processing chain.

◆ has_module()

bool dpp::chain_module::has_module ( const std::string &  label_) const

Check if a module with a given name exists.

◆ initialize()

virtual void dpp::chain_module::initialize ( const ::datatools::properties ,
datatools::service_manager ,
dpp::module_handle_dict_type  
)
virtual

Initialization.

◆ process()

virtual process_status dpp::chain_module::process ( ::datatools::things )
virtual

Data record processing.

◆ reset()

virtual void dpp::chain_module::reset ( )
virtual

Reset.

Implements dpp::base_module.

◆ tree_dump()

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

Smart print.

Reimplemented from dpp::base_module.

Member Data Documentation

◆ _modules_

module_list_type dpp::chain_module::_modules_
protected

The list of data processing modules.


The documentation for this class was generated from the following file: