edm::AllowedLabelsDescription< ParameterSetDescription > Class Template Reference

#include <AllowedLabelsDescription.h>

Inheritance diagram for edm::AllowedLabelsDescription< ParameterSetDescription >:

Public Member Functions
	AllowedLabelsDescription (std::string const &label, bool isTracked)
	AllowedLabelsDescription (char const *label, bool isTracked)
	AllowedLabelsDescription (std::string const &label, ParameterSetDescription const &value, bool isTracked)
	AllowedLabelsDescription (char const *label, ParameterSetDescription const &value, bool isTracked)
virtual ParameterDescriptionNode *	clone () const
Public Member Functions inherited from edm::AllowedLabelsDescriptionBase
bool	isTracked () const
ParameterTypes	type () const
virtual	~AllowedLabelsDescriptionBase ()
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 void	printNestedContent_ (std::ostream &os, bool optional, DocFormatHelper &helper)
virtual void	validateAllowedLabel_ (std::string const &allowedLabel, ParameterSet &pset, std::set< std::string > &validatedLabels) 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::AllowedLabelsDescriptionBase
	AllowedLabelsDescriptionBase (std::string const &label, ParameterTypes iType, bool isTracked)
	AllowedLabelsDescriptionBase (char const *label, ParameterTypes iType, bool isTracked)
void	printNestedContentBase_ (std::ostream &os, bool optional, DocFormatHelper &dfh)
Protected Attributes inherited from edm::ParameterDescriptionNode
std::string	comment_

Detailed Description

template<>
class edm::AllowedLabelsDescription< ParameterSetDescription >

Definition at line 53 of file AllowedLabelsDescription.h.

Constructor & Destructor Documentation

edm::AllowedLabelsDescription< ParameterSetDescription >::AllowedLabelsDescription	(	std::string const &	label,
		bool	isTracked
	)

Definition at line 11 of file AllowedLabelsDescription.cc.

                                           :
    AllowedLabelsDescriptionBase(label, k_PSet, isTracked),
    psetDesc_()
  {              
  }

edm::AllowedLabelsDescription< ParameterSetDescription >::AllowedLabelsDescription	(	char const *	label,
		bool	isTracked
	)

Definition at line 19 of file AllowedLabelsDescription.cc.

                                           :
    AllowedLabelsDescriptionBase(label, k_PSet, isTracked),
    psetDesc_()
  {
  }

edm::AllowedLabelsDescription< ParameterSetDescription >::AllowedLabelsDescription	(	std::string const &	label,
		ParameterSetDescription const &	value,
		bool	isTracked
	)

Definition at line 27 of file AllowedLabelsDescription.cc.

                                           :
    AllowedLabelsDescriptionBase(label, k_PSet, isTracked),
    psetDesc_(new ParameterSetDescription(value))
  {              
  }

edm::AllowedLabelsDescription< ParameterSetDescription >::AllowedLabelsDescription	(	char const *	label,
		ParameterSetDescription const &	value,
		bool	isTracked
	)

Definition at line 36 of file AllowedLabelsDescription.cc.

                                           :
    AllowedLabelsDescriptionBase(label, k_PSet, isTracked),
    psetDesc_(new ParameterSetDescription(value))
  {
  }

Member Function Documentation

ParameterDescriptionNode * edm::AllowedLabelsDescription< ParameterSetDescription >::clone ( void  ) const

virtual

Implements edm::ParameterDescriptionNode.

Definition at line 46 of file AllowedLabelsDescription.cc.

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

                {
    return new AllowedLabelsDescription(*this);
  }

void edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_ ( std::ostream &  os, bool  optional, DocFormatHelper &  helper  )

privatevirtual

Reimplemented from edm::AllowedLabelsDescriptionBase.

Definition at line 52 of file AllowedLabelsDescription.cc.

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

                                             {

    printNestedContentBase_(os, optional, dfh);

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

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

    if (dfh.brief()) {
      printSpaces(os, indentation + DocFormatHelper::offsetSectionContent());
    }
    else {
      dfh.indent2(os);
    }
    os << "see Section " << newSection << "\n";
    if (!dfh.brief()) os << "\n";

    printSpaces(os, indentation);
    os << "Section " << newSection
       << " PSet description:\n";
    if (!dfh.brief()) os << "\n";

    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::AllowedLabelsDescription< ParameterSetDescription >::validateAllowedLabel_ ( std::string const &  allowedLabel, ParameterSet &  pset, std::set< std::string > &  validatedLabels  ) const

privatevirtual

Implements edm::AllowedLabelsDescriptionBase.

Definition at line 91 of file AllowedLabelsDescription.cc.

References edm::ParameterSet::existsAs(), edm::ParameterSet::getPSetForUpdate(), and edm::AllowedLabelsDescriptionBase::isTracked().

                                                                   {
    if (pset.existsAs<ParameterSet>(allowedLabel, isTracked())) {
      validatedLabels.insert(allowedLabel);
      if (psetDesc_) {
        ParameterSet * containedPSet = pset.getPSetForUpdate(allowedLabel);
        psetDesc_->validate(*containedPSet);
      }
    }
  }

Member Data Documentation

value_ptr<ParameterSetDescription> edm::AllowedLabelsDescription< ParameterSetDescription >::psetDesc_

private

Definition at line 82 of file AllowedLabelsDescription.h.