iguana::Validator Class Reference

#include <Validator.h>

Detailed Description

Base class for all algorithm validators to inherit from.

Similar to iguana::Algorithm, derived classes should override the methods Validator::Start, Validator::Run and Validator::Stop

Definition at line 17 of file Validator.h.

Public Member Functions
	Validator (std::string_view name="validator")
void	Start (hipo::banklist &banks) override
	Initialize this algorithm before any events are processed, with the intent to process banks
void	Run (hipo::banklist &banks) const override
	Run this algorithm for an event.
void	Stop () override
	Finalize this algorithm after all events are processed.
void	SetOutputDirectory (std::string_view output_dir)
std::optional< std::string >	GetOutputDirectory ()
Public Member Functions inherited from iguana::Algorithm
	Algorithm (std::string_view name)
void	Start ()
	Initialize this algorithm before any events are processed, with the intent to process bank rows rather than full banks;.
template<typename OPTION_TYPE >
OPTION_TYPE	SetOption (std::string const &key, const OPTION_TYPE val)
template<typename OPTION_TYPE >
OPTION_TYPE	GetOptionScalar (std::string const &key, YAMLReader::node_path_t node_path={}) const
template<typename OPTION_TYPE >
std::vector< OPTION_TYPE >	GetOptionVector (std::string const &key, YAMLReader::node_path_t node_path={}) const
template<typename OPTION_TYPE >
std::set< OPTION_TYPE >	GetOptionSet (std::string const &key, YAMLReader::node_path_t node_path={}) const
void	SetName (std::string_view name)
std::unique_ptr< YAMLReader > const &	GetConfig () const
void	SetConfig (std::unique_ptr< YAMLReader > &&yaml_config)
void	SetConfigFile (std::string const &name)
void	SetConfigDirectory (std::string const &name)
Public Member Functions inherited from iguana::Object
	Object (std::string_view name="", Logger::Level lev=Logger::DEFAULT_LEVEL)
std::unique_ptr< Logger > &	Log ()
void	SetName (std::string_view name)
std::string	GetName () const
void	SetLogLevel (std::string_view lev)
void	SetLogLevel (Logger::Level const lev)
std::unique_ptr< Logger > &	GetLog ()

Protected Attributes
std::unique_ptr< AlgorithmSequence >	m_algo_seq
	An iguana::AlgorithmSequence to be used for this validator.
std::mutex	m_mutex
	Mutex for locking procedures such as histogram filling in Validator::Run
Protected Attributes inherited from iguana::Algorithm
std::string	m_class_name
	Class name of this algorithm.
bool	m_rows_only
	If true, algorithm can only operate on bank rows; Algorithm::GetBank, and therefore Algorithm::Run, cannot be called.
std::string	m_default_config_file
	Default configuration file name.
std::string	o_user_config_file
std::string	o_user_config_dir
std::mutex	m_mutex
	A mutex for this algorithm.
Protected Attributes inherited from iguana::Object
std::string	m_name
	The name of this object.
std::unique_ptr< Logger >	m_log
	Logger instance for this object

Additional Inherited Members
Protected Member Functions inherited from iguana::Algorithm
void	ParseYAMLConfig ()
	Parse YAML configuration files. Sets m_yaml_config.
hipo::bank &	GetBank (hipo::banklist &banks, hipo::banklist::size_type const idx, std::string const &expected_bank_name="") const noexcept(false)
hipo::banklist::size_type	GetBankIndex (hipo::banklist &banks, std::string const &bank_name) const noexcept(false)
hipo::schema	CreateBank (hipo::banklist &banks, hipo::banklist::size_type &bank_idx, std::string const &bank_name, std::vector< std::string > schema_def, int group_id, int item_id) const noexcept(false)
void	ShowBanks (hipo::banklist &banks, std::string_view message="", Logger::Level const level=Logger::trace) const
void	ShowBank (hipo::bank &bank, std::string_view message="", Logger::Level const level=Logger::trace) const
template<typename OPTION_TYPE >
std::optional< OPTION_TYPE >	GetCachedOption (std::string const &key) const

Inheritance diagram for iguana::Validator:

Constructor & Destructor Documentation

Validator()

iguana::Validator::Validator ( std::string_view name = "validator" )

inline

Parameters

name	the unique name for a derived class instance

Definition at line 23 of file Validator.h.

~Validator()

virtual iguana::Validator::~Validator ( )

inlinevirtual

Definition at line 27 of file Validator.h.

Member Function Documentation

GetOutputDirectory()

std::optional< std::string > iguana::Validator::GetOutputDirectory

(

)

Get this validator's output directory

Returns

an optional, which is set if the output directory is defined

Run()

void iguana::Validator::Run ( hipo::banklist & banks ) const

inlineoverridevirtual

Run this algorithm for an event.

Parameters

banks

the list of banks to process

Implements iguana::Algorithm.

Reimplemented in iguana::clas12::ZVertexFilterValidator.

Definition at line 30 of file Validator.h.

SetOutputDirectory()

void iguana::Validator::SetOutputDirectory

(

std::string_view

output_dir

)

Set this validator's output directory

Parameters

output_dir

the output directory

Start()

void iguana::Validator::Start ( hipo::banklist & banks )

inlineoverridevirtual

Initialize this algorithm before any events are processed, with the intent to process banks

use this method if you intend to use Algorithm::Run.

Parameters

banks

the list of banks this algorithm will use, so that Algorithm::Run can cache the indices of the banks that it needs

Implements iguana::Algorithm.

Reimplemented in iguana::clas12::ZVertexFilterValidator.

Definition at line 29 of file Validator.h.

Stop()

void iguana::Validator::Stop ( )

inlineoverridevirtual

Finalize this algorithm after all events are processed.

Implements iguana::Algorithm.

Reimplemented in iguana::clas12::ZVertexFilterValidator.

Definition at line 31 of file Validator.h.

Member Data Documentation

m_algo_seq

std::unique_ptr<AlgorithmSequence> iguana::Validator::m_algo_seq

protected

An iguana::AlgorithmSequence to be used for this validator.

Definition at line 44 of file Validator.h.

m_mutex

std::mutex iguana::Validator::m_mutex

mutableprotected

Mutex for locking procedures such as histogram filling in Validator::Run

Definition at line 47 of file Validator.h.

---

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

• /__w/iguana/iguana/iguana_src/src/iguana/algorithms/Validator.h