edm::ParameterWildcard< std::vector< ParameterSet > > Class Template Reference

#include <ParameterWildcard.h>

Inheritance diagram for edm::ParameterWildcard< std::vector< ParameterSet > >:

Public Member Functions
virtual ParameterDescriptionNode *	clone () 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 &dfh)
virtual void	validate_ (ParameterSet &pset, std::set< std::string > &validatedLabels, bool optional) const
void	validatePSetVector (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< std::vector< ParameterSet > >

Definition at line 103 of file ParameterWildcard.h.

Constructor & Destructor Documentation

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

Definition at line 132 of file ParameterWildcard.cc.

References edm::ParameterWildcardBase::throwIfInvalidPattern().

                                                                                                   :
    ParameterWildcardBase(k_VPSet, isTracked, criteria),
    psetDesc_() {
    throwIfInvalidPattern(pattern);
  }

edm::ParameterWildcard< std::vector< ParameterSet > >::ParameterWildcard	(	char const *	pattern,
		WildcardValidationCriteria	criteria,
		bool	isTracked
	)

Definition at line 139 of file ParameterWildcard.cc.

References edm::ParameterWildcardBase::throwIfInvalidPattern().

                                                                                              :
    ParameterWildcardBase(k_VPSet, isTracked, criteria),
    psetDesc_() {
    throwIfInvalidPattern(pattern);
  }

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

Definition at line 146 of file ParameterWildcard.cc.

References edm::ParameterWildcardBase::throwIfInvalidPattern().

                                                         :
    ParameterWildcardBase(k_VPSet, isTracked, criteria),
    psetDesc_(new ParameterSetDescription(desc)) {
    throwIfInvalidPattern(pattern);
  }

edm::ParameterWildcard< std::vector< ParameterSet > >::ParameterWildcard	(	char const *	pattern,
		WildcardValidationCriteria	criteria,
		bool	isTracked,
		ParameterSetDescription const &	desc
	)

Definition at line 155 of file ParameterWildcard.cc.

References edm::ParameterWildcardBase::throwIfInvalidPattern().

                                                         :
    ParameterWildcardBase(k_VPSet, isTracked, criteria),
    psetDesc_(new ParameterSetDescription(desc)) {
    throwIfInvalidPattern(pattern);
  }

edm::ParameterWildcard< std::vector< ParameterSet > >::~ParameterWildcard ( )

virtual

Definition at line 164 of file ParameterWildcard.cc.

{ }

Member Function Documentation

ParameterDescriptionNode * edm::ParameterWildcard< std::vector< ParameterSet > >::clone ( void  ) const

virtual

Implements edm::ParameterDescriptionNode.

Definition at line 168 of file ParameterWildcard.cc.

                {
    return new ParameterWildcard(*this);
  }

bool edm::ParameterWildcard< std::vector< ParameterSet > >::exists_ ( ParameterSet const &  pset ) const

privatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 238 of file ParameterWildcard.cc.

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

                                          {

    if(criteria() == RequireZeroOrMore) return true;

    std::vector<std::string> parameterNames  = pset.getParameterNamesForType<std::vector<ParameterSet> >(isTracked());

    if(criteria() == RequireAtLeastOne) return parameterNames.size() >= 1U;
    return parameterNames.size() == 1U;
  }

bool edm::ParameterWildcard< std::vector< ParameterSet > >::hasNestedContent_ ( )

privatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 202 of file ParameterWildcard.cc.

                      {
    if(psetDesc_) return true;
    return false;
  }

void edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_ ( std::ostream &  os, bool  optional, DocFormatHelper &  dfh  )

privatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 209 of file ParameterWildcard.cc.

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

                                            {

    int indentation = dfh.indentation();
    if(dfh.parent() != DocFormatHelper::TOP) {
      indentation -= DocFormatHelper::offsetSectionContent();
    }

    printSpaces(os, indentation);
    os << "Section " << dfh.section() << "." << dfh.counter()
       << " description used to validate all PSets which are in the VPSet matching the wildcard:";
    os << "\n";
    if(!dfh.brief()) os << "\n";

    std::stringstream ss;
    ss << dfh.section() << "." << dfh.counter();
    std::string newSection = ss.str();

    DocFormatHelper new_dfh(dfh);
    new_dfh.setSection(newSection);
    new_dfh.setIndentation(indentation + DocFormatHelper::offsetSectionContent());
    new_dfh.setParent(DocFormatHelper::OTHER);

    psetDesc_->print(os, new_dfh);
  }

void edm::ParameterWildcard< std::vector< ParameterSet > >::validate_ ( ParameterSet &  pset, std::set< std::string > &  validatedLabels, bool  optional  ) const

privatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 174 of file ParameterWildcard.cc.

References edm::for_all(), and edm::ParameterSet::getParameterNamesForType().

                                 {

    std::vector<std::string> parameterNames  = pset.getParameterNamesForType<std::vector<ParameterSet> >(isTracked());
    validateMatchingNames(parameterNames, validatedLabels, optional);

    if(psetDesc_) {
      for_all(parameterNames,
              boost::bind(&ParameterWildcard<std::vector<ParameterSet> >::validatePSetVector,
                          boost::cref(this),
                          _1,
                          boost::ref(pset)));
    }
  }

void edm::ParameterWildcard< std::vector< ParameterSet > >::validatePSetVector ( std::string const &  parameterName, ParameterSet &  pset  ) const

private

Definition at line 192 of file ParameterWildcard.cc.

References edm::ParameterSet::getPSetVectorForUpdate(), i, edm::VParameterSetEntry::psetInVector(), and edm::VParameterSetEntry::size().

                                                                               {
    VParameterSetEntry* vpsetEntry = pset.getPSetVectorForUpdate(parameterName);
    assert(vpsetEntry);
    for(unsigned i = 0; i < vpsetEntry->size(); ++i) {
      psetDesc_->validate(vpsetEntry->psetInVector(i));
    }
  }

Member Data Documentation

value_ptr<ParameterSetDescription> edm::ParameterWildcard< std::vector< ParameterSet > >::psetDesc_

private

Definition at line 135 of file ParameterWildcard.h.