mctools::simulated_data_input_module Class Reference

Simulation data input module. More...

#include <bayeux/mctools/simulated_data_input_module.h>

Inheritance diagram for mctools::simulated_data_input_module:

Public Member Functions
	simulated_data_input_module (datatools::logger::priority logging_priority_=datatools::logger::PRIO_FATAL)
virtual	~simulated_data_input_module ()
virtual void	initialize (const datatools::properties &, datatools::service_manager &, dpp::module_handle_dict_type &)
	Initialization. More...
virtual void	reset ()
	Reset. More...
virtual dpp::base_module::process_status	process (datatools::things &)
	Data record processing. More...
bool	is_terminated () const
void	set_single_input_file (const std::string &filepath_)
void	set_list_of_input_files (const std::vector< std::string > &filepaths_, bool allow_duplicate_=false)
void	set_incremental_input_files (const std::string &path_, const std::string &prefix_, const std::string &extension_, unsigned int stop_, unsigned int start_=0, int increment_=1)
void	set_sd_bank_label (const std::string &bank_label_)
void	set_overwrite_existing_sd_bank_label (bool)
void	set_limits (int max_record_total_, int max_record_per_file_=0, int max_files_=-1)
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	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

Static Public Member Functions
static const std::string &	default_sd_bank_label ()
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_)

Static Public Attributes
static const std::string	DEFAULT_SD_BANK_LABEL

Protected Member Functions
dpp::base_module::process_status	_load (datatools::things &event_record_)
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
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...
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

Simulation data input module.

Constructor & Destructor Documentation

simulated_data_input_module()

mctools::simulated_data_input_module::simulated_data_input_module

(

datatools::logger::priority

logging_priority_ = datatools::logger::PRIO_FATAL

)

~simulated_data_input_module()

virtual mctools::simulated_data_input_module::~simulated_data_input_module ( )

virtual

Member Function Documentation

_load()

dpp::base_module::process_status mctools::simulated_data_input_module::_load ( datatools::things &  event_record_ )

protected

default_sd_bank_label()

static const std::string& mctools::simulated_data_input_module::default_sd_bank_label ( )

static

initialize()

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

virtual

Initialization.

Implements dpp::base_module.

is_terminated()

bool mctools::simulated_data_input_module::is_terminated

(

)

const

process()

virtual dpp::base_module::process_status mctools::simulated_data_input_module::process ( datatools::things &  )

virtual

Data record processing.

Implements dpp::base_module.

reset()

virtual void mctools::simulated_data_input_module::reset ( )

virtual

Reset.

Implements dpp::base_module.

set_incremental_input_files()

void mctools::simulated_data_input_module::set_incremental_input_files	(	const std::string &	path_,
		const std::string &	prefix_,
		const std::string &	extension_,
		unsigned int	stop_,
		unsigned int	start_ = 0,
		int	increment_ = 1
	)

set_limits()

void mctools::simulated_data_input_module::set_limits	(	int	max_record_total_,
		int	max_record_per_file_ = 0,
		int	max_files_ = -1
	)

set_list_of_input_files()

void mctools::simulated_data_input_module::set_list_of_input_files	(	const std::vector< std::string > &	filepaths_,
		bool	allow_duplicate_ = false
	)

set_overwrite_existing_sd_bank_label()

void mctools::simulated_data_input_module::set_overwrite_existing_sd_bank_label

(

bool

)

set_sd_bank_label()

void mctools::simulated_data_input_module::set_sd_bank_label

(

const std::string &

bank_label_

)

set_single_input_file()

void mctools::simulated_data_input_module::set_single_input_file

(

const std::string &

filepath_

)

Member Data Documentation

DEFAULT_SD_BANK_LABEL

const std::string mctools::simulated_data_input_module::DEFAULT_SD_BANK_LABEL

static

---

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

• bayeux/mctools/simulated_data_input_module.h