The vertex validation. More...

#include <bayeux/genvtx/in_materials_vertex_validator.h>

Inheritance diagram for genvtx::in_materials_vertex_validator:

Public Member Functions
	in_materials_vertex_validator (datatools::logger::priority a_logging_priority=datatools::logger::PRIO_FATAL)
	Constructor. More...

virtual	~in_materials_vertex_validator ()
	Destructor. More...

virtual void	initialize (const datatools::properties &, datatools::service_manager &, cuts::cut_handle_dict_type &)
	Initialization. More...

virtual void	reset ()
	Reset. More...

bool	is_reversed () const
	Check reversed flag. More...

void	set_reversed (bool)
	Set the reversed flag. More...

void	add_material (const std::string &material_name_)
	Add the name of a material to be validated. More...

bool	has_material (const std::string &material_name_) const
	Check if a given material name is set. More...

bool	has_max_depth () const
	Check the use of a maximum depth in the hierarchy of daughter volumes to investigate materials. More...

void	set_max_depth (int)
	Set the maximum depth in the hierarchy of daughter volumes to investigate materials. More...

int	get_max_depth () const
	Return the maximum depth in the hierarchy of daughter volumes to investigate materials. 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 cuts::i_cut
bool	is_debug () const
	Check if logging priority is at least at debug level. More...

bool	has_name () const
	Check if the name of the cut is set. More...

void	set_name (const std::string &a_name)
	Set the name of the cut. More...

const std::string &	get_name () const
	Return the name of the cut. More...

bool	has_description () const
	Check if the description of the cut is set. More...

const std::string &	get_description () const
	Return the description of the cut. More...

void	set_description (const std::string &a_description)
	Set the description of the cut. More...

bool	has_version () const
	Check if the version of the cut is set. More...

const std::string &	get_version () const
	Return the version of the cut. More...

void	set_version (const std::string &a_version)
	Return the version of the cut. More...

bool	is_initialized () const
	Check initialization status. More...

bool	has_user_data () const
	Check if some user data is referenced. More...

template<class T >
void	set_user_data (const T &obj_)
	Set user data. More...

template<class T >
bool	is_user_data () const
	Check user data type. More...

template<class T >
const T &	get_user_data () const
	Get user data of given type. More...

template<class T >
void	register_supported_user_data_type ()
	Register user data type is supported. More...

template<class T >
void	unregister_supported_user_data_type ()
	Unregister user data type is supported. More...

template<class T >
bool	is_user_data_type_supported () const
	Check if data type is supported. More...

bool	is_user_data_type_supported (const std::type_info &tinfo_) const
	Check if a data type is supported. More...

void	reset_user_data ()
	Clear the referenced user data. More...

virtual void	initialize_simple ()
	Naked initialization method (default implementation,. More...

virtual void	initialize_standalone (const datatools::properties &a_config)
	Initialization method through a container of configuration properties (default implementation,. More...

virtual void	initialize_with_service_only (const datatools::properties &a_config, datatools::service_manager &a_service_manager)

virtual void	initialize_without_service (const datatools::properties &a_config, cut_handle_dict_type &a_cut_dictionary)

virtual void	export_to_config (datatools::properties &config_, uint32_t flags_=EXPORT_CONFIG_DEFAULT, const std::string &prefix_="") const
	Export to a container of properties. More...

virtual int	process ()

int	operator() ()
	Function interface for the selection method. More...

	i_cut (datatools::logger::priority p=datatools::logger::PRIO_FATAL)
	Constructor. More...

virtual	~i_cut ()
	Destructor. More...

void	print (std::ostream &a_out=std::clog) const
	Print shortcut. More...

void	set_logging_priority (datatools::logger::priority p)
	Set the logging priority threshold. More...

datatools::logger::priority	get_logging_priority () const
	Get the logging priority threshold. More...

size_t	get_number_of_accepted_entries () const
	Return the number of entries accepted by the cut. More...

size_t	get_number_of_rejected_entries () const
	Return the number of entries rejected by the cut. More...

size_t	get_number_of_processed_entries () const
	Return the total number of entries processed by the cut. More...

void	reset_counters ()
	Reset the embedded counters. More...

bool	is_activated_counters () const
	Check the flag to activate counters. More...

void	set_activated_counters (bool)
	Set the flag to activate statistics. More...

virtual std::string	get_type_id () const =0
	Return the unique type identifier associated to the class of the cut object. 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
virtual int	_accept ()
	Selection. More...

Protected Member Functions inherited from cuts::i_cut
void	_set_user_data (const boost::shared_ptr< i_referenced_data > &hd_)
	Set user data by shared pointer. More...

void	_common_initialize (const datatools::properties &a_config)
	Common initialization of all cuts. More...

void	_import_user_data_from (const i_cut &)
	Import user data from another cut. More...

void	_export_user_data_to (i_cut &) const
	Export user data to another cut. More...

void	_set_name (const std::string &a_name)
	Set the cut name. More...

void	_set_initialized (bool a_initialized)
	Set the initialization flag. More...

virtual void	_prepare_cut ()
	Hook invoked before the main selection method. More...

virtual int	_finish_cut (int a_selection_status)
	Hook invoked after the main selection method. More...

virtual void	_increment_counters (int a_selection_status)
	Increment statistics counters. More...

virtual void	_at_set_user_data ()
	Hook executed when user data is set. More...

virtual void	_at_reset_user_data ()
	Hook executed when user data is reset. More...

void	_reset ()
	Reset the cut. More...

void	_set_defaults ()
	Set default attributes values. More...

Additional Inherited Members
Public Types inherited from cuts::i_cut
enum	export_config_flags { EXPORT_CONFIG_CLEAR = datatools::bit_mask::bit00, EXPORT_CONFIG_NAME = datatools::bit_mask::bit01, EXPORT_CONFIG_DESCRIPTION = datatools::bit_mask::bit02, EXPORT_CONFIG_VERSION = datatools::bit_mask::bit03, EXPORT_CONFIG_LOGGING_PRIORITY = datatools::bit_mask::bit04, EXPORT_CONFIG_DEFAULT, EXPORT_CONFIG_LAST = EXPORT_CONFIG_LOGGING_PRIORITY }
	Flags for export to a container of properties. 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...

Static Public Member Functions inherited from cuts::i_cut
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 cuts::i_cut
datatools::logger::priority	_logging
	Logging priority threshold. More...

std::string	_name
	The name of the cut. More...

std::string	_description
	The description of the cut. More...

std::string	_version
	The version of the cut. More...

std::set< const std::type_info * >	_supported_types_
	The set of supported user data types. More...

Detailed Description

The vertex validation.

Constructor & Destructor Documentation

◆ in_materials_vertex_validator()

genvtx::in_materials_vertex_validator::in_materials_vertex_validator ( datatools::logger::priority a_logging_priority = datatools::logger::PRIO_FATAL )

Constructor.

◆ ~in_materials_vertex_validator()

virtual genvtx::in_materials_vertex_validator::~in_materials_vertex_validator ( )

virtual

Destructor.

Member Function Documentation

◆ _accept()

virtual int genvtx::in_materials_vertex_validator::_accept ( )

protectedvirtual

Selection.

Implements cuts::i_cut.

◆ add_material()

void genvtx::in_materials_vertex_validator::add_material ( const std::string & material_name_ )

Add the name of a material to be validated.

◆ get_max_depth()

int genvtx::in_materials_vertex_validator::get_max_depth ( ) const

Return the maximum depth in the hierarchy of daughter volumes to investigate materials.

◆ has_material()

bool genvtx::in_materials_vertex_validator::has_material ( const std::string & material_name_ ) const

Check if a given material name is set.

◆ has_max_depth()

bool genvtx::in_materials_vertex_validator::has_max_depth ( ) const

Check the use of a maximum depth in the hierarchy of daughter volumes to investigate materials.

◆ initialize()

virtual void genvtx::in_materials_vertex_validator::initialize	(	const datatools::properties &	,
		datatools::service_manager &	,
		cuts::cut_handle_dict_type &
	)

virtual

Initialization.

Implements cuts::i_cut.

◆ is_reversed()

bool genvtx::in_materials_vertex_validator::is_reversed ( ) const

Check reversed flag.

◆ reset()

virtual void genvtx::in_materials_vertex_validator::reset ( )

virtual

Reset.

Implements cuts::i_cut.

◆ set_max_depth()

void genvtx::in_materials_vertex_validator::set_max_depth ( int )

Set the maximum depth in the hierarchy of daughter volumes to investigate materials.

◆ set_reversed()

void genvtx::in_materials_vertex_validator::set_reversed ( bool )

Set the reversed flag.

◆ tree_dump()

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

virtual

Smart print.

Reimplemented from cuts::i_cut.

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

bayeux/genvtx/in_materials_vertex_validator.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ in_materials_vertex_validator()

◆ ~in_materials_vertex_validator()

Member Function Documentation

◆ _accept()

◆ add_material()

◆ get_max_depth()

◆ has_material()

◆ has_max_depth()

◆ initialize()

◆ is_reversed()

◆ reset()

◆ set_max_depth()

◆ set_reversed()

◆ tree_dump()