Belle II Software  release-08-01-10
RelationFilterFactory Class Reference

Factory that can create appropriate filters for relations between hits from associated names. More...

#include <RelationFilterFactory.h>

Inheritance diagram for RelationFilterFactory:
Collaboration diagram for RelationFilterFactory:

Public Types

using CreatedFilter = BaseRelationFilter
 Type of the filter that this factory creates.
 

Public Member Functions

 RelationFilterFactory (const std::string &defaultFilterName="all")
 Constructor forwarding the default filter name.
 
 ~RelationFilterFactory ()
 Default destructor.
 
std::string getIdentifier () const override
 Getter for a short identifier for the factory.
 
std::string getFilterPurpose () const override
 Getter for a descriptive purpose of the constructed filters.
 
std::map< std::string, std::string > getValidFilterNamesAndDescriptions () const override
 Getter for valid filter names and a description for each.
 
std::unique_ptr< BaseRelationFiltercreate (const std::string &filterName) const override
 Create a filter with the given name.
 
virtual std::string createFiltersNameDescription () const
 Create a string with a description mentioning the names of the chooseable filter.
 
virtual std::string createFiltersParametersDescription () const
 Create a string with a description mentioning the parameters of the chooseable filter.
 
const std::string & getDefaultFilterName () const
 Legacy - Return the default filter suggested by the factory.
 

Private Types

using Super = TrackFindingCDC::FilterFactory< BaseRelationFilter >
 Type of the base class.
 

Private Attributes

std::string m_defaultFilterName
 Legacy - Default filter name suggested by this factory.
 

Detailed Description

Factory that can create appropriate filters for relations between hits from associated names.

Definition at line 21 of file RelationFilterFactory.h.


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