edm::AllowedLabelsDescriptionBase Class Reference

#include <AllowedLabelsDescriptionBase.h>

Inheritance diagram for edm::AllowedLabelsDescriptionBase:

Public Member Functions
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
virtual ParameterDescriptionNode *	clone () const =0
std::string const &	comment () const
bool	exists (ParameterSet const &pset) const
bool	hasNestedContent () const
int	howManyXORSubNodesExist (ParameterSet const &pset) const
bool	partiallyExists (ParameterSet const &pset) const
void	print (std::ostream &os, bool optional, bool writeToCfi, DocFormatHelper &dfh) const
void	printNestedContent (std::ostream &os, bool optional, DocFormatHelper &dfh) const
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 ()

Protected Member Functions
	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) const

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

Private Attributes
bool	isTracked_
ParameterDescription < std::vector< std::string > >	parameterHoldingLabels_
ParameterTypes	type_

Additional Inherited Members
Static Public Member Functions inherited from edm::ParameterDescriptionNode
static void	printSpaces (std::ostream &os, int n)
Protected Attributes inherited from edm::ParameterDescriptionNode
std::string	comment_

Detailed Description

Definition at line 16 of file AllowedLabelsDescriptionBase.h.

Constructor & Destructor Documentation

edm::AllowedLabelsDescriptionBase::~AllowedLabelsDescriptionBase ( )

virtual

Definition at line 13 of file AllowedLabelsDescriptionBase.cc.

{ }

edm::AllowedLabelsDescriptionBase::AllowedLabelsDescriptionBase ( std::string const &  label, ParameterTypes  iType, bool  isTracked  )

protected

Definition at line 16 of file AllowedLabelsDescriptionBase.cc.

                                                                                            :
    parameterHoldingLabels_(label, std::vector<std::string>(), isTracked),
    type_(iType),
    isTracked_(isTracked) {
  }

edm::AllowedLabelsDescriptionBase::AllowedLabelsDescriptionBase ( char const *  label, ParameterTypes  iType, bool  isTracked  )

protected

Definition at line 23 of file AllowedLabelsDescriptionBase.cc.

                                                                                       :
    parameterHoldingLabels_(label, std::vector<std::string>(), isTracked),
    type_(iType),
    isTracked_(isTracked) {
  }

Member Function Documentation

void edm::AllowedLabelsDescriptionBase::checkAndGetLabelsAndTypes_ ( std::set< std::string > &  usedLabels, std::set< ParameterTypes > &  parameterTypes, std::set< ParameterTypes > &  wildcardTypes  ) const

privatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 32 of file AllowedLabelsDescriptionBase.cc.

References edm::ParameterDescriptionNode::checkAndGetLabelsAndTypes(), and parameterHoldingLabels_.

                                                                           {

    parameterHoldingLabels_.checkAndGetLabelsAndTypes(usedLabels, parameterTypes, wildcardTypes);
  }

bool edm::AllowedLabelsDescriptionBase::exists_ ( ParameterSet const &  pset ) const

privatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 171 of file AllowedLabelsDescriptionBase.cc.

References edm::ParameterDescriptionNode::exists(), and parameterHoldingLabels_.

                                          {
    return parameterHoldingLabels_.exists(pset);
  }

bool edm::AllowedLabelsDescriptionBase::hasNestedContent_ ( ) const

privatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 119 of file AllowedLabelsDescriptionBase.cc.

                            {
    return true;
  }

int edm::AllowedLabelsDescriptionBase::howManyXORSubNodesExist_ ( ParameterSet const &  pset ) const

privatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 183 of file AllowedLabelsDescriptionBase.cc.

References edm::ParameterDescriptionNode::exists().

                                                           {
    return exists(pset) ? 1 : 0;
  }

bool edm::AllowedLabelsDescriptionBase::isTracked ( ) const

inline

Definition at line 22 of file AllowedLabelsDescriptionBase.h.

References isTracked_.

Referenced by Types.PSet::clone(), Mixins._ParameterTypeBase::configTypeName(), Types.int32::insertInto(), Types.uint32::insertInto(), Types.int64::insertInto(), Types.uint64::insertInto(), Mixins.UsingBlock::insertInto(), Types.double::insertInto(), Types.bool::insertInto(), Types.string::insertInto(), Types.EventID::insertInto(), Types.LuminosityBlockID::insertInto(), Types.LuminosityBlockRange::insertInto(), Types.EventRange::insertInto(), Types.InputTag::insertInto(), Types.ESInputTag::insertInto(), Types.FileInPath::insertInto(), Types.PSet::insertInto(), Types.vint32::insertInto(), Types.vuint32::insertInto(), Types.vint64::insertInto(), Types.vuint64::insertInto(), Types.vdouble::insertInto(), Types.vbool::insertInto(), Types.vstring::insertInto(), Types.VLuminosityBlockID::insertInto(), Types.VInputTag::insertInto(), Types.VESInputTag::insertInto(), Types.VEventID::insertInto(), Types.VLuminosityBlockRange::insertInto(), Types.VEventRange::insertInto(), Types.VPSet::insertInto(), printNestedContentBase_(), Mixins._ParameterTypeBase::pythonTypeName(), validate_(), edm::AllowedLabelsDescription< T >::validateAllowedLabel_(), and edm::AllowedLabelsDescription< ParameterSetDescription >::validateAllowedLabel_().

{ return isTracked_; }

bool edm::AllowedLabelsDescriptionBase::partiallyExists_ ( ParameterSet const &  pset ) const

privatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 177 of file AllowedLabelsDescriptionBase.cc.

References edm::ParameterDescriptionNode::exists().

                                                   {
    return exists(pset);
  }

void edm::AllowedLabelsDescriptionBase::print_ ( std::ostream &  os, bool  optional, bool  writeToCfi, DocFormatHelper &  dfh  ) const

privatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 73 of file AllowedLabelsDescriptionBase.cc.

References edm::DocFormatHelper::brief(), edm::ParameterDescriptionNode::comment(), edm::DocFormatHelper::commentWidth(), edm::DocFormatHelper::counter(), relativeConstraints::empty, edm::DocFormatHelper::indent(), edm::DocFormatHelper::indent2(), edm::ParameterDescriptionBase::label(), parameterHoldingLabels_, edm::DocFormatHelper::pass(), edm::DocFormatHelper::section(), edm::DocFormatHelper::startColumn2(), and edm::DocFormatHelper::wrapAndPrintText().

  {
    if (dfh.pass() == 1) {

      dfh.indent(os);
      os << parameterHoldingLabels_.label() << " (list of allowed labels)";

      if (dfh.brief()) {

        if (optional)  os << " optional";

        if (!writeToCfi) os << " (do not write to cfi)";

        os << " see Section " << dfh.section() << "." << dfh.counter() << "\n";
      }
      // not brief
      else {

        os << "\n";
        dfh.indent2(os);

        if (optional)  os << "optional";
        if (!writeToCfi) os << " (do not write to cfi)";
        if (optional || !writeToCfi) {
          os << "\n";
          dfh.indent2(os);
        }

        os << "see Section " << dfh.section() << "." << dfh.counter() << "\n";

        if (!comment().empty()) {
          DocFormatHelper::wrapAndPrintText(os,
                                            comment(),
                                            dfh.startColumn2(),
                                            dfh.commentWidth());
        }
        os << "\n";
      }
    }
  }

void edm::AllowedLabelsDescriptionBase::printNestedContent_ ( std::ostream &  os, bool  optional, DocFormatHelper &  dfh  ) const

privatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Reimplemented in edm::AllowedLabelsDescription< std::vector< ParameterSet > >, and edm::AllowedLabelsDescription< ParameterSetDescription >.

Definition at line 126 of file AllowedLabelsDescriptionBase.cc.

References edm::DocFormatHelper::brief(), and printNestedContentBase_().

                                                   {
    printNestedContentBase_(os, optional, dfh);
    if (!dfh.brief()) os << "\n";
  }

void edm::AllowedLabelsDescriptionBase::printNestedContentBase_ ( std::ostream &  os, bool  optional, DocFormatHelper &  dfh  ) const

protected

Definition at line 135 of file AllowedLabelsDescriptionBase.cc.

References edm::DocFormatHelper::brief(), edm::DocFormatHelper::counter(), edm::DocFormatHelper::indent(), edm::DocFormatHelper::indent2(), edm::DocFormatHelper::indentation(), edm::DocFormatHelper::init(), isTracked(), edm::ParameterDescriptionBase::label(), edm::DocFormatHelper::offsetSectionContent(), parameterHoldingLabels_, edm::parameterTypeEnumToString(), edm::DocFormatHelper::parent(), edm::ParameterDescriptionNode::print(), edm::ParameterDescriptionNode::printSpaces(), edm::DocFormatHelper::section(), edm::DocFormatHelper::setPass(), edm::DocFormatHelper::TOP, and type().

Referenced by printNestedContent_(), and edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_().

                                                       {

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

    printSpaces(os, indentation);
    os << "Section " << dfh.section() << "." << dfh.counter()
       << " " << parameterHoldingLabels_.label()
       << " - allowed labels description\n";
    printSpaces(os, indentation);
    os << "The following parameter contains a list of parameter labels\n";
    printSpaces(os, indentation);
    os << "which are allowed to be in the PSet\n";
    if (!dfh.brief()) os << "\n";

    DocFormatHelper new_dfh(dfh);
    new_dfh.init();
    new_dfh.setPass(1);
    parameterHoldingLabels_.print(os, optional, true, new_dfh);
    dfh.indent(os);
    os << "type of allowed parameters:";
    if (dfh.brief()) os << " ";
    else {
      os << "\n";
      dfh.indent2(os);
    } 
    if (!isTracked()) os << "untracked ";
    os << parameterTypeEnumToString(type()) << "\n";
  }

ParameterTypes edm::AllowedLabelsDescriptionBase::type ( ) const

inline

Definition at line 21 of file AllowedLabelsDescriptionBase.h.

References type_.

Referenced by cuy.ValElement::__init__(), and printNestedContentBase_().

{ return type_; }

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

privatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 41 of file AllowedLabelsDescriptionBase.cc.

References edm::ParameterDescriptionNode::exists(), edm::for_all(), edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), isTracked(), edm::ParameterDescriptionBase::label(), parameterHoldingLabels_, edm::ParameterDescriptionNode::validate(), and validateAllowedLabel_().

                                 {

    parameterHoldingLabels_.validate(pset, validatedLabels, optional);
    if (parameterHoldingLabels_.exists(pset)) {
      std::vector<std::string> allowedLabels;
      if (isTracked()) {
        allowedLabels = pset.getParameter<std::vector<std::string> >(parameterHoldingLabels_.label());
      }
      else {
        allowedLabels = pset.getUntrackedParameter<std::vector<std::string> >(parameterHoldingLabels_.label());
      }
      for_all(allowedLabels, std::bind(&AllowedLabelsDescriptionBase::validateAllowedLabel_,
                                         this,
                                         std::placeholders::_1,
                                         std::ref(pset),
                                         std::ref(validatedLabels)));
    }
  }

virtual void edm::AllowedLabelsDescriptionBase::validateAllowedLabel_ ( std::string const &  allowedLabel, ParameterSet &  pset, std::set< std::string > &  validatedLabels  ) const

privatepure virtual

Implemented in edm::AllowedLabelsDescription< std::vector< ParameterSet > >, edm::AllowedLabelsDescription< ParameterSetDescription >, and edm::AllowedLabelsDescription< T >.

Referenced by validate_().

void edm::AllowedLabelsDescriptionBase::writeCfi_ ( std::ostream &  os, bool &  startWithComma, int  indentation, bool &  wroteSomething  ) const

privatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 64 of file AllowedLabelsDescriptionBase.cc.

References parameterHoldingLabels_, and edm::ParameterDescriptionNode::writeCfi().

                                         {
    parameterHoldingLabels_.writeCfi(os, startWithComma, indentation, wroteSomething);
  }

Member Data Documentation

bool edm::AllowedLabelsDescriptionBase::isTracked_

private

Definition at line 73 of file AllowedLabelsDescriptionBase.h.

Referenced by isTracked().

ParameterDescription<std::vector<std::string> > edm::AllowedLabelsDescriptionBase::parameterHoldingLabels_

private

Definition at line 71 of file AllowedLabelsDescriptionBase.h.

Referenced by checkAndGetLabelsAndTypes_(), exists_(), print_(), printNestedContentBase_(), validate_(), and writeCfi_().

ParameterTypes edm::AllowedLabelsDescriptionBase::type_

private

Definition at line 72 of file AllowedLabelsDescriptionBase.h.

Referenced by Modules.Service::_placeImpl(), Modules.ESSource::_placeImpl(), Modules.ESProducer::_placeImpl(), Modules.ESPrefer::copy(), Mixins._TypedParameterizable::dumpPython(), Modules.ESPrefer::dumpPythonAs(), Modules.Service::insertInto(), RandomRunSource.RandomRunSource::insertInto(), Mixins._TypedParameterizable::insertInto(), Modules.ESSource::moduleLabel_(), Modules.ESProducer::moduleLabel_(), Modules.ESSource::nameInProcessDesc_(), Modules.ESProducer::nameInProcessDesc_(), Modules.ESPrefer::nameInProcessDesc_(), and type().