CMS 3D CMS Logo

List of all members | Public Types | Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes
edm::ParameterSwitch< T > Class Template Reference

#include <ParameterSwitch.h>

Inheritance diagram for edm::ParameterSwitch< T >:
edm::ParameterSwitchBase edm::ParameterDescriptionNode

Public Types

typedef std::map< T, edm::value_ptr< ParameterDescriptionNode > > CaseMap
 
typedef std::map< T, edm::value_ptr< ParameterDescriptionNode > >::const_iterator CaseMapConstIter
 

Public Member Functions

ParameterDescriptionNodeclone () const override
 
 ParameterSwitch (ParameterDescription< T > const &switchParameter, std::unique_ptr< ParameterDescriptionCases< T > > cases)
 
- Public Member Functions inherited from edm::ParameterSwitchBase
 ~ParameterSwitchBase () override
 
- Public Member Functions inherited from edm::ParameterDescriptionNode
void checkAndGetLabelsAndTypes (std::set< std::string > &usedLabels, std::set< ParameterTypes > &parameterTypes, std::set< ParameterTypes > &wildcardTypes) const
 
std::string const & comment () const
 
bool exists (ParameterSet const &pset) const
 
bool hasNestedContent () const
 
int howManyXORSubNodesExist (ParameterSet const &pset) const
 
virtual bool isWildcard () const
 
 ParameterDescriptionNode ()
 
 ParameterDescriptionNode (Comment const &iComment)
 
bool partiallyExists (ParameterSet const &pset) const
 
void print (std::ostream &os, bool optional, bool writeToCfi, DocFormatHelper &dfh) const
 
void printNestedContent (std::ostream &os, bool optional, DocFormatHelper &dfh) const
 
void setComment (std::string const &value)
 
void setComment (char const *value)
 
void validate (ParameterSet &pset, std::set< std::string > &validatedLabels, bool optional) const
 
void writeCfi (std::ostream &os, bool optional, bool &startWithComma, int indentation, CfiOptions &options, bool &wroteSomething) const
 
virtual ~ParameterDescriptionNode ()
 

Private Member Functions

void checkAndGetLabelsAndTypes_ (std::set< std::string > &usedLabels, std::set< ParameterTypes > &parameterTypes, std::set< ParameterTypes > &wildcardTypes) const override
 
bool exists_ (ParameterSet const &pset) const override
 
void print_ (std::ostream &os, bool optional, bool writeToCfi, DocFormatHelper &dfh) const override
 
void printNestedContent_ (std::ostream &os, bool optional, DocFormatHelper &dfh) const override
 
void validate_ (ParameterSet &pset, std::set< std::string > &validatedLabels, bool optional) const override
 
void writeCfi_ (std::ostream &os, bool optional, bool &startWithComma, int indentation, CfiOptions &options, bool &wroteSomething) const override
 

Static Private Member Functions

static void checkCaseLabels (std::pair< T, edm::value_ptr< ParameterDescriptionNode > > const &thePair, std::set< std::string > &labels, std::set< ParameterTypes > &parameterTypes, std::set< ParameterTypes > &wildcardTypes)
 

Private Attributes

CaseMap cases_
 
ParameterDescription< Tswitch_
 

Additional Inherited Members

- Static Public Member Functions inherited from edm::ParameterDescriptionNode
static void printSpaces (std::ostream &os, int n)
 
- Protected Member Functions inherited from edm::ParameterSwitchBase
bool hasNestedContent_ () const override
 
void insertAndCheckLabels (std::string const &switchLabel, std::set< std::string > &usedLabels, std::set< std::string > &labels) const
 
void insertAndCheckTypes (ParameterTypes switchType, std::set< ParameterTypes > const &caseParameterTypes, std::set< ParameterTypes > const &caseWildcardTypes, std::set< ParameterTypes > &parameterTypes, std::set< ParameterTypes > &wildcardTypes) const
 
void printBase (std::ostream &os, bool optional, bool writeToCfi, DocFormatHelper &dfh, std::string const &switchLabel, bool isTracked, std::string const &typeString) const
 
void printNestedContentBase (std::ostream &os, DocFormatHelper &dfh, DocFormatHelper &new_dfh, std::string const &switchLabel) const
 
void throwDuplicateCaseValues (std::string const &switchLabel) const
 
void throwNoCaseForDefault (std::string const &switchLabel) const
 
void throwNoCaseForSwitchValue (std::string const &message) const
 
- Static Protected Member Functions inherited from edm::ParameterSwitchBase
template<typename T >
static void printCaseT (std::pair< T, edm::value_ptr< ParameterDescriptionNode > > const &p, std::ostream &os, bool optional, DocFormatHelper &dfh, std::string const &switchLabel)
 
- Protected Attributes inherited from edm::ParameterDescriptionNode
std::string comment_
 

Detailed Description

template<class T>
class edm::ParameterSwitch< T >

Definition at line 25 of file ParameterSwitch.h.

Member Typedef Documentation

◆ CaseMap

template<class T>
typedef std::map<T, edm::value_ptr<ParameterDescriptionNode> > edm::ParameterSwitch< T >::CaseMap

Definition at line 27 of file ParameterSwitch.h.

◆ CaseMapConstIter

template<class T>
typedef std::map<T, edm::value_ptr<ParameterDescriptionNode> >::const_iterator edm::ParameterSwitch< T >::CaseMapConstIter

Definition at line 28 of file ParameterSwitch.h.

Constructor & Destructor Documentation

◆ ParameterSwitch()

template<class T>
edm::ParameterSwitch< T >::ParameterSwitch ( ParameterDescription< T > const &  switchParameter,
std::unique_ptr< ParameterDescriptionCases< T > >  cases 
)
inline

Definition at line 30 of file ParameterSwitch.h.

References edm::ParameterDescriptionBase::label(), and edm::ParameterSwitchBase::throwDuplicateCaseValues().

Referenced by edm::ParameterSwitch< T >::clone().

32  : switch_(switchParameter), cases_(*cases->caseMap()) {
33  if (cases->duplicateCaseValues()) {
34  throwDuplicateCaseValues(switchParameter.label());
35  }
36  }
void throwDuplicateCaseValues(std::string const &switchLabel) const
ParameterDescription< T > switch_

Member Function Documentation

◆ checkAndGetLabelsAndTypes_()

template<class T>
void edm::ParameterSwitch< T >::checkAndGetLabelsAndTypes_ ( std::set< std::string > &  usedLabels,
std::set< ParameterTypes > &  parameterTypes,
std::set< ParameterTypes > &  wildcardTypes 
) const
inlineoverrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 41 of file ParameterSwitch.h.

References edm::ParameterSwitch< T >::cases_, edm::ParameterSwitch< T >::checkCaseLabels(), edm::for_all(), edm::ParameterSwitchBase::insertAndCheckLabels(), edm::ParameterSwitchBase::insertAndCheckTypes(), edm::ParameterSwitch< T >::switch_, and edm::ParameterSwitchBase::throwNoCaseForDefault().

43  {
44  std::set<std::string> caseLabels;
45  std::set<ParameterTypes> caseParameterTypes;
46  std::set<ParameterTypes> caseWildcardTypes;
49  std::placeholders::_1,
50  std::ref(caseLabels),
51  std::ref(caseParameterTypes),
52  std::ref(caseWildcardTypes)));
53 
54  insertAndCheckLabels(switch_.label(), usedLabels, caseLabels);
55 
56  insertAndCheckTypes(switch_.type(), caseParameterTypes, caseWildcardTypes, parameterTypes, wildcardTypes);
57 
58  if (cases_.find(switch_.getDefaultValue()) == cases_.end()) {
60  }
61  }
void insertAndCheckTypes(ParameterTypes switchType, std::set< ParameterTypes > const &caseParameterTypes, std::set< ParameterTypes > const &caseWildcardTypes, std::set< ParameterTypes > &parameterTypes, std::set< ParameterTypes > &wildcardTypes) const
static void checkCaseLabels(std::pair< T, edm::value_ptr< ParameterDescriptionNode > > const &thePair, std::set< std::string > &labels, std::set< ParameterTypes > &parameterTypes, std::set< ParameterTypes > &wildcardTypes)
Func for_all(ForwardSequence &s, Func f)
wrapper for std::for_each
Definition: Algorithms.h:14
void throwNoCaseForDefault(std::string const &switchLabel) const
void insertAndCheckLabels(std::string const &switchLabel, std::set< std::string > &usedLabels, std::set< std::string > &labels) const
ParameterDescription< T > switch_

◆ checkCaseLabels()

template<class T>
static void edm::ParameterSwitch< T >::checkCaseLabels ( std::pair< T, edm::value_ptr< ParameterDescriptionNode > > const &  thePair,
std::set< std::string > &  labels,
std::set< ParameterTypes > &  parameterTypes,
std::set< ParameterTypes > &  wildcardTypes 
)
inlinestaticprivate

Definition at line 167 of file ParameterSwitch.h.

References SummaryClient_cfi::labels.

Referenced by edm::ParameterSwitch< T >::checkAndGetLabelsAndTypes_().

170  {
171  thePair.second->checkAndGetLabelsAndTypes(labels, parameterTypes, wildcardTypes);
172  }

◆ clone()

template<class T>
ParameterDescriptionNode* edm::ParameterSwitch< T >::clone ( void  ) const
inlineoverridevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 38 of file ParameterSwitch.h.

References edm::ParameterSwitch< T >::ParameterSwitch().

38 { return new ParameterSwitch(*this); }
ParameterSwitch(ParameterDescription< T > const &switchParameter, std::unique_ptr< ParameterDescriptionCases< T > > cases)

◆ exists_()

template<class T>
bool edm::ParameterSwitch< T >::exists_ ( ParameterSet const &  pset) const
inlineoverrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 165 of file ParameterSwitch.h.

References muonDTDigis_cfi::pset, and edm::ParameterSwitch< T >::switch_.

165 { return switch_.exists(pset); }
ParameterDescription< T > switch_

◆ print_()

template<class T>
void edm::ParameterSwitch< T >::print_ ( std::ostream &  os,
bool  optional,
bool  writeToCfi,
DocFormatHelper dfh 
) const
inlineoverrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 115 of file ParameterSwitch.h.

References Types::optional, l1tGTMenu_BTagSeeds_cff::os, edm::parameterTypeEnumToString(), edm::ParameterSwitchBase::printBase(), and edm::ParameterSwitch< T >::switch_.

115  {
116  printBase(os,
117  optional,
118  writeToCfi,
119  dfh,
120  switch_.label(),
121  switch_.isTracked(),
123  }
std::string parameterTypeEnumToString(ParameterTypes iType)
void printBase(std::ostream &os, bool optional, bool writeToCfi, DocFormatHelper &dfh, std::string const &switchLabel, bool isTracked, std::string const &typeString) const
optional
Definition: Types.py:245
ParameterDescription< T > switch_

◆ printNestedContent_()

template<class T>
void edm::ParameterSwitch< T >::printNestedContent_ ( std::ostream &  os,
bool  optional,
DocFormatHelper dfh 
) const
inlineoverrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 125 of file ParameterSwitch.h.

References edm::ParameterSwitch< T >::cases_, edm::for_all(), edm::DocFormatHelper::indent(), Types::optional, l1tGTMenu_BTagSeeds_cff::os, edm::ParameterSwitchBase::printNestedContentBase(), edm::DocFormatHelper::setCounter(), edm::DocFormatHelper::setPass(), and edm::ParameterSwitch< T >::switch_.

125  {
126  DocFormatHelper new_dfh(dfh);
127  printNestedContentBase(os, dfh, new_dfh, switch_.label());
128 
129  switch_.print(os, optional, true, new_dfh);
130  for_all(cases_,
131  std::bind(&ParameterSwitchBase::printCaseT<T>,
132  std::placeholders::_1,
133  std::ref(os),
134  optional,
135  std::ref(new_dfh),
136  std::cref(switch_.label())));
137 
138  new_dfh.setPass(1);
139  new_dfh.setCounter(0);
140 
141  new_dfh.indent(os);
142  os << "switch:\n";
143  switch_.print(os, optional, true, new_dfh);
144  for_all(cases_,
145  std::bind(&ParameterSwitchBase::printCaseT<T>,
146  std::placeholders::_1,
147  std::ref(os),
148  optional,
149  std::ref(new_dfh),
150  std::cref(switch_.label())));
151 
152  new_dfh.setPass(2);
153  new_dfh.setCounter(0);
154 
155  switch_.printNestedContent(os, optional, new_dfh);
156  for_all(cases_,
157  std::bind(&ParameterSwitchBase::printCaseT<T>,
158  std::placeholders::_1,
159  std::ref(os),
160  optional,
161  std::ref(new_dfh),
162  std::cref(switch_.label())));
163  }
Func for_all(ForwardSequence &s, Func f)
wrapper for std::for_each
Definition: Algorithms.h:14
optional
Definition: Types.py:245
ParameterDescription< T > switch_
void printNestedContentBase(std::ostream &os, DocFormatHelper &dfh, DocFormatHelper &new_dfh, std::string const &switchLabel) const

◆ validate_()

template<class T>
void edm::ParameterSwitch< T >::validate_ ( ParameterSet pset,
std::set< std::string > &  validatedLabels,
bool  optional 
) const
inlineoverrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 63 of file ParameterSwitch.h.

References edm::ParameterSwitch< T >::cases_, Types::optional, muonDTDigis_cfi::pset, contentValuesCheck::ss, edm::ParameterSwitch< T >::switch_, and edm::ParameterSwitchBase::throwNoCaseForSwitchValue().

63  {
64  switch_.validate(pset, validatedLabels, optional);
65  if (switch_.exists(pset)) {
66  T switchValue;
67  if (switch_.isTracked()) {
68  switchValue = pset.getParameter<T>(switch_.label());
69  } else {
70  switchValue = pset.getUntrackedParameter<T>(switch_.label());
71  }
72  typename CaseMap::const_iterator selectedCase = cases_.find(switchValue);
73  if (selectedCase != cases_.end()) {
74  selectedCase->second->validate(pset, validatedLabels, false);
75  } else {
76  std::stringstream ss;
77  ss << "The switch parameter with label \"" << switch_.label() << "\" has been assigned an illegal value.\n"
78  << "The value from the configuration is \"" << switchValue << "\".\n"
79  << "The allowed values are:\n";
80 
81  for (CaseMapConstIter iter = cases_.begin(), iEnd = cases_.end(); iter != iEnd; ++iter) {
82  ss << " " << iter->first << "\n";
83  }
85  }
86  }
87  }
optional
Definition: Types.py:245
std::map< T, edm::value_ptr< ParameterDescriptionNode > >::const_iterator CaseMapConstIter
ParameterDescription< T > switch_
long double T
void throwNoCaseForSwitchValue(std::string const &message) const

◆ writeCfi_()

template<class T>
void edm::ParameterSwitch< T >::writeCfi_ ( std::ostream &  os,
bool  optional,
bool &  startWithComma,
int  indentation,
CfiOptions options,
bool &  wroteSomething 
) const
inlineoverrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 89 of file ParameterSwitch.h.

References edm::ParameterSwitch< T >::cases_, printContent_cfi::indentation, MainPageGenerator::l, SummaryClient_cfi::labels, dqmiodumpmetadata::n, Types::optional, l1tGTMenu_BTagSeeds_cff::os, edm::cfi::parameterMustBeTyped(), and edm::ParameterSwitch< T >::switch_.

94  {
95  switch_.writeCfi(os, optional, startWithComma, indentation, options, wroteSomething);
96 
97  if (std::holds_alternative<cfi::ClassFile>(options)) {
98  std::set<std::string> labels;
99  std::set<ParameterTypes> parameterTypes;
100  std::set<ParameterTypes> wildcardTypes;
101  for (auto const& n : cases_) {
102  n.second->checkAndGetLabelsAndTypes(labels, parameterTypes, wildcardTypes);
103  }
104  for (auto const& l : labels) {
106  }
107  }
108 
109  typename CaseMap::const_iterator selectedCase = cases_.find(switch_.getDefaultValue());
110  if (selectedCase != cases_.end()) {
111  selectedCase->second->writeCfi(os, optional, startWithComma, indentation, options, wroteSomething);
112  }
113  }
void parameterMustBeTyped(CfiOptions &iOps) noexcept
optional
Definition: Types.py:245
ParameterDescription< T > switch_

Member Data Documentation

◆ cases_

template<class T>
CaseMap edm::ParameterSwitch< T >::cases_
private

◆ switch_

template<class T>
ParameterDescription<T> edm::ParameterSwitch< T >::switch_
private