edm::ParameterDescriptionNode Class Reference

#include <ParameterDescriptionNode.h>

Inheritance diagram for edm::ParameterDescriptionNode:

List of all members.

Public Member Functions
void	checkAndGetLabelsAndTypes (std::set< std::string > &usedLabels, std::set< ParameterTypes > &parameterTypes, std::set< ParameterTypes > &wildcardTypes) const
virtual ParameterDescriptionNode *	clone () 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.

                                                      {
  }

---

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

                                                                                {
      checkAndGetLabelsAndTypes_(usedLabels, parameterTypes, wildcardTypes);
    }

virtual void edm::ParameterDescriptionNode::checkAndGetLabelsAndTypes_	(	std::set< std::string > &	usedLabels,
		std::set< ParameterTypes > &	parameterTypes,
		std::set< ParameterTypes > &	wildcardTypes
	)		const [protected, pure virtual]

Implemented in edm::AllowedLabelsDescriptionBase, edm::ANDGroupDescription, edm::EmptyGroupDescription, edm::IfExistsDescription, edm::ORGroupDescription, edm::ParameterDescriptionBase, edm::ParameterSwitch< T >, edm::ParameterWildcardBase, and edm::XORGroupDescription.

Referenced by checkAndGetLabelsAndTypes().

virtual ParameterDescriptionNode* edm::ParameterDescriptionNode::clone

(

)

const [pure virtual]

Implemented in edm::AllowedLabelsDescription< T >, edm::AllowedLabelsDescription< ParameterSetDescription >, edm::AllowedLabelsDescription< std::vector< ParameterSet > >, edm::ANDGroupDescription, edm::EmptyGroupDescription, edm::IfExistsDescription, edm::ORGroupDescription, edm::ParameterDescription< T >, edm::ParameterDescription< ParameterSetDescription >, edm::ParameterDescription< std::vector< ParameterSet > >, edm::ParameterSwitch< T >, edm::ParameterWildcard< T >, edm::ParameterWildcard< ParameterSetDescription >, edm::ParameterWildcard< std::vector< ParameterSet > >, edm::XORGroupDescription, and edm::ParameterDescription< std::vector< std::string > >.

Referenced by edm::ParameterSetDescription::addNode(), edm::ParameterSetDescription::addOptionalNode(), edm::value_ptr_traits< ParameterDescriptionNode >::clone(), and edm::operator>>().

std::string const& edm::ParameterDescriptionNode::comment

(

)

const [inline]

Definition at line 77 of file ParameterDescriptionNode.h.

References comment_.

Referenced by edm::AllowedLabelsDescriptionBase::print_(), edm::ANDGroupDescription::print_(), edm::ORGroupDescription::print_(), edm::ParameterDescriptionBase::print_(), edm::IfExistsDescription::print_(), edm::ParameterWildcardBase::print_(), edm::XORGroupDescription::print_(), and edm::ParameterSwitchBase::printBase().

{ return comment_; }

bool edm::ParameterDescriptionNode::exists

(

ParameterSet const &

pset

)

const [inline]

Definition at line 131 of file ParameterDescriptionNode.h.

References exists_().

Referenced by edm::AllowedLabelsDescriptionBase::exists_(), edm::ParameterSwitchBase::howManyXORSubNodesExist_(), edm::EmptyGroupDescription::howManyXORSubNodesExist_(), edm::AllowedLabelsDescriptionBase::howManyXORSubNodesExist_(), edm::ANDGroupDescription::howManyXORSubNodesExist_(), edm::ORGroupDescription::howManyXORSubNodesExist_(), edm::IfExistsDescription::howManyXORSubNodesExist_(), edm::ParameterDescriptionBase::howManyXORSubNodesExist_(), edm::ParameterWildcardBase::howManyXORSubNodesExist_(), edm::ORGroupDescription::partiallyExists_(), edm::ParameterSwitchBase::partiallyExists_(), edm::ParameterWildcardBase::partiallyExists_(), edm::AllowedLabelsDescriptionBase::partiallyExists_(), edm::ParameterDescriptionBase::partiallyExists_(), edm::EmptyGroupDescription::partiallyExists_(), edm::XORGroupDescription::partiallyExists_(), edm::IfExistsDescription::partiallyExists_(), edm::AllowedLabelsDescriptionBase::validate_(), edm::ParameterDescriptionBase::validate_(), and edm::ParameterDescription< ParameterSetDescription >::validate_().

                                                {
      return exists_(pset);
    }

virtual bool edm::ParameterDescriptionNode::exists_

(

ParameterSet const &

pset

)

const [protected, pure virtual]

Implemented in edm::AllowedLabelsDescriptionBase, edm::ANDGroupDescription, edm::EmptyGroupDescription, edm::IfExistsDescription, edm::ORGroupDescription, edm::ParameterDescription< T >, edm::ParameterDescription< ParameterSetDescription >, edm::ParameterDescription< std::vector< ParameterSet > >, edm::ParameterSwitch< T >, edm::ParameterWildcard< T >, edm::ParameterWildcard< ParameterSetDescription >, edm::ParameterWildcard< std::vector< ParameterSet > >, edm::XORGroupDescription, and edm::ParameterDescription< std::vector< std::string > >.

Referenced by exists().

bool edm::ParameterDescriptionNode::hasNestedContent

(

)

[inline]

Definition at line 116 of file ParameterDescriptionNode.h.

References hasNestedContent_().

Referenced by edm::ParameterDescription< std::vector< std::string > >::hasNestedContent_(), print(), edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::printDefault_(), and printNestedContent().

                            {
      return hasNestedContent_();
    }

virtual bool edm::ParameterDescriptionNode::hasNestedContent_

(

)

[inline, protected, virtual]

Reimplemented in edm::AllowedLabelsDescriptionBase, edm::ANDGroupDescription, edm::IfExistsDescription, edm::ORGroupDescription, edm::ParameterDescription< T >, edm::ParameterDescription< ParameterSetDescription >, edm::ParameterDescription< std::vector< ParameterSet > >, edm::ParameterSwitchBase, edm::ParameterWildcard< ParameterSetDescription >, edm::ParameterWildcard< std::vector< ParameterSet > >, edm::XORGroupDescription, and edm::ParameterDescription< std::vector< std::string > >.

Definition at line 238 of file ParameterDescriptionNode.h.

Referenced by hasNestedContent().

                                     {
      return false;
    }

int edm::ParameterDescriptionNode::howManyXORSubNodesExist

(

ParameterSet const &

pset

)

const [inline]

Definition at line 154 of file ParameterDescriptionNode.h.

References howManyXORSubNodesExist_().

                                                                {
      return howManyXORSubNodesExist_(pset);
    }

virtual int edm::ParameterDescriptionNode::howManyXORSubNodesExist_

(

ParameterSet const &

pset

)

const [protected, pure virtual]

Implemented in edm::AllowedLabelsDescriptionBase, edm::ANDGroupDescription, edm::EmptyGroupDescription, edm::IfExistsDescription, edm::ORGroupDescription, edm::ParameterDescriptionBase, edm::ParameterSwitchBase, edm::ParameterWildcardBase, and edm::XORGroupDescription.

Referenced by howManyXORSubNodesExist().

bool edm::ParameterDescriptionNode::partiallyExists

(

ParameterSet const &

pset

)

const [inline]

Definition at line 139 of file ParameterDescriptionNode.h.

References partiallyExists_().

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

                                                         {
      return partiallyExists_(pset);
    }

virtual bool edm::ParameterDescriptionNode::partiallyExists_

(

ParameterSet const &

pset

)

const [protected, pure virtual]

Implemented in edm::AllowedLabelsDescriptionBase, edm::ANDGroupDescription, edm::EmptyGroupDescription, edm::IfExistsDescription, edm::ORGroupDescription, edm::ParameterDescriptionBase, edm::ParameterSwitchBase, edm::ParameterWildcardBase, and edm::XORGroupDescription.

Referenced by partiallyExists().

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

                                                        {
    if (hasNestedContent()) {
      dfh.incrementCounter();
    }
    print_(os, optional, writeToCfi, dfh);
  }

virtual void edm::ParameterDescriptionNode::print_	(	std::ostream &	,
		bool	,
		bool	,
		DocFormatHelper &
	)		[inline, protected, virtual]

Reimplemented in edm::AllowedLabelsDescriptionBase, edm::ANDGroupDescription, edm::EmptyGroupDescription, edm::IfExistsDescription, edm::ORGroupDescription, edm::ParameterDescriptionBase, edm::ParameterSwitch< T >, edm::ParameterWildcardBase, and edm::XORGroupDescription.

Definition at line 233 of file ParameterDescriptionNode.h.

Referenced by print().

                                          { }

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

                                                                     {
    if (hasNestedContent()) {
      dfh.incrementCounter();
      printNestedContent_(os, optional, dfh);
    }
  }

virtual void edm::ParameterDescriptionNode::printNestedContent_	(	std::ostream &	,
		bool	,
		DocFormatHelper &
	)		[inline, protected, virtual]

Reimplemented in edm::AllowedLabelsDescription< ParameterSetDescription >, edm::AllowedLabelsDescription< std::vector< ParameterSet > >, edm::AllowedLabelsDescriptionBase, edm::ANDGroupDescription, edm::IfExistsDescription, edm::ORGroupDescription, edm::ParameterDescription< ParameterSetDescription >, edm::ParameterDescription< std::vector< ParameterSet > >, edm::ParameterDescriptionBase, edm::ParameterSwitch< T >, edm::ParameterWildcard< ParameterSetDescription >, edm::ParameterWildcard< std::vector< ParameterSet > >, and edm::XORGroupDescription.

Definition at line 242 of file ParameterDescriptionNode.h.

Referenced by printNestedContent().

                                                       { }

void edm::ParameterDescriptionNode::printSpaces	(	std::ostream &	os,
		int	n
	)		[static]

Definition at line 124 of file ParameterDescriptionNode.cc.

Referenced by edm::XORGroupDescription::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), edm::AllowedLabelsDescriptionBase::printNestedContentBase_(), and edm::ParameterDescriptionBase::writeCfi_().

                                                             {
    char oldFill = os.fill(' ');
    os.width(n);
    os << "";
    os.fill(oldFill);
  }

void edm::ParameterDescriptionNode::setComment

(

char const *

value

)

Definition at line 98 of file ParameterDescriptionNode.cc.

References comment_, and relativeConstraints::value.

                                                        {
    comment_ = value;
  }

void edm::ParameterDescriptionNode::setComment

(

std::string const &

value

)

Definition at line 93 of file ParameterDescriptionNode.cc.

References comment_, and relativeConstraints::value.

Referenced by edm::EventContentAnalyzer::fillDescriptions(), edm::AsciiOutputModule::fillDescriptions(), edm::service::RandomNumberGeneratorService::fillDescriptions(), edm::service::EnableFloatingPointExceptions::fillDescriptions(), edm::service::ResourceEnforcer::fillDescriptions(), and edm::EventSetupRecordDataGetter::fillDescriptions().

                                                             {
    comment_ = 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_().

                                       {
      validate_(pset, validatedLabels, optional);
    }

virtual void edm::ParameterDescriptionNode::validate_	(	ParameterSet &	pset,
		std::set< std::string > &	validatedLabels,
		bool	optional
	)		const [protected, pure virtual]

Implemented in edm::AllowedLabelsDescriptionBase, edm::ANDGroupDescription, edm::EmptyGroupDescription, edm::IfExistsDescription, edm::ORGroupDescription, edm::ParameterDescription< ParameterSetDescription >, edm::ParameterDescription< std::vector< ParameterSet > >, edm::ParameterDescriptionBase, edm::ParameterSwitch< T >, edm::ParameterWildcard< T >, edm::ParameterWildcard< ParameterSetDescription >, edm::ParameterWildcard< std::vector< ParameterSet > >, and edm::XORGroupDescription.

Referenced by validate().

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

                                              {
      writeCfi_(os, startWithComma, indentation, wroteSomething);
    }

virtual void edm::ParameterDescriptionNode::writeCfi_	(	std::ostream &	os,
		bool &	startWithComma,
		int	indentation,
		bool &	wroteSomething
	)		const [protected, pure virtual]

Implemented in edm::AllowedLabelsDescriptionBase, edm::ANDGroupDescription, edm::EmptyGroupDescription, edm::IfExistsDescription, edm::ORGroupDescription, edm::ParameterDescriptionBase, edm::ParameterSwitch< T >, edm::ParameterWildcardBase, and edm::XORGroupDescription.

Referenced by writeCfi().

---

Member Data Documentation

std::string edm::ParameterDescriptionNode::comment_ [protected]

Definition at line 252 of file ParameterDescriptionNode.h.

Referenced by comment(), and setComment().