Filter adapter to make a filter work on a set of variables and return on variable as the result of the filter. More...

Inheritance diagram for ChoosableFromVarSet< AFilter >:

Collaboration diagram for ChoosableFromVarSet< AFilter >:

[legend]

Public Types
using	Object = typename AFilter::Object
	Type of the filtered object.

Public Member Functions
	ChoosableFromVarSet (std::unique_ptr< AVarSet > varSet, std::string varName="")
	Constructor taking the variable set the filter should work on and the default name of the variable to be used.

	~ChoosableFromVarSet ()
	Default destructor.

void	exposeParameters (ModuleParamList *parameterList, const std::string &prefix) override
	Add the parameters of this filter to the given parameter list.

void	initialize () override
	Initialisation method sets up a reference to the value in the variable set to be returned.

Weight	operator() (const Object &object) override
	Returns the variable with the set requested name from the variable set.

bool	needsTruthInformation () override
	Checks if any variables need Monte Carlo information.

std::unique_ptr< AVarSet >	releaseVarSet () &&
	Steal the set of variables form this filter - filter becomes disfunctional afterwards.

Protected Member Functions
AVarSet &	getVarSet () const
	Getter for the set of variables.

void	setVarSet (std::unique_ptr< AVarSet > varSet)
	Setter for the set of variables.

Private Attributes
std::string	m_param_varName
	Memory for the name of the variable selected as the return value of the filter.

Float_t *	m_variable = nullptr
	Reference to the location of the value in the variable set to be returned.

std::unique_ptr< AVarSet >	m_varSet
	Instance of the variable set to be used in the filter.

Detailed Description

Filter adapter to make a filter work on a set of variables and return on variable as the result of the filter.

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

Public Types