DP3
Public Member Functions | List of all members
dp3::base::ParsetATerms Class Reference

Parses the parameter settings (parset) related to the aterm settings in an EveryBeam-acceptable format. More...

#include <ParsetAterms.h>

Inheritance diagram for dp3::base::ParsetATerms:

Public Member Functions

 ParsetATerms (const common::ParameterSet &parset, const std::string &prefix="")
 
bool GetBool (const std::string &key) const final
 Extracts bool for given key. Defaults to or_value. More...
 
bool GetBoolOr (const std::string &key, bool or_value) const final
 Extracts bool for given key. Defaults to or_value. More...
 
double GetDoubleOr (const std::string &key, double or_value) const final
 Extracts double for given key. Defaults to or_value. More...
 
std::string GetString (const std::string &key) const final
 Extracts string for given key. More...
 
std::vector< std::string > GetStringList (const std::string &key) const final
 Extracts string list for given key. More...
 
std::string GetStringOr (const std::string &key, const std::string &or_value) const final
 Extracts string for given key. Defaults to or_value. More...
 

Detailed Description

Parses the parameter settings (parset) related to the aterm settings in an EveryBeam-acceptable format.

Constructor & Destructor Documentation

◆ ParsetATerms()

dp3::base::ParsetATerms::ParsetATerms ( const common::ParameterSet parset,
const std::string &  prefix = "" 
)
inlineexplicit

Constructor. Note that this class stores references to the provided parset and prefix. If the parset or prefix object change, this class will use the new values. If the parset or prefix object become invalid, this class should not be used anymore.

Member Function Documentation

◆ GetBool()

bool dp3::base::ParsetATerms::GetBool ( const std::string &  key) const
inlinefinal

Extracts bool for given key. Defaults to or_value.

◆ GetBoolOr()

bool dp3::base::ParsetATerms::GetBoolOr ( const std::string &  key,
bool  or_value 
) const
inlinefinal

Extracts bool for given key. Defaults to or_value.

◆ GetDoubleOr()

double dp3::base::ParsetATerms::GetDoubleOr ( const std::string &  key,
double  or_value 
) const
inlinefinal

Extracts double for given key. Defaults to or_value.

◆ GetString()

std::string dp3::base::ParsetATerms::GetString ( const std::string &  key) const
inlinefinal

Extracts string for given key.

◆ GetStringList()

std::vector<std::string> dp3::base::ParsetATerms::GetStringList ( const std::string &  key) const
inlinefinal

Extracts string list for given key.

◆ GetStringOr()

std::string dp3::base::ParsetATerms::GetStringOr ( const std::string &  key,
const std::string &  or_value 
) const
inlinefinal

Extracts string for given key. Defaults to or_value.


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