The vertex validation. More...

#include <bayeux/genvtx/vertex_validation.h>

Inheritance diagram for genvtx::vertex_validation:

Classes
class	geometry_context
	Object which embeds the geometry context of a given vertex. More...

Public Types
enum	validate_status_type { VS_UNDEFINED = -1, VS_ACCEPTED = 0, VS_REJECTED = 1, VS_MAXTRIES = 2 }
	Status of the validation. 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
	vertex_validation ()
	Default constructor. More...

virtual	~vertex_validation ()
	Destructor. More...

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

datatools::logger::priority	get_logging_priority () const
	Returns logging priority. More...

void	set_maximum_number_of_tries (const size_t tries_)
	Set the maximum number of tries. More...

size_t	get_maximum_number_of_tries () const
	Return the maximum number of tries. More...

bool	is_owned_validator () const
	Check the vertex validator cut ownership. More...

void	set_validator (cuts::i_cut &validator_)
	Set the vertex validator by reference. More...

void	set_validator (cuts::i_cut *validator_)
	Set the vertex validator by pointer. More...

void	reset_validator ()
	Reset the vertex validator. More...

bool	has_validator () const
	Check if there is a vertex validator. More...

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

void	initialize (const datatools::properties &config_)
	Initialize the validation system. More...

void	reset ()
	Reset the internals. More...

void	reset_geometry_context ()
	Reset the current geometry context. More...

geometry_context &	grab_geometry_context ()
	Return a reference to the mutable current geometry context. More...

const geometry_context &	get_geometry_context () const
	Return a reference to the current geometry context. More...

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

validate_status_type	validate ()
	Validation. More...

void	reset_number_of_tries ()
	Reset the current number of tries. More...

size_t	get_number_of_tries () const
	Return the current number of tries. More...

bool	is_maximum_number_of_tries_reached () const
	Check if the maximum number of tries is reached. 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 void	ocd_support (datatools::object_configuration_description &, const std::string &label_="")
	OCD support. 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 size_t	DEFAULT_MAX_NUMBER_OF_TRIES = 1000
	The default maximum number of tries. More...

Detailed Description

The vertex validation.

Member Enumeration Documentation

◆ validate_status_type

enum genvtx::vertex_validation::validate_status_type

Status of the validation.

Enumerator
VS_UNDEFINED	Vertex validation status is not defined.
VS_ACCEPTED	Vertex is accepted.
VS_REJECTED	Vertex is rejected.
VS_MAXTRIES	Vertex validation reaches max number of tries.

Constructor & Destructor Documentation

◆ vertex_validation()

genvtx::vertex_validation::vertex_validation ( )

Default constructor.

◆ ~vertex_validation()

virtual genvtx::vertex_validation::~vertex_validation ( )

virtual

Destructor.

Member Function Documentation

◆ get_geometry_context()

const geometry_context& genvtx::vertex_validation::get_geometry_context ( ) const

Return a reference to the current geometry context.

◆ get_logging_priority()

datatools::logger::priority genvtx::vertex_validation::get_logging_priority ( ) const

Returns logging priority.

◆ get_maximum_number_of_tries()

size_t genvtx::vertex_validation::get_maximum_number_of_tries ( ) const

Return the maximum number of tries.

◆ get_number_of_tries()

size_t genvtx::vertex_validation::get_number_of_tries ( ) const

Return the current number of tries.

◆ grab_geometry_context()

geometry_context& genvtx::vertex_validation::grab_geometry_context ( )

Return a reference to the mutable current geometry context.

◆ has_validator()

bool genvtx::vertex_validation::has_validator ( ) const

Check if there is a vertex validator.

◆ initialize()

void genvtx::vertex_validation::initialize ( const datatools::properties & config_ )

Initialize the validation system.

◆ is_initialized()

bool genvtx::vertex_validation::is_initialized ( ) const

Check initialization status.

◆ is_maximum_number_of_tries_reached()

bool genvtx::vertex_validation::is_maximum_number_of_tries_reached ( ) const

Check if the maximum number of tries is reached.

◆ is_owned_validator()

bool genvtx::vertex_validation::is_owned_validator ( ) const

Check the vertex validator cut ownership.

◆ ocd_support()

static void genvtx::vertex_validation::ocd_support	(	datatools::object_configuration_description &	,
		const std::string &	label_ = `""`
	)

static

OCD support.

◆ reset()

void genvtx::vertex_validation::reset ( )

Reset the internals.

◆ reset_geometry_context()

void genvtx::vertex_validation::reset_geometry_context ( )

Reset the current geometry context.

◆ reset_number_of_tries()

void genvtx::vertex_validation::reset_number_of_tries ( )

Reset the current number of tries.

◆ reset_validator()

void genvtx::vertex_validation::reset_validator ( )

Reset the vertex validator.

◆ set_logging_priority()

void genvtx::vertex_validation::set_logging_priority ( datatools::logger::priority )

Set logging priority.

◆ set_maximum_number_of_tries()

void genvtx::vertex_validation::set_maximum_number_of_tries ( const size_t tries_ )

Set the maximum number of tries.

◆ set_validator() [1/2]

void genvtx::vertex_validation::set_validator ( cuts::i_cut & validator_ )

Set the vertex validator by reference.

◆ set_validator() [2/2]

void genvtx::vertex_validation::set_validator ( cuts::i_cut * validator_ )

Set the vertex validator by pointer.

◆ tree_dump()

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

virtual

Smart print.

Reimplemented from datatools::i_tree_dumpable.

◆ validate()

validate_status_type genvtx::vertex_validation::validate ( )

Validation.

Member Data Documentation

◆ DEFAULT_MAX_NUMBER_OF_TRIES

const size_t genvtx::vertex_validation::DEFAULT_MAX_NUMBER_OF_TRIES = 1000