CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
edm::ParameterDescriptionNode Class Referenceabstract

#include <ParameterDescriptionNode.h>

Inheritance diagram for edm::ParameterDescriptionNode:
edm::AllowedLabelsDescriptionBase edm::ANDGroupDescription edm::EmptyGroupDescription edm::IfExistsDescription edm::ORGroupDescription edm::ParameterDescriptionBase edm::ParameterSwitchBase edm::ParameterWildcardBase edm::XORGroupDescription

Public Member Functions

void checkAndGetLabelsAndTypes (std::set< std::string > &usedLabels, std::set< ParameterTypes > &parameterTypes, std::set< ParameterTypes > &wildcardTypes) const
 
virtual ParameterDescriptionNodeclone () const =0
 
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 ()
 

Static Public Member Functions

static void printSpaces (std::ostream &os, int n)
 

Protected Member Functions

virtual void checkAndGetLabelsAndTypes_ (std::set< std::string > &usedLabels, std::set< ParameterTypes > &parameterTypes, std::set< ParameterTypes > &wildcardTypes) const =0
 
virtual bool exists_ (ParameterSet const &pset) const =0
 
virtual bool hasNestedContent_ ()
 
virtual int howManyXORSubNodesExist_ (ParameterSet const &pset) const =0
 
virtual bool partiallyExists_ (ParameterSet const &pset) const =0
 
virtual void print_ (std::ostream &, bool, bool, DocFormatHelper &)
 
virtual void printNestedContent_ (std::ostream &, bool, DocFormatHelper &)
 
virtual void validate_ (ParameterSet &pset, std::set< std::string > &validatedLabels, bool optional) const =0
 
virtual void writeCfi_ (std::ostream &os, bool &startWithComma, int indentation, bool &wroteSomething) const =0
 

Protected Attributes

std::string comment_
 

Detailed Description

Definition at line 69 of file ParameterDescriptionNode.h.

Constructor & Destructor Documentation

edm::ParameterDescriptionNode::~ParameterDescriptionNode ( )
virtual

Definition at line 89 of file ParameterDescriptionNode.cc.

89  {
90  }

Member Function Documentation

void edm::ParameterDescriptionNode::checkAndGetLabelsAndTypes ( std::set< std::string > &  usedLabels,
std::set< ParameterTypes > &  parameterTypes,
std::set< ParameterTypes > &  wildcardTypes 
) const
inline

Definition at line 210 of file ParameterDescriptionNode.h.

References checkAndGetLabelsAndTypes_().

Referenced by edm::ParameterSetDescription::addNode(), and edm::AllowedLabelsDescriptionBase::checkAndGetLabelsAndTypes_().

212  {
213  checkAndGetLabelsAndTypes_(usedLabels, parameterTypes, wildcardTypes);
214  }
virtual void checkAndGetLabelsAndTypes_(std::set< std::string > &usedLabels, std::set< ParameterTypes > &parameterTypes, std::set< ParameterTypes > &wildcardTypes) const =0
virtual void edm::ParameterDescriptionNode::checkAndGetLabelsAndTypes_ ( std::set< std::string > &  usedLabels,
std::set< ParameterTypes > &  parameterTypes,
std::set< ParameterTypes > &  wildcardTypes 
) const
protectedpure virtual
virtual ParameterDescriptionNode* edm::ParameterDescriptionNode::clone ( ) const
pure virtual
std::string const& edm::ParameterDescriptionNode::comment ( ) const
inline
bool edm::ParameterDescriptionNode::exists ( ParameterSet const &  pset) const
inline
virtual bool edm::ParameterDescriptionNode::exists_ ( ParameterSet const &  pset) const
protectedpure virtual
bool edm::ParameterDescriptionNode::hasNestedContent ( )
inline
virtual bool edm::ParameterDescriptionNode::hasNestedContent_ ( )
inlineprotectedvirtual
int edm::ParameterDescriptionNode::howManyXORSubNodesExist ( ParameterSet const &  pset) const
inline

Definition at line 154 of file ParameterDescriptionNode.h.

References howManyXORSubNodesExist_().

154  {
156  }
virtual int howManyXORSubNodesExist_(ParameterSet const &pset) const =0
virtual int edm::ParameterDescriptionNode::howManyXORSubNodesExist_ ( ParameterSet const &  pset) const
protectedpure virtual
bool edm::ParameterDescriptionNode::partiallyExists ( ParameterSet const &  pset) const
inline

Definition at line 139 of file ParameterDescriptionNode.h.

References partiallyExists_().

Referenced by edm::ANDGroupDescription::validate_().

139  {
140  return partiallyExists_(pset);
141  }
virtual bool partiallyExists_(ParameterSet const &pset) const =0
virtual bool edm::ParameterDescriptionNode::partiallyExists_ ( ParameterSet const &  pset) const
protectedpure virtual
void edm::ParameterDescriptionNode::print ( std::ostream &  os,
bool  optional,
bool  writeToCfi,
DocFormatHelper dfh 
)

Definition at line 103 of file ParameterDescriptionNode.cc.

References hasNestedContent(), edm::DocFormatHelper::incrementCounter(), and print_().

Referenced by edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

106  {
107  if (hasNestedContent()) {
108  dfh.incrementCounter();
109  }
110  print_(os, optional, writeToCfi, dfh);
111  }
virtual void print_(std::ostream &, bool, bool, DocFormatHelper &)
virtual void edm::ParameterDescriptionNode::print_ ( std::ostream &  ,
bool  ,
bool  ,
DocFormatHelper  
)
inlineprotectedvirtual
void edm::ParameterDescriptionNode::printNestedContent ( std::ostream &  os,
bool  optional,
DocFormatHelper dfh 
)

Definition at line 114 of file ParameterDescriptionNode.cc.

References hasNestedContent(), edm::DocFormatHelper::incrementCounter(), and printNestedContent_().

116  {
117  if (hasNestedContent()) {
118  dfh.incrementCounter();
119  printNestedContent_(os, optional, dfh);
120  }
121  }
virtual void printNestedContent_(std::ostream &, bool, DocFormatHelper &)
virtual void edm::ParameterDescriptionNode::printNestedContent_ ( std::ostream &  ,
bool  ,
DocFormatHelper  
)
inlineprotectedvirtual
void edm::ParameterDescriptionNode::printSpaces ( std::ostream &  os,
int  n 
)
static
void edm::ParameterDescriptionNode::setComment ( std::string const &  value)
void edm::ParameterDescriptionNode::setComment ( char const *  value)

Definition at line 98 of file ParameterDescriptionNode.cc.

References comment_, and relativeConstraints::value.

void edm::ParameterDescriptionNode::validate ( ParameterSet pset,
std::set< std::string > &  validatedLabels,
bool  optional 
) const
inline

Definition at line 87 of file ParameterDescriptionNode.h.

References validate_().

Referenced by edm::AllowedLabelsDescriptionBase::validate_().

89  {
90  validate_(pset, validatedLabels, optional);
91  }
virtual void validate_(ParameterSet &pset, std::set< std::string > &validatedLabels, bool optional) const =0
virtual void edm::ParameterDescriptionNode::validate_ ( ParameterSet pset,
std::set< std::string > &  validatedLabels,
bool  optional 
) const
protectedpure virtual
void edm::ParameterDescriptionNode::writeCfi ( std::ostream &  os,
bool &  startWithComma,
int  indentation,
bool &  wroteSomething 
) const
inline

Definition at line 103 of file ParameterDescriptionNode.h.

References writeCfi_().

Referenced by edm::AllowedLabelsDescriptionBase::writeCfi_().

106  {
107  writeCfi_(os, startWithComma, indentation, wroteSomething);
108  }
virtual void writeCfi_(std::ostream &os, bool &startWithComma, int indentation, bool &wroteSomething) const =0
virtual void edm::ParameterDescriptionNode::writeCfi_ ( std::ostream &  os,
bool &  startWithComma,
int  indentation,
bool &  wroteSomething 
) const
protectedpure virtual

Member Data Documentation

std::string edm::ParameterDescriptionNode::comment_
protected

Definition at line 252 of file ParameterDescriptionNode.h.

Referenced by comment(), and setComment().