edm::PluginDescription< T > Class Template Reference

#include <PluginDescription.h>

Inheritance diagram for edm::PluginDescription< T >:

Public Member Functions
ParameterDescriptionNode *	clone () const final
	PluginDescription (std::string typeLabel, bool typeLabelIsTracked)
	PluginDescription (std::string typeLabel, std::string defaultType, bool typeLabelIsTracked)
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 () const
int	howManyXORSubNodesExist (ParameterSet const &pset) const
virtual bool	isWildcard () const
	ParameterDescriptionNode ()
	ParameterDescriptionNode (Comment const &iComment)
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 optional, bool &startWithComma, int indentation, CfiOptions &options, bool &wroteSomething) const
virtual	~ParameterDescriptionNode ()

Protected Member Functions
void	checkAndGetLabelsAndTypes_ (std::set< std::string > &usedLabels, std::set< ParameterTypes > &parameterTypes, std::set< ParameterTypes > &wildcardTypes) const final
bool	exists_ (ParameterSet const &pset) const final
bool	hasNestedContent_ () const final
int	howManyXORSubNodesExist_ (ParameterSet const &pset) const final
bool	partiallyExists_ (ParameterSet const &pset) const final
void	printNestedContent_ (std::ostream &os, bool, DocFormatHelper &dfh) const final
void	validate_ (ParameterSet &pset, std::set< std::string > &validatedLabels, bool optional) const final
void	writeCfi_ (std::ostream &os, bool optional, bool &startWithComma, int indentation, CfiOptions &options, bool &wroteSomething) const final
Protected Member Functions inherited from edm::ParameterDescriptionNode
virtual void	print_ (std::ostream &, bool, bool, DocFormatHelper &) const

Private Member Functions
std::string	findType (edm::ParameterSet const &iPSet) const
ParameterSetDescription	loadDescription (std::string const &iName) const

Private Attributes
std::string	defaultType_
std::string	typeLabel_
bool	typeLabelIsTracked_

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

template<typename T>
class edm::PluginDescription< T >

Definition at line 100 of file PluginDescription.h.

Constructor & Destructor Documentation

PluginDescription() [1/2]

template<typename T>

edm::PluginDescription< T >::PluginDescription ( std::string  typeLabel, bool  typeLabelIsTracked  )

inline

Constructor without a default for typeLabel

Parameters

[in]	typeLabel	the label for the std::string parameter which holds the plugin type to be loaded
[in]	typeLabelIsTracked	'true' if the parameter typeLabel is tracked, else should be false

Definition at line 106 of file PluginDescription.h.

References eostools::move().

        : typeLabel_{std::move(typeLabel)}, typeLabelIsTracked_{typeLabelIsTracked} {}

PluginDescription() [2/2]

template<typename T>

edm::PluginDescription< T >::PluginDescription ( std::string  typeLabel, std::string  defaultType, bool  typeLabelIsTracked  )

inline

Constructor with a default for typeLabel

Parameters

[in]	typeLabel	the label for the std::string parameter which holds the plugin type to be loaded
[in]	defaultType	the default plugin type that should be loaded if no type is given
[in]	typeLabelIsTracked	'true' if the parameter typeLabel is tracked, else should be false

Definition at line 114 of file PluginDescription.h.

References eostools::move().

        : typeLabel_{std::move(typeLabel)},
          defaultType_{std::move(defaultType)},
          typeLabelIsTracked_{typeLabelIsTracked} {}

Member Function Documentation

checkAndGetLabelsAndTypes_()

template<typename T>

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

inlinefinalprotectedvirtual

Implements edm::ParameterDescriptionNode.

Definition at line 123 of file PluginDescription.h.

                                                                                       {}

clone()

template<typename T>

ParameterDescriptionNode* edm::PluginDescription< T >::clone ( void  ) const

inlinefinalvirtual

Implements edm::ParameterDescriptionNode.

Definition at line 120 of file PluginDescription.h.

{ return new PluginDescription<T>(*this); }

exists_()

template<typename T>

bool edm::PluginDescription< T >::exists_ ( ParameterSet const &  pset ) const

inlinefinalprotectedvirtual

Implements edm::ParameterDescriptionNode.

Definition at line 237 of file PluginDescription.h.

References CMS_SA_ALLOW, muonDTDigis_cfi::pset, AlCaHLTBitMon_QueryRunRegistry::string, edm::PluginDescription< T >::typeLabel_, and edm::PluginDescription< T >::typeLabelIsTracked_.

Referenced by edm::PluginDescription< T >::partiallyExists_().

                                                       {
      CMS_SA_ALLOW return pset.existsAs<std::string>(typeLabel_, typeLabelIsTracked_);
    }

findType()

template<typename T>

std::string edm::PluginDescription< T >::findType ( edm::ParameterSet const &  iPSet ) const

inlineprivate

Definition at line 246 of file PluginDescription.h.

References CMS_SA_ALLOW, edm::PluginDescription< T >::defaultType_, edm::ParameterSet::existsAs(), edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), AlCaHLTBitMon_QueryRunRegistry::string, edm::PluginDescription< T >::typeLabel_, and edm::PluginDescription< T >::typeLabelIsTracked_.

Referenced by edm::PluginDescription< T >::validate_().

                                                           {
      if (typeLabelIsTracked_) {
        CMS_SA_ALLOW if (iPSet.existsAs<std::string>(typeLabel_) || defaultType_.empty()) {
          return iPSet.getParameter<std::string>(typeLabel_);
        }
        else {
          return defaultType_;
        }
      }
      if (defaultType_.empty()) {
        return iPSet.getUntrackedParameter<std::string>(typeLabel_);
      }
      return iPSet.getUntrackedParameter<std::string>(typeLabel_, defaultType_);
    }

hasNestedContent_()

template<typename T>

bool edm::PluginDescription< T >::hasNestedContent_ ( ) const

inlinefinalprotectedvirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 156 of file PluginDescription.h.

{ return true; }

howManyXORSubNodesExist_()

template<typename T>

int edm::PluginDescription< T >::howManyXORSubNodesExist_ ( ParameterSet const &  pset ) const

inlinefinalprotectedvirtual

Implements edm::ParameterDescriptionNode.

Definition at line 243 of file PluginDescription.h.

References edm::ParameterDescriptionNode::exists(), and muonDTDigis_cfi::pset.

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

loadDescription()

template<typename T>

ParameterSetDescription edm::PluginDescription< T >::loadDescription ( std::string const &  iName ) const

inlineprivate

Definition at line 261 of file PluginDescription.h.

References a, beamerCreator::create(), edm::PluginDescription< T >::defaultType_, submitPVResolutionJobs::desc, AlCaHLTBitMon_QueryRunRegistry::string, edm::PluginDescription< T >::typeLabel_, and edm::PluginDescription< T >::typeLabelIsTracked_.

Referenced by edm::PluginDescription< T >::printNestedContent_(), edm::PluginDescription< T >::validate_(), and edm::PluginDescription< T >::writeCfi_().

                                                                          {
      using CreatedType = PluginDescriptionAdaptorBase<typename T::CreatedType>;
      std::unique_ptr<CreatedType> a(edmplugin::PluginFactory<CreatedType*()>::get()->create(iName));

      ParameterSetDescription desc = a->description();

      //There is no way to check to see if a node already wants a label
      if (typeLabelIsTracked_) {
        if (defaultType_.empty()) {
          desc.add<std::string>(typeLabel_);
        } else {
          desc.add<std::string>(typeLabel_, defaultType_);
        }
      } else {
        if (defaultType_.empty()) {
          desc.addUntracked<std::string>(typeLabel_);
        } else {
          desc.addUntracked<std::string>(typeLabel_, defaultType_);
        }
      }
      return desc;
    }

partiallyExists_()

template<typename T>

bool edm::PluginDescription< T >::partiallyExists_ ( ParameterSet const &  pset ) const

inlinefinalprotectedvirtual

Implements edm::ParameterDescriptionNode.

Definition at line 241 of file PluginDescription.h.

References edm::PluginDescription< T >::exists_(), and muonDTDigis_cfi::pset.

{ return exists_(pset); }

printNestedContent_()

template<typename T>

void edm::PluginDescription< T >::printNestedContent_ ( std::ostream &  os, bool  , DocFormatHelper &  dfh  ) const

inlinefinalprotectedvirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 158 of file PluginDescription.h.

References spr::find(), edm::Factory::get(), edmplugin::PluginManager::get(), printContent_cfi::indentation, info(), edm::DocFormatHelper::init(), edm::PluginDescription< T >::loadDescription(), edm::DocFormatHelper::offsetSectionContent(), l1tGTMenu_BTagSeeds_cff::os, cond::pluginCategory(), edm::ParameterSetDescription::print(), edm::ParameterDescriptionNode::printSpaces(), edm::second(), hgcalPlots::section, edm::DocFormatHelper::setSection(), contentValuesCheck::ss, AlCaHLTBitMon_QueryRunRegistry::string, and edm::PluginDescription< T >::typeLabel_.

                                                                                       {
      int indentation = dfh.indentation();

      using CreatedType = PluginDescriptionAdaptorBase<typename T::CreatedType>;
      using Factory = edmplugin::PluginFactory<CreatedType*()>;

      std::string const& pluginCategory = Factory::get()->category();

      printSpaces(os, indentation);
      os << "There are multiple possible different descriptions for this ParameterSet\n";
      printSpaces(os, indentation);
      os << "because it will be used by a helper plugin object contained inside the top level\n";
      printSpaces(os, indentation);
      os << "module plugin object and the type of the helper plugin object is configurable.\n";
      printSpaces(os, indentation);
      os << "Or if it is in a vector of ParameterSets it might be used by multiple\n";
      printSpaces(os, indentation);
      os << "helper plugin objects and each could be configured with a different plugin type.\n";
      printSpaces(os, indentation);
      os << "Each plugin type could allow a different set of configuration parameters.\n";
      printSpaces(os, indentation);
      os << "Each subsection of this section has one of the possible descriptions.\n";
      printSpaces(os, indentation);
      os << "All of these plugins are from the category \"" << pluginCategory << "\".\n";
      printSpaces(os, indentation);
      os << "The plugin type is specified by the parameter named \"" << typeLabel_ << "\".\n";

      if (!dfh.brief()) {
        os << "\n";
      }
      std::string section = dfh.sectionOfCategoryAlreadyPrinted(pluginCategory);
      if (!section.empty()) {
        printSpaces(os, indentation);
        os << "*** The descriptions for this plugin category already started printing above (see Section " << section
           << ")! ***\n";
        printSpaces(os, indentation);
        os << "*** We might still be in the middle of that printout at this point because it might be recursive. ***\n";
        printSpaces(os, indentation);
        os << "*** We'll not duplicate that printout and skip it. ***\n";
        printSpaces(os, indentation);
        os << "*** (N.B. If we tried to print it again, we might fall into an infinite recursion.) ***\n";

        if (!dfh.brief()) {
          os << "\n";
        }
        return;
      }
      dfh.addCategory(pluginCategory, dfh.section());

      indentation -= DocFormatHelper::offsetSectionContent();

      //loop over all possible plugins
      unsigned int pluginCount = 1;
      std::string previousName;
      for (auto const& info : edmplugin::PluginManager::get()->categoryToInfos().find(pluginCategory)->second) {
        // We only want to print the first instance of each plugin name
        if (previousName == info.name_) {
          continue;
        }

        std::stringstream ss;
        ss << dfh.section() << "." << pluginCount;
        ++pluginCount;
        std::string newSection = ss.str();
        printSpaces(os, indentation);
        os << "Section " << newSection << " ParameterSet description for plugin named \"" << info.name_ << "\"\n";
        if (!dfh.brief())
          os << "\n";

        DocFormatHelper new_dfh(dfh);
        new_dfh.init();
        new_dfh.setSection(newSection);

        loadDescription(info.name_).print(os, new_dfh);

        previousName = info.name_;
      }
    }

validate_()

template<typename T>

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

inlinefinalprotectedvirtual

Implements edm::ParameterDescriptionNode.

Definition at line 127 of file PluginDescription.h.

References edm::PluginDescription< T >::findType(), edm::PluginDescription< T >::loadDescription(), create_idmaps::n, muonDTDigis_cfi::pset, and edm::ParameterSetDescription::validate().

                                                                                                      {
      loadDescription(findType(pset)).validate(pset);
      //all names are good
      auto n = pset.getParameterNames();
      validatedLabels.insert(n.begin(), n.end());
    }

writeCfi_()

template<typename T>

void edm::PluginDescription< T >::writeCfi_ ( std::ostream &  os, bool  optional, bool &  startWithComma, int  indentation, CfiOptions &  options, bool &  wroteSomething  ) const

inlinefinalprotectedvirtual

Implements edm::ParameterDescriptionNode.

Definition at line 134 of file PluginDescription.h.

References edmplugin::standard::config(), edmplugin::PluginManager::configure(), edm::PluginDescription< T >::defaultType_, printContent_cfi::indentation, edmplugin::PluginManager::isAvailable(), edm::PluginDescription< T >::loadDescription(), AlcaSiPixelAliHarvester0T_cff::options, l1tGTMenu_BTagSeeds_cff::os, edm::cfi::parameterMustBeTyped(), and edm::ParameterSetDescription::writeCfi().

                                                     {
      if (not defaultType_.empty()) {
        if (!edmplugin::PluginManager::isAvailable()) {
          auto conf = edmplugin::standard::config();
          conf.allowNoCache();
          edmplugin::PluginManager::configure(conf);
        }
        //given each plugin can have very different parameters we should do a full dump
        CfiOptions ops = cfi::Typed{};
        loadDescription(defaultType_).writeCfi(os, startWithComma, indentation, ops);
        wroteSomething = true;
      }
      if (std::holds_alternative<cfi::ClassFile>(options)) {
        std::get<cfi::ClassFile>(options).parameterMustBeTyped();
      }
    }

Member Data Documentation

defaultType_

template<typename T>

std::string edm::PluginDescription< T >::defaultType_

private

Definition at line 286 of file PluginDescription.h.

Referenced by edm::PluginDescription< T >::findType(), edm::PluginDescription< T >::loadDescription(), and edm::PluginDescription< T >::writeCfi_().

typeLabel_

template<typename T>

std::string edm::PluginDescription< T >::typeLabel_

private

Definition at line 285 of file PluginDescription.h.

Referenced by edm::PluginDescription< T >::exists_(), edm::PluginDescription< T >::findType(), edm::PluginDescription< T >::loadDescription(), and edm::PluginDescription< T >::printNestedContent_().

typeLabelIsTracked_

template<typename T>

bool edm::PluginDescription< T >::typeLabelIsTracked_

private

Definition at line 287 of file PluginDescription.h.

Referenced by edm::PluginDescription< T >::exists_(), edm::PluginDescription< T >::findType(), and edm::PluginDescription< T >::loadDescription().