CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Member Functions | Private Member Functions | Private Attributes
edm::ParameterWildcard< ParameterSetDescription > Class Template Reference

#include <ParameterWildcard.h>

Inheritance diagram for edm::ParameterWildcard< ParameterSetDescription >:
edm::ParameterWildcardBase edm::ParameterDescriptionNode

Public Member Functions

virtual ParameterDescriptionNodeclone () const
 
 ParameterWildcard (std::string const &pattern, WildcardValidationCriteria criteria, bool isTracked)
 
 ParameterWildcard (char const *pattern, WildcardValidationCriteria criteria, bool isTracked)
 
 ParameterWildcard (std::string const &pattern, WildcardValidationCriteria criteria, bool isTracked, ParameterSetDescription const &desc)
 
 ParameterWildcard (char const *pattern, WildcardValidationCriteria criteria, bool isTracked, ParameterSetDescription const &desc)
 
virtual ~ParameterWildcard ()
 
- Public Member Functions inherited from edm::ParameterWildcardBase
WildcardValidationCriteria criteria () const
 
bool isTracked () const
 
ParameterTypes type () const
 
virtual ~ParameterWildcardBase ()
 
- 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 ()
 
int howManyXORSubNodesExist (ParameterSet const &pset) const
 
bool partiallyExists (ParameterSet const &pset) const
 
void print (std::ostream &os, bool optional, bool writeToCfi, DocFormatHelper &dfh)
 
void printNestedContent (std::ostream &os, bool optional, DocFormatHelper &dfh)
 
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 &startWithComma, int indentation, bool &wroteSomething) const
 
virtual ~ParameterDescriptionNode ()
 

Private Member Functions

virtual bool exists_ (ParameterSet const &pset) const
 
virtual bool hasNestedContent_ ()
 
virtual void printNestedContent_ (std::ostream &os, bool optional, DocFormatHelper &helper)
 
virtual void validate_ (ParameterSet &pset, std::set< std::string > &validatedLabels, bool optional) const
 
void validateDescription (std::string const &parameterName, ParameterSet &pset) const
 

Private Attributes

value_ptr
< ParameterSetDescription
psetDesc_
 

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::ParameterWildcardBase
 ParameterWildcardBase (ParameterTypes iType, bool isTracked, WildcardValidationCriteria criteria)
 
void throwIfInvalidPattern (char const *pattern) const
 
void throwIfInvalidPattern (std::string const &pattern) const
 
void validateMatchingNames (std::vector< std::string > const &matchingNames, std::set< std::string > &validatedLabels, bool optional) const
 
- Protected Attributes inherited from edm::ParameterDescriptionNode
std::string comment_
 

Detailed Description

template<>
class edm::ParameterWildcard< ParameterSetDescription >

Definition at line 67 of file ParameterWildcard.h.

Constructor & Destructor Documentation

edm::ParameterWildcard< ParameterSetDescription >::ParameterWildcard ( std::string const &  pattern,
WildcardValidationCriteria  criteria,
bool  isTracked 
)

Definition at line 17 of file ParameterWildcard.cc.

References edm::ParameterWildcardBase::throwIfInvalidPattern().

17  :
19  psetDesc_() {
21  }
WildcardValidationCriteria criteria() const
void throwIfInvalidPattern(char const *pattern) const
value_ptr< ParameterSetDescription > psetDesc_
ParameterWildcardBase(ParameterTypes iType, bool isTracked, WildcardValidationCriteria criteria)
edm::ParameterWildcard< ParameterSetDescription >::ParameterWildcard ( char const *  pattern,
WildcardValidationCriteria  criteria,
bool  isTracked 
)

Definition at line 24 of file ParameterWildcard.cc.

References edm::ParameterWildcardBase::throwIfInvalidPattern().

24  :
26  psetDesc_() {
28  }
WildcardValidationCriteria criteria() const
void throwIfInvalidPattern(char const *pattern) const
value_ptr< ParameterSetDescription > psetDesc_
ParameterWildcardBase(ParameterTypes iType, bool isTracked, WildcardValidationCriteria criteria)
edm::ParameterWildcard< ParameterSetDescription >::ParameterWildcard ( std::string const &  pattern,
WildcardValidationCriteria  criteria,
bool  isTracked,
ParameterSetDescription const &  desc 
)

Definition at line 31 of file ParameterWildcard.cc.

References edm::ParameterWildcardBase::throwIfInvalidPattern().

31  :
35  }
WildcardValidationCriteria criteria() const
void throwIfInvalidPattern(char const *pattern) const
value_ptr< ParameterSetDescription > psetDesc_
ParameterWildcardBase(ParameterTypes iType, bool isTracked, WildcardValidationCriteria criteria)
edm::ParameterWildcard< ParameterSetDescription >::ParameterWildcard ( char const *  pattern,
WildcardValidationCriteria  criteria,
bool  isTracked,
ParameterSetDescription const &  desc 
)

Definition at line 39 of file ParameterWildcard.cc.

References edm::ParameterWildcardBase::throwIfInvalidPattern().

39  :
43  }
WildcardValidationCriteria criteria() const
void throwIfInvalidPattern(char const *pattern) const
value_ptr< ParameterSetDescription > psetDesc_
ParameterWildcardBase(ParameterTypes iType, bool isTracked, WildcardValidationCriteria criteria)

Definition at line 47 of file ParameterWildcard.cc.

47 { }

Member Function Documentation

Implements edm::ParameterDescriptionNode.

Definition at line 51 of file ParameterWildcard.cc.

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

51  {
52  return new ParameterWildcard(*this);
53  }
ParameterWildcard(std::string const &pattern, WildcardValidationCriteria criteria, bool isTracked)
bool edm::ParameterWildcard< ParameterSetDescription >::exists_ ( ParameterSet const &  pset) const
privatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 119 of file ParameterWildcard.cc.

References edm::ParameterWildcardBase::criteria(), edm::ParameterSet::getParameterNamesForType(), edm::ParameterWildcardBase::isTracked(), edm::RequireAtLeastOne, and edm::RequireZeroOrMore.

119  {
120 
121  if(criteria() == RequireZeroOrMore) return true;
122 
123  std::vector<std::string> parameterNames = pset.getParameterNamesForType<ParameterSet>(isTracked());
124 
125  if(criteria() == RequireAtLeastOne) return parameterNames.size() >= 1U;
126  return parameterNames.size() == 1U;
127  }
WildcardValidationCriteria criteria() const
bool edm::ParameterWildcard< ParameterSetDescription >::hasNestedContent_ ( )
privatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 83 of file ParameterWildcard.cc.

83  {
84  if(psetDesc_) return true;
85  return false;
86  }
value_ptr< ParameterSetDescription > psetDesc_
void edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_ ( std::ostream &  os,
bool  optional,
DocFormatHelper helper 
)
privatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 90 of file ParameterWildcard.cc.

References edm::DocFormatHelper::brief(), edm::DocFormatHelper::counter(), edm::DocFormatHelper::indentation(), edm::DocFormatHelper::offsetSectionContent(), edm::DocFormatHelper::OTHER, edm::DocFormatHelper::parent(), edm::ParameterDescriptionNode::printSpaces(), edm::DocFormatHelper::section(), edm::DocFormatHelper::setIndentation(), edm::DocFormatHelper::setParent(), edm::DocFormatHelper::setSection(), and edm::DocFormatHelper::TOP.

92  {
93 
94  int indentation = dfh.indentation();
95  if(dfh.parent() != DocFormatHelper::TOP) {
97  }
98 
99  printSpaces(os, indentation);
100  os << "Section " << dfh.section() << "." << dfh.counter()
101  << " description of PSet matching wildcard:";
102  os << "\n";
103  if(!dfh.brief()) os << "\n";
104 
105  std::stringstream ss;
106  ss << dfh.section() << "." << dfh.counter();
107  std::string newSection = ss.str();
108 
109  DocFormatHelper new_dfh(dfh);
110  new_dfh.setSection(newSection);
111  new_dfh.setIndentation(indentation + DocFormatHelper::offsetSectionContent());
112  new_dfh.setParent(DocFormatHelper::OTHER);
113 
114  psetDesc_->print(os, new_dfh);
115  }
static int offsetSectionContent()
static void printSpaces(std::ostream &os, int n)
value_ptr< ParameterSetDescription > psetDesc_
void edm::ParameterWildcard< ParameterSetDescription >::validate_ ( ParameterSet pset,
std::set< std::string > &  validatedLabels,
bool  optional 
) const
privatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 57 of file ParameterWildcard.cc.

References edm::for_all(), edm::ParameterSet::getParameterNamesForType(), edm::ParameterWildcardBase::isTracked(), and edm::ParameterWildcardBase::validateMatchingNames().

59  {
60 
61  std::vector<std::string> parameterNames = pset.getParameterNamesForType<ParameterSet>(isTracked());
62  validateMatchingNames(parameterNames, validatedLabels, optional);
63 
64  if(psetDesc_) {
65  for_all(parameterNames,
67  boost::cref(this),
68  _1,
69  boost::ref(pset)));
70  }
71  }
void validateDescription(std::string const &parameterName, ParameterSet &pset) const
Func for_all(ForwardSequence &s, Func f)
wrapper for std::for_each
Definition: Algorithms.h:16
value_ptr< ParameterSetDescription > psetDesc_
void validateMatchingNames(std::vector< std::string > const &matchingNames, std::set< std::string > &validatedLabels, bool optional) const
void edm::ParameterWildcard< ParameterSetDescription >::validateDescription ( std::string const &  parameterName,
ParameterSet pset 
) const
private

Definition at line 75 of file ParameterWildcard.cc.

References edm::ParameterSet::getPSetForUpdate().

76  {
77  ParameterSet* containedPSet = pset.getPSetForUpdate(parameterName);
78  psetDesc_->validate(*containedPSet);
79  }
value_ptr< ParameterSetDescription > psetDesc_

Member Data Documentation

Definition at line 99 of file ParameterWildcard.h.