EventAnalysis  1.3.0
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
EA::Configurator Class Referenceabstract

Interface for analysis configurator. More...

#include <Configurator.h>

Inheritance diagram for EA::Configurator:
EA::ClingMacroConfigurator EA::RootMacroConfigurator EA::TextFileConfigurator

Public Member Functions

virtual ~Configurator ()
 Destructor. More...
 
virtual bool Configure (AnalysisManager &anManager, const std::string &configFile, const CommandLineParameters &clParams)=0
 Configures the analysis manager using the given configuration file. More...
 
bool AddConfigurationFolders (const std::vector< std::string > &folders)
 Adds configuration folders. More...
 

Protected Member Functions

const std::vector< std::string > & GetConfigurationFolders ()
 

Private Attributes

std::vector< std::string > _configFolders
 

Detailed Description

Interface for analysis configurator.

A Configurator class configures the analysis according to the content of some configuration file.

Constructor & Destructor Documentation

◆ ~Configurator()

virtual EA::Configurator::~Configurator ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ AddConfigurationFolders()

bool EA::Configurator::AddConfigurationFolders ( const std::vector< std::string > &  folders)

Adds configuration folders.

Adds folders where configuration files specified as relative paths can be searched. The actual usage of

Parameters
foldersa std::vector with a list of folders (each folder as a std::string)
Returns
true if the folders have been correctly added to the folders list.

◆ Configure()

virtual bool EA::Configurator::Configure ( AnalysisManager anManager,
const std::string &  configFile,
const CommandLineParameters clParams 
)
pure virtual

Configures the analysis manager using the given configuration file.

Parameters
anManagerThe analysis manager.
configFileThe config file
clParamsthe command line parameters.
Returns
true if the analysis manager has been correctly configured.

Implemented in EA::TextFileConfigurator, EA::RootMacroConfigurator, and EA::ClingMacroConfigurator.

◆ GetConfigurationFolders()

const std::vector<std::string>& EA::Configurator::GetConfigurationFolders ( )
inlineprotected

Member Data Documentation

◆ _configFolders

std::vector<std::string> EA::Configurator::_configFolders
private

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