edm::ParameterSwitch< T > Class Template Reference

#include <ParameterSwitch.h>

Inheritance diagram for edm::ParameterSwitch< T >:

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
ParameterDescriptionNode *	clone () 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
	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, 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, 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< T >	switch_

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

template<class T >

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

Definition at line 27 of file ParameterSwitch.h.

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

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().

        : switch_(switchParameter), cases_(*cases->caseMap()) {
      if (cases->duplicateCaseValues()) {
        throwDuplicateCaseValues(switchParameter.label());
      }
    }

Member Function Documentation

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().

                                                                                          {
      std::set<std::string> caseLabels;
      std::set<ParameterTypes> caseParameterTypes;
      std::set<ParameterTypes> caseWildcardTypes;
      for_all(cases_,
              std::bind(&ParameterSwitch::checkCaseLabels,
                        std::placeholders::_1,
                        std::ref(caseLabels),
                        std::ref(caseParameterTypes),
                        std::ref(caseWildcardTypes)));

      insertAndCheckLabels(switch_.label(), usedLabels, caseLabels);

      insertAndCheckTypes(switch_.type(), caseParameterTypes, caseWildcardTypes, parameterTypes, wildcardTypes);

      if (cases_.find(switch_.getDefaultValue()) == cases_.end()) {
        throwNoCaseForDefault(switch_.label());
      }
    }

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 151 of file ParameterSwitch.h.

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

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

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().

{ return new ParameterSwitch(*this); }

template<class T >

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

inlineoverrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 149 of file ParameterSwitch.h.

References edm::ParameterSwitch< T >::switch_.

{ return switch_.exists(pset); }

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 99 of file ParameterSwitch.h.

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

                                                                                                     {
      printBase(os,
                optional,
                writeToCfi,
                dfh,
                switch_.label(),
                switch_.isTracked(),
                parameterTypeEnumToString(switch_.type()));
    }

template<class T >

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

inlineoverrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 109 of file ParameterSwitch.h.

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

                                                                                                 {
      DocFormatHelper new_dfh(dfh);
      printNestedContentBase(os, dfh, new_dfh, switch_.label());

      switch_.print(os, optional, true, new_dfh);
      for_all(cases_,
              std::bind(&ParameterSwitchBase::printCaseT<T>,
                        std::placeholders::_1,
                        std::ref(os),
                        optional,
                        std::ref(new_dfh),
                        std::cref(switch_.label())));

      new_dfh.setPass(1);
      new_dfh.setCounter(0);

      new_dfh.indent(os);
      os << "switch:\n";
      switch_.print(os, optional, true, new_dfh);
      for_all(cases_,
              std::bind(&ParameterSwitchBase::printCaseT<T>,
                        std::placeholders::_1,
                        std::ref(os),
                        optional,
                        std::ref(new_dfh),
                        std::cref(switch_.label())));

      new_dfh.setPass(2);
      new_dfh.setCounter(0);

      switch_.printNestedContent(os, optional, new_dfh);
      for_all(cases_,
              std::bind(&ParameterSwitchBase::printCaseT<T>,
                        std::placeholders::_1,
                        std::ref(os),
                        optional,
                        std::ref(new_dfh),
                        std::cref(switch_.label())));
    }

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_, edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), contentValuesCheck::ss, edm::ParameterSwitch< T >::switch_, and edm::ParameterSwitchBase::throwNoCaseForSwitchValue().

                                                                                                         {
      switch_.validate(pset, validatedLabels, optional);
      if (switch_.exists(pset)) {
        T switchValue;
        if (switch_.isTracked()) {
          switchValue = pset.getParameter<T>(switch_.label());
        } else {
          switchValue = pset.getUntrackedParameter<T>(switch_.label());
        }
        typename CaseMap::const_iterator selectedCase = cases_.find(switchValue);
        if (selectedCase != cases_.end()) {
          selectedCase->second->validate(pset, validatedLabels, false);
        } else {
          std::stringstream ss;
          ss << "The switch parameter with label \"" << switch_.label() << "\" has been assigned an illegal value.\n"
             << "The value from the configuration is \"" << switchValue << "\".\n"
             << "The allowed values are:\n";

          for (CaseMapConstIter iter = cases_.begin(), iEnd = cases_.end(); iter != iEnd; ++iter) {
            ss << "  " << iter->first << "\n";
          }
          throwNoCaseForSwitchValue(ss.str());
        }
      }
    }

template<class T >

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

inlineoverrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 89 of file ParameterSwitch.h.

References edm::ParameterSwitch< T >::cases_, and edm::ParameterSwitch< T >::switch_.

                                                                                                                   {
      switch_.writeCfi(os, optional, startWithComma, indentation, wroteSomething);

      typename CaseMap::const_iterator selectedCase = cases_.find(switch_.getDefaultValue());
      if (selectedCase != cases_.end()) {
        selectedCase->second->writeCfi(os, optional, startWithComma, indentation, wroteSomething);
      }
    }

Member Data Documentation

template<class T >

CaseMap edm::ParameterSwitch< T >::cases_

private

Definition at line 159 of file ParameterSwitch.h.

Referenced by edm::ParameterSwitch< T >::checkAndGetLabelsAndTypes_(), edm::ParameterSwitch< T >::printNestedContent_(), edm::ParameterSwitch< T >::validate_(), and edm::ParameterSwitch< T >::writeCfi_().

template<class T >

ParameterDescription<T> edm::ParameterSwitch< T >::switch_

private

Definition at line 158 of file ParameterSwitch.h.

Referenced by edm::ParameterSwitch< T >::checkAndGetLabelsAndTypes_(), edm::ParameterSwitch< T >::exists_(), edm::ParameterSwitch< T >::print_(), edm::ParameterSwitch< T >::printNestedContent_(), edm::ParameterSwitch< T >::validate_(), and edm::ParameterSwitch< T >::writeCfi_().