The container of collections of modelled analog signals. More...

#include <bayeux/mctools/signal/signal_data.h>

Inheritance diagram for mctools::signal::signal_data:

Public Types
typedef datatools::handle< base_signal >	signal_handle_type
	Alias for the MC base step hit. More...

typedef std::vector< signal_handle_type >	signal_handle_collection_type

typedef std::map< std::string, signal_handle_collection_type >	signals_dict_type

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
	signal_data ()
	Default constructor. More...

virtual	~signal_data ()
	Destructor. More...

const datatools::properties &	get_auxiliaries () const
	Get a reference to the non mutable collection of auxiliary properties. More...

datatools::properties &	grab_auxiliaries ()
	Get a reference to the mutable collection of auxiliary properties. More...

void	set_auxiliaries (const datatools::properties &)
	Set the collection of auxiliary properties. More...

bool	has_signals (const std::string &a_category) const
	Check is some signals exist in some given category. More...

void	add_signals (const std::string &a_category, size_t a_capacity=0)
	Add a new collection of signal hits with some given category and a default capacity for memory allocation. More...

size_t	get_number_of_signals (const std::string &a_category) const
	Get the number of signals hits within a given category. More...

const base_signal &	get_signal (const std::string &a_category, int a_hit_index) const
	Get a reference to the non mutable signal hit within a given category and index. More...

base_signal &	grab_signal (const std::string &a_category, int a_hit_index)
	Get a reference to the mutable signal hit within a given category and index. More...

base_signal &	add_signal (const std::string &a_category)
	Add/append a new signal hit in a collection of signal hits with some given category. More...

void	remove_signal (const std::string &a_category, int a_hit_index)
	remove a signal hit in a collection of signal hits with some given category and index More...

signal_handle_collection_type &	grab_signals (const std::string &a_category)
	Return a reference to the mutable collection of signals within a given category. More...

const signal_handle_collection_type &	get_signals (const std::string &a_category) const
	Return a reference to the non mutable collection of signals within a given category. More...

void	remove_signals (const std::string &a_category)
	Remoive the collection of signals within a given category. More...

void	build_list_of_categories (std::vector< std::string > &cats_) const
	Build list of signal categories. More...

void	clear ()
	Reset the internal data. More...

void	reset ()
	Reset data. 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 datatools::i_serializable
	i_serializable ()
	Default constructor. More...

virtual	~i_serializable ()
	Destructor. More...

virtual const std::string &	get_serial_tag () const =0
	Return the serialization string identifier of the class. 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

Additional Inherited Members
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_)

Detailed Description

The container of collections of modelled analog signals.

Member Typedef Documentation

◆ signal_handle_collection_type

typedef std::vector<signal_handle_type> mctools::signal::signal_data::signal_handle_collection_type

◆ signal_handle_type

typedef datatools::handle<base_signal> mctools::signal::signal_data::signal_handle_type

Alias for the MC base step hit.

◆ signals_dict_type

typedef std::map<std::string, signal_handle_collection_type> mctools::signal::signal_data::signals_dict_type

Constructor & Destructor Documentation

◆ signal_data()

mctools::signal::signal_data::signal_data ( )

Default constructor.

◆ ~signal_data()

virtual mctools::signal::signal_data::~signal_data ( )

virtual

Destructor.

Member Function Documentation

◆ add_signal()

base_signal& mctools::signal::signal_data::add_signal ( const std::string & a_category )

Add/append a new signal hit in a collection of signal hits with some given category.

◆ add_signals()

void mctools::signal::signal_data::add_signals	(	const std::string &	a_category,
		size_t	a_capacity = `0`
	)

Add a new collection of signal hits with some given category and a default capacity for memory allocation.

◆ build_list_of_categories()

void mctools::signal::signal_data::build_list_of_categories ( std::vector< std::string > & cats_ ) const

Build list of signal categories.

◆ clear()

void mctools::signal::signal_data::clear ( )

Reset the internal data.

◆ get_auxiliaries()

const datatools::properties& mctools::signal::signal_data::get_auxiliaries ( ) const

Get a reference to the non mutable collection of auxiliary properties.

◆ get_number_of_signals()

size_t mctools::signal::signal_data::get_number_of_signals ( const std::string & a_category ) const

Get the number of signals hits within a given category.

◆ get_signal()

const base_signal& mctools::signal::signal_data::get_signal	(	const std::string &	a_category,
		int	a_hit_index
	)		const

Get a reference to the non mutable signal hit within a given category and index.

◆ get_signals()

const signal_handle_collection_type& mctools::signal::signal_data::get_signals ( const std::string & a_category ) const

Return a reference to the non mutable collection of signals within a given category.

◆ grab_auxiliaries()

datatools::properties& mctools::signal::signal_data::grab_auxiliaries ( )

Get a reference to the mutable collection of auxiliary properties.

◆ grab_signal()

base_signal& mctools::signal::signal_data::grab_signal	(	const std::string &	a_category,
		int	a_hit_index
	)

Get a reference to the mutable signal hit within a given category and index.

◆ grab_signals()

signal_handle_collection_type& mctools::signal::signal_data::grab_signals ( const std::string & a_category )

Return a reference to the mutable collection of signals within a given category.

◆ has_signals()

bool mctools::signal::signal_data::has_signals ( const std::string & a_category ) const

Check is some signals exist in some given category.

◆ remove_signal()

void mctools::signal::signal_data::remove_signal	(	const std::string &	a_category,
		int	a_hit_index
	)

remove a signal hit in a collection of signal hits with some given category and index

◆ remove_signals()

void mctools::signal::signal_data::remove_signals ( const std::string & a_category )

Remoive the collection of signals within a given category.

◆ reset()

void mctools::signal::signal_data::reset ( )

Reset data.

◆ set_auxiliaries()

void mctools::signal::signal_data::set_auxiliaries ( const datatools::properties & )

Set the collection of auxiliary properties.

◆ tree_dump()

virtual void mctools::signal::signal_data::tree_dump	(	std::ostream &	out_ = `std::clog`,
		const std::string &	title_ = `""`,
		const std::string &	indent_ = `""`,
		bool	inherit_ = `false`
	)		const