Alexandria 2.31.0
SDC-CH common library for the Euclid project
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
Euclid::Configuration::PdfCatalogConfig< T > Class Template Reference

#include <PdfCatalogConfig.h>

Inheritance diagram for Euclid::Configuration::PdfCatalogConfig< T >:
Inheritance graph
[legend]
Collaboration diagram for Euclid::Configuration::PdfCatalogConfig< T >:
Collaboration graph
[legend]

Public Member Functions

 PdfCatalogConfig (long manager_id)
 
virtual ~PdfCatalogConfig ()=default
 
void addPdfColumn (const std::string &pdf_name, const std::string &col_name, std::vector< T > keys)
 
void initialize (const UserValues &) override
 Method which is called during the initialization phase.
 
- Public Member Functions inherited from Euclid::Configuration::Configuration
 Configuration (long manager_id)
 Constructs a new Configuration instance.
 
virtual ~Configuration ()=default
 Destructor.
 
virtual std::map< std::string, OptionDescriptionListgetProgramOptions ()
 Returns the program options defined by a specific configuration.
 
virtual void preInitialize (const UserValues &args)
 Method which is called before the initialization phase.
 
virtual void postInitialize (const UserValues &args)
 Method which is called after the initialization phase.
 
const std::set< std::type_index > & getDependencies ()
 Returns the dependencies of the configuration.
 
StategetCurrentState ()
 Returns the current state of the configuration.
 
State getCurrentState () const
 Returns the current state of the configuration.
 

Private Attributes

std::map< std::string, std::vector< T > > m_keys
 
std::map< std::string, std::stringm_column_names
 

Additional Inherited Members

- Public Types inherited from Euclid::Configuration::Configuration
enum class  State { CONSTRUCTED , PRE_INITIALIZED , INITIALIZED , FINAL }
 Defines the different states the configuration object can be in. More...
 
using OptionDescriptionList = std::vector< boost::program_options::option_description >
 
using UserValues = std::map< std::string, boost::program_options::variable_value >
 
- Protected Member Functions inherited from Euclid::Configuration::Configuration
template<typename T >
void declareDependency ()
 Declares a Configuration as dependency.
 
template<typename T >
T & getDependency ()
 Returns a dependency.
 
template<typename T >
const T & getDependency () const
 

Detailed Description

template<typename T>
class Euclid::Configuration::PdfCatalogConfig< T >

Adds to the configured catalog attributes to handle PDF columns

Template Parameters
TThe value type of the PDF (i.e. double or float)

Definition at line 41 of file PdfCatalogConfig.h.

Constructor & Destructor Documentation

◆ PdfCatalogConfig()

template<typename T >
Euclid::Configuration::PdfCatalogConfig< T >::PdfCatalogConfig ( long  manager_id)
inlineexplicit

Definition at line 44 of file PdfCatalogConfig.h.

◆ ~PdfCatalogConfig()

template<typename T >
virtual Euclid::Configuration::PdfCatalogConfig< T >::~PdfCatalogConfig ( )
virtualdefault

Member Function Documentation

◆ addPdfColumn()

template<typename T >
void Euclid::Configuration::PdfCatalogConfig< T >::addPdfColumn ( const std::string pdf_name,
const std::string col_name,
std::vector< T >  keys 
)
inline

◆ initialize()

template<typename T >
void Euclid::Configuration::PdfCatalogConfig< T >::initialize ( const UserValues args)
inlineoverridevirtual

Method which is called during the initialization phase.

The Configuration implementations should override this method to implement their logic. When this method is called, all the configurations which are defined as dependencies by using the declareDependency() method are guaranteed to already be initialized.

Parameters
argsThe user parameters

Reimplemented from Euclid::Configuration::Configuration.

Definition at line 58 of file PdfCatalogConfig.h.

References Euclid::Configuration::PdfCatalogConfig< T >::m_column_names, Euclid::Configuration::PdfCatalogConfig< T >::m_keys, and std::make_shared().

Here is the call graph for this function:

Member Data Documentation

◆ m_column_names

template<typename T >
std::map<std::string, std::string> Euclid::Configuration::PdfCatalogConfig< T >::m_column_names
private

◆ m_keys

template<typename T >
std::map<std::string, std::vector<T> > Euclid::Configuration::PdfCatalogConfig< T >::m_keys
private

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