Filling Functions

A group of functions which fill monitored variables in groups. More...

Functions
void	AthMonitorAlgorithm::fill (const ToolHandle< GenericMonitoringTool > &groupHandle, std::vector< std::reference_wrapper< Monitored::IMonitoredVariable > > &&variables) const
	Fills a vector of variables to a group by reference.
void	AthMonitorAlgorithm::fill (const ToolHandle< GenericMonitoringTool > &groupHandle, const std::vector< std::reference_wrapper< Monitored::IMonitoredVariable > > &variables) const
	Fills a vector of variables to a group by reference.
template<typename... T>
void	AthMonitorAlgorithm::fill (const ToolHandle< GenericMonitoringTool > &groupHandle, T &&... variables) const
	Fills a variadic list of variables to a group by reference.
void	AthMonitorAlgorithm::fill (std::string_view groupName, std::vector< std::reference_wrapper< Monitored::IMonitoredVariable > > &&variables) const
	Fills a vector of variables to a group by name.
void	AthMonitorAlgorithm::fill (std::string_view groupName, const std::vector< std::reference_wrapper< Monitored::IMonitoredVariable > > &variables) const
	Fills a vector of variables to a group by name.
template<typename S, typename... T> requires std::convertible_to<S, std::string_view>
void	AthMonitorAlgorithm::fill (S &&groupName, T &&... variables) const
	Fills a variadic list of variables to a group by name.

Detailed Description

A group of functions which fill monitored variables in groups.

Function Documentation

fill() [1/6]

void AthMonitorAlgorithm::fill ( const ToolHandle< GenericMonitoringTool > & groupHandle, const std::vector< std::reference_wrapper< Monitored::IMonitoredVariable > > & variables ) const

inline

Fills a vector of variables to a group by reference.

Calls BASE FILL.

At the end of the fillHistograms routine, one should save the monitored variables to the group. This function wraps the process of getting the desired group by a call to AthMonitorAlgorithm::getGroup() and a call to Monitored::Group::fill(), which also disables the auto-fill feature to avoid double-filling. Note, users should avoid using this specific function name 'fill' in daughter classes.

Parameters

groupHandle	A reference of the GenericMonitoringTool to which add variables
variables	Vector of monitored variables to be saved

Definition at line 120 of file AthMonitorAlgorithm.h.

                                                                                                     {
        fill(groupHandle, std::vector<std::reference_wrapper<Monitored::IMonitoredVariable>>{variables});
    };

fill() [2/6]

void AthMonitorAlgorithm::fill	(	const ToolHandle< GenericMonitoringTool > &	groupHandle,
		std::vector< std::reference_wrapper< Monitored::IMonitoredVariable > > &&	variables ) const

Fills a vector of variables to a group by reference.

(BASE FILL)

At the end of the fillHistograms routine, one should save the monitored variables to the group. This function wraps the process of getting the desired group by a call to AthMonitorAlgorithm::getGroup() and a call to Monitored::Group::fill(), which also disables the auto-fill feature to avoid double-filling. Note, users should avoid using this specific function name 'fill' in daughter classes.

Parameters

groupHandle	A reference of the GenericMonitoringTool to which add variables
variables	Rvalue reference to vector of monitored variables to be saved. Note, the vector will not be valid after calling this function! Use const lvalue variant if you want to keep your vectors.

Definition at line 99 of file AthMonitorAlgorithm.cxx.

                                                                {
    Monitored::Group(groupHandle,std::move(variables)).fill();
}

fill() [3/6]

template<typename... T>

void AthMonitorAlgorithm::fill ( const ToolHandle< GenericMonitoringTool > & groupHandle, T &&... variables ) const

inline

Fills a variadic list of variables to a group by reference.

Calls BASE FILL.

Parameters

groupHandle	Reference to the GenericMonitoringTool
variables...	Variadic list of monitored variables to be saved note: The ToolHandle constructors include a non-explicit converting constructor from std::string.

Definition at line 134 of file AthMonitorAlgorithm.h.

                                                                                              {
        fill(groupHandle, std::vector<std::reference_wrapper<Monitored::IMonitoredVariable>>{std::forward<T>(variables)...});
    }

fill() [4/6]

template<typename S, typename... T>
requires std::convertible_to<S, std::string_view>

void AthMonitorAlgorithm::fill ( S && groupName, T &&... variables ) const

inline

Fills a variadic list of variables to a group by name.

Calls BASE FILL.

Parameters

groupName	The string name of the GenericMonitoringTool
variables...	Variadic list of monitored variables to be saved note: The ToolHandle constructors include a non-explicit converting constructor from std::string; the 'requires' condition disambiguates this.

Definition at line 170 of file AthMonitorAlgorithm.h.

                                                       {
        fill(getGroup(std::forward<S>(groupName)), std::vector<std::reference_wrapper<Monitored::IMonitoredVariable>>{std::forward<T>(variables)...});
    }

fill() [5/6]

void AthMonitorAlgorithm::fill ( std::string_view groupName, const std::vector< std::reference_wrapper< Monitored::IMonitoredVariable > > & variables ) const

inline

Fills a vector of variables to a group by name.

Calls BASE FILL.

Parameters

groupHandle	Reference to the GenericMonitoringTool
variables	Vector of monitored variables to be saved

Definition at line 155 of file AthMonitorAlgorithm.h.

                                                                                                     {
        fill( getGroup(groupName), std::vector<std::reference_wrapper<Monitored::IMonitoredVariable>>{variables});
    }

fill() [6/6]

void AthMonitorAlgorithm::fill	(	std::string_view	groupName,
		std::vector< std::reference_wrapper< Monitored::IMonitoredVariable > > &&	variables ) const

Fills a vector of variables to a group by name.

Calls BASE FILL.

Parameters

groupHandle	Reference to the GenericMonitoringTool
variables	Rvalue reference to vector of monitored variables to be saved. Note, the vector will not be valid after calling this function! Use const lvalue variant if you want to keep your vectors.

Definition at line 105 of file AthMonitorAlgorithm.cxx.

                                                                {
   this->fill(getGroup(groupName),std::move(variables));
}