#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

	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 &startWithComma, int indentation, 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 &startWithComma, int indentation, 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

std::shared_ptr< ParameterSetDescription >	loadDescription (std::string const &iName) const

void	loadPlugin (std::string const &iName) const

Private Attributes
std::shared_ptr< ParameterSetDescription >	cache_

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 97 of file PluginDescription.h.

Constructor & Destructor Documentation

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 104 of file PluginDescription.h.

References eostools::move(), and edm::PluginDescription< T >::typeLabelIsTracked_.

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

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 113 of file PluginDescription.h.

References edm::PluginDescription< T >::defaultType_, eostools::move(), and edm::PluginDescription< T >::typeLabelIsTracked_.

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

Member Function Documentation

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 125 of file PluginDescription.h.

                                                                                      {
     
   }

template<typename T>

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

inlinefinalvirtual

Implements edm::ParameterDescriptionNode.

Definition at line 119 of file PluginDescription.h.

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

template<typename T>

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

inlinefinalprotectedvirtual

Implements edm::ParameterDescriptionNode.

Definition at line 212 of file PluginDescription.h.

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

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

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

template<typename T>

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

inlineprivate

Definition at line 226 of file PluginDescription.h.

References 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_) {
       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_);
   }

template<typename T>

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

inlinefinalprotectedvirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 159 of file PluginDescription.h.

                                        {
     return true;
   }

template<typename T>

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

inlinefinalprotectedvirtual

Implements edm::ParameterDescriptionNode.

Definition at line 220 of file PluginDescription.h.

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

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

template<typename T>

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

inlineprivate

Definition at line 247 of file PluginDescription.h.

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

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

                                                 {
     using CreatedType = PluginDescriptionAdaptorBase<typename T::CreatedType>;
     std::unique_ptr<CreatedType> a(edmplugin::PluginFactory<CreatedType*()>::get()->create(iName));
     
     std::shared_ptr<ParameterSetDescription> desc = std::make_shared<ParameterSetDescription>(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;
   }

template<typename T>

void edm::PluginDescription< T >::loadPlugin ( std::string const & iName ) const

inlineprivate

Definition at line 240 of file PluginDescription.h.

References edm::PluginDescription< T >::cache_, and edm::PluginDescription< T >::loadDescription().

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

                                                 {
     if(not cache_) {
       cache_ = loadDescription(iName);
     }
   }

template<typename T>

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

inlinefinalprotectedvirtual

Implements edm::ParameterDescriptionNode.

Definition at line 216 of file PluginDescription.h.

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

                                                               {
     return exists_(pset);
   }

template<typename T>

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

inlinefinalprotectedvirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 163 of file PluginDescription.h.

References taus_updatedMVAIds_cff::category, spr::find(), edm::Factory::get(), edmplugin::PluginManager::get(), info(), edm::DocFormatHelper::init(), edm::PluginDescription< T >::loadDescription(), edm::ParameterDescriptionNode::printSpaces(), edm::second(), edm::DocFormatHelper::setSection(), and AlCaHLTBitMon_QueryRunRegistry::string.

                                                              {
     int indentation = dfh.indentation();
 
     using CreatedType = PluginDescriptionAdaptorBase<typename T::CreatedType>;
     using Factory = edmplugin::PluginFactory<CreatedType*()>;
 
     std::stringstream ss;
     ss << dfh.section() << "." << dfh.counter();
     std::string newSection = ss.str();
 
     printSpaces(os, indentation);
     os << "Section " << newSection
     << " " << Factory::get()->category() << " Plugins description:\n";
     if(!dfh.brief()) os << "\n";
 
     DocFormatHelper new_dfh(dfh);
     new_dfh.init();
     new_dfh.setSection(newSection);
 
     //loop over all possible plugins
     unsigned int pluginCount = 0;
     std::string previousName;
     for(auto const& info: edmplugin::PluginManager::get()->categoryToInfos().find(Factory::get()->category())->second) {
 
       // We only want to print the first instance of each plugin name
       if (previousName == info.name_) {
         continue;
       }
 
       std::stringstream ss;
       ss << dfh.section() << "." << dfh.counter();
       std::string newSection = ss.str();
       printSpaces(os, indentation);
       os << "Section " << newSection <<"."<< ++pluginCount
       << " " << info.name_ << " Plugin description:\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_;
     }
   }

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 133 of file PluginDescription.h.

References edm::PluginDescription< T >::cache_, edm::PluginDescription< T >::findType(), edm::PluginDescription< T >::loadPlugin(), gen::n, and muonDTDigis_cfi::pset.

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

template<typename T>

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

inlinefinalprotectedvirtual

Implements edm::ParameterDescriptionNode.

Definition at line 143 of file PluginDescription.h.

References edm::PluginDescription< T >::cache_, edmplugin::standard::config(), edmplugin::PluginManager::configure(), edm::PluginDescription< T >::defaultType_, and edm::PluginDescription< T >::loadPlugin().

                                                    {
     if(not defaultType_.empty()) {
       auto conf = edmplugin::standard::config();
       conf.allowNoCache();
       edmplugin::PluginManager::configure(conf);
 
       loadPlugin(defaultType_);
       
       cache_->writeCfi(os,startWithComma,indentation);
       wroteSomething = true;
     }
   }