Convience template to create a filter returning on variable from a set of variables. More...

Inheritance diagram for ChoosableFromVarSetFilter< ATruthVarSet >:

[legend]

Collaboration diagram for ChoosableFromVarSetFilter< ATruthVarSet >:

[legend]

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

using	Interface = Filter< ATruthVarSet::Object >
	Mark this class as the basic interface.

Public Member Functions
	ChoosableFromVarSetFilter (const std::string &varName="")
	Constructor.

	~ChoosableFromVarSetFilter ()
	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.

Weight	operator() (const Object &obj) override
	Function extracting the variables of the object into the variable set.

Weight	operator() (const Object *obj)
	Function to evaluate the object. More...

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.

void	beginRun () override
	Receive and dispatch signal for the beginning of a new run.

void	beginEvent () override
	Receive and dispatch signal for the start of a new event.

void	endRun () override
	Receive and dispatch signal for the end of the run.

void	terminate () override
	Receive and dispatch Signal for termination of the event processing.

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.

void	addProcessingSignalListener (ProcessingSignalListener *psl)
	Register a processing signal listener to be notified.

int	getNProcessingSignalListener ()
	Get the number of currently registered listeners.

Private Types
using	Super = ChoosableFromVarSet< Filter< typename ATruthVarSet::Object > >
	Type of the super class.

using	AVarSet = BaseVarSet< Object >
	Type of the variable set.

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
	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.

std::vector< ProcessingSignalListener * >	m_subordinaryProcessingSignalListeners
	References to subordinary signal processing listener contained in this findlet.

bool	m_initialized = false
	Flag to keep track whether initialization happend before.

bool	m_terminated = false
	Flag to keep track whether termination happend before.

std::string	m_initializedAs
	Name of the type during initialisation.

Detailed Description

Convience template to create a filter returning on variable from a set of variables.

Member Function Documentation

Weight operator() ( const Object * obj )

inherited

Function to evaluate the object.

Base implementation accepts all objects, except nullptr.

Parameters

obj	The object to be accepted or rejected.

Returns: A finit float value if the object is accepted. NAN if the object is rejected. Nullptr is always rejected.

Definition at line 60 of file Filter.icc.h.

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