A data processing module for automated utility operations (bank removal) More...

#include <bayeux/dpp/utils_module.h>

Inheritance diagram for dpp::utils_module:

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

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
	utils_module (datatools::logger::priority=datatools::logger::PRIO_FATAL)
	Constructor. More...

virtual	~utils_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...

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

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

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 Member Functions
void	_set_defaults ()
	Set default values for attributes. More...

void	_process_clear (datatools::things &a_event_record_)
	Special method to clear all banks. More...

void	_process_remove_one_typed_bank (datatools::things &a_event_record_)
	Special method to remove one single bank by label and type (optional) More...

void	_process_remove_banks (datatools::things &a_event_record_)
	Special method to remove several banks by label (name) More...

void	_process_add_property (datatools::things &a_event_record_)
	Special method to add some property in a 'datatools::properties' bank. More...

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...

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 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...

Detailed Description

A data processing module for automated utility operations (bank removal)

Member Enumeration Documentation

◆ mode_type

enum dpp::utils_module::mode_type

Enumerator
MODE_INVALID	Undefined mode.
MODE_CLEAR	Clear all banks mode.
MODE_REMOVE_ONE_TYPED_BANK	Remove one single bank, optionaly with a given type (serial tag)
MODE_REMOVE_BANKS	Remove several banks by label (name)
MODE_ADD_PROPERTY	Add a property in a bank.

Constructor & Destructor Documentation

◆ utils_module()

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

Constructor.

◆ ~utils_module()

virtual dpp::utils_module::~utils_module ( )

virtual

Destructor.

Member Function Documentation

◆ _process_add_property()

void dpp::utils_module::_process_add_property ( datatools::things & a_event_record_ )

protected

Special method to add some property in a 'datatools::properties' bank.

◆ _process_clear()

void dpp::utils_module::_process_clear ( datatools::things & a_event_record_ )

protected

Special method to clear all banks.

◆ _process_remove_banks()

void dpp::utils_module::_process_remove_banks ( datatools::things & a_event_record_ )

protected

Special method to remove several banks by label (name)

◆ _process_remove_one_typed_bank()

void dpp::utils_module::_process_remove_one_typed_bank ( datatools::things & a_event_record_ )

protected

Special method to remove one single bank by label and type (optional)

◆ _set_defaults()

void dpp::utils_module::_set_defaults ( )

protected

Set default values for attributes.

◆ initialize()

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

virtual

Initialization.

◆ process()

virtual process_status dpp::utils_module::process ( ::datatools::things & )

virtual

Data record processing.

◆ reset()

virtual void dpp::utils_module::reset ( )

virtual

Reset.

Implements dpp::base_module.

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

bayeux/dpp/utils_module.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ mode_type

Constructor & Destructor Documentation

◆ utils_module()

◆ ~utils_module()

Member Function Documentation

◆ _process_add_property()

◆ _process_clear()

◆ _process_remove_banks()

◆ _process_remove_one_typed_bank()

◆ _set_defaults()

◆ initialize()

◆ process()

◆ reset()