#include <ParameterDescription.h>

Inheritance diagram for edm::ParameterDescription< T >:

Public Member Functions
ParameterDescriptionNode *	clone () const override

T	getDefaultValue () const

	ParameterDescription (char const *iLabel, bool isTracked, Comment const &iComment=Comment())

	ParameterDescription (char const *iLabel, T const &value, bool isTracked, Comment const &iComment=Comment())

	ParameterDescription (std::string const &iLabel, bool isTracked, Comment const &iComment=Comment())

	ParameterDescription (std::string const &iLabel, T const &value, bool isTracked, Comment const &iComment=Comment())

	~ParameterDescription () override

Public Member Functions inherited from edm::ParameterDescriptionBase
bool	hasDefault () const

bool	isTracked () const

std::string const &	label () const

virtual ParameterSetDescription *	parameterSetDescription ()

virtual ParameterSetDescription const *	parameterSetDescription () const

ParameterTypes	type () const

	~ParameterDescriptionBase () override

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 (char const *value)

void	setComment (std::string 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, bool &wroteSomething) const

virtual	~ParameterDescriptionNode ()

Private Member Functions
bool	exists_ (ParameterSet const &pset) const override

bool	exists_ (ParameterSet const &pset, bool isTracked) const override

bool	hasNestedContent_ () const override

void	insertDefault_ (ParameterSet &pset) const override

void	writeCfi_ (std::ostream &os, int indentation) const override

void	writeDoc_ (std::ostream &os, int indentation) const override

Private Attributes
T	value_

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::ParameterDescriptionBase
	ParameterDescriptionBase (char const *iLabel, ParameterTypes iType, bool isTracked, bool hasDefault, Comment const &iComment)

	ParameterDescriptionBase (std::string const &iLabel, ParameterTypes iType, bool isTracked, bool hasDefault, Comment const &iComment)

void	throwMissingRequiredNoDefault () const

void	throwParameterWrongTrackiness () const

void	throwParameterWrongType () const

Protected Attributes inherited from edm::ParameterDescriptionNode
std::string	comment_

Detailed Description

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

Definition at line 110 of file ParameterDescription.h.

Constructor & Destructor Documentation

◆ ParameterDescription() [1/4]

template<typename T>

edm::ParameterDescription< T >::ParameterDescription	(	std::string const &	iLabel,
		T const &	value,
		bool	isTracked,
		Comment const &	iComment = `Comment()`
	)

inline

Definition at line 112 of file ParameterDescription.h.

         :  // WARNING: the toEnum function is intentionally undefined if the template
           // parameter is ParameterSet or vector<ParameterSet>.  Both of these cases
           // are handled by full template specializations below.  In the first case.
           // ParameterSetDescription should be used instead of ParameterSet.
           // In the second case the function arguments are completely different.
           // Note that this template parameter is most often passed through from
           // an add*<T> function of class ParameterSetDescription. For vector<ParameterSet>
           // use the addVPSet* versions of those functions.
           ParameterDescriptionBase(iLabel, ParameterTypeToEnum::toEnum<T>(), isTracked, true, iComment),
           value_(value) {}

Referenced by edm::ParameterDescription< std::vector< std::string > >::clone(), edm::ParameterDescription< ParameterSetDescription >::clone(), and edm::ParameterDescription< std::vector< ParameterSet > >::clone().

◆ ParameterDescription() [2/4]

template<typename T>

edm::ParameterDescription< T >::ParameterDescription	(	char const *	iLabel,
		T const &	value,
		bool	isTracked,
		Comment const &	iComment = `Comment()`
	)

inline

Definition at line 124 of file ParameterDescription.h.

         :  // WARNING: the toEnum function is intentionally undefined if the template
           // parameter is ParameterSet or vector<ParameterSet>.  Both of these cases
           // are handled by full template specializations below.  In the first case.
           // ParameterSetDescription should be used instead of ParameterSet.
           // In the second case the function arguments are completely different.
           // Note that this template parameter is most often passed through from
           // an add*<T> function of class ParameterSetDescription. For vector<ParameterSet>
           // use the addVPSet* versions of those functions.
           ParameterDescriptionBase(iLabel, ParameterTypeToEnum::toEnum<T>(), isTracked, true, iComment),
           value_(value) {}

◆ ParameterDescription() [3/4]

template<typename T>

edm::ParameterDescription< T >::ParameterDescription	(	std::string const &	iLabel,
		bool	isTracked,
		Comment const &	iComment = `Comment()`
	)

inline

Definition at line 136 of file ParameterDescription.h.

         :  // WARNING: the toEnum function is intentionally undefined if the template
           // parameter is ParameterSet or vector<ParameterSet>.  Both of these cases
           // are handled by full template specializations below.  In the first case.
           // ParameterSetDescription should be used instead of ParameterSet.
           // In the second case the function arguments are completely different.
           // Note that this template parameter is most often passed through from
           // an add*<T> function of class ParameterSetDescription. For vector<ParameterSet>
           // use the addVPSet* versions of those functions.
           ParameterDescriptionBase(iLabel, ParameterTypeToEnum::toEnum<T>(), isTracked, false, iComment),
           value_() {}

◆ ParameterDescription() [4/4]

template<typename T>

edm::ParameterDescription< T >::ParameterDescription	(	char const *	iLabel,
		bool	isTracked,
		Comment const &	iComment = `Comment()`
	)

inline

Definition at line 148 of file ParameterDescription.h.

         :  // WARNING: the toEnum function is intentionally undefined if the template
           // parameter is ParameterSet or vector<ParameterSet>.  Both of these cases
           // are handled by full template specializations below.  In the first case.
           // ParameterSetDescription should be used instead of ParameterSet.
           // In the second case the function arguments are completely different.
           // Note that this template parameter is most often passed through from
           // an add*<T> function of class ParameterSetDescription. For vector<ParameterSet>
           // use the addVPSet* versions of those functions.
           ParameterDescriptionBase(iLabel, ParameterTypeToEnum::toEnum<T>(), isTracked, false, iComment),
           value_() {}

◆ ~ParameterDescription()

template<typename T>

edm::ParameterDescription< T >::~ParameterDescription ( )

inlineoverride

Definition at line 160 of file ParameterDescription.h.

160 {}

Member Function Documentation

◆ clone()

template<typename T>

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

inlineoverridevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 162 of file ParameterDescription.h.

162 { return new ParameterDescription(*this); }

◆ exists_() [1/2]

template<typename T>

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

inlineoverrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 167 of file ParameterDescription.h.

167 { return pset.existsAs<T>(label(), isTracked()); }

◆ exists_() [2/2]

template<typename T>

bool edm::ParameterDescription< T >::exists_	(	ParameterSet const &	pset,
		bool	isTracked
	)		const

inlineoverrideprivatevirtual

Implements edm::ParameterDescriptionBase.

Definition at line 183 of file ParameterDescription.h.

                                                                           {
       return pset.existsAs<T>(label(), isTracked);
     }

◆ getDefaultValue()

template<typename T>

T edm::ParameterDescription< T >::getDefaultValue ( ) const

inline

Definition at line 164 of file ParameterDescription.h.

164 { return value_; }

◆ hasNestedContent_()

template<typename T>

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

inlineoverrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 169 of file ParameterDescription.h.

                                             {
       if (!hasDefault())
         return false;
       return writeParameterValue::hasNestedContent(value_);
     }

◆ insertDefault_()

template<typename T>

void edm::ParameterDescription< T >::insertDefault_ ( ParameterSet & pset ) const

inlineoverrideprivatevirtual

Implements edm::ParameterDescriptionBase.

Definition at line 187 of file ParameterDescription.h.

                                                            {
       if (isTracked()) {
         pset.addParameter(label(), value_);
       } else {
         pset.addUntrackedParameter(label(), value_);
       }
     }

◆ writeCfi_()

template<typename T>

void edm::ParameterDescription< T >::writeCfi_	(	std::ostream &	os,
		int	indentation
	)		const

inlineoverrideprivatevirtual

Implements edm::ParameterDescriptionBase.

Definition at line 175 of file ParameterDescription.h.

                                                                    {
       writeParameterValue::writeValue(os, indentation, value_, writeParameterValue::CFI);
     }

◆ writeDoc_()

template<typename T>

void edm::ParameterDescription< T >::writeDoc_	(	std::ostream &	os,
		int	indentation
	)		const

inlineoverrideprivatevirtual

Implements edm::ParameterDescriptionBase.

Definition at line 179 of file ParameterDescription.h.

                                                                    {
       writeParameterValue::writeValue(os, indentation, value_, writeParameterValue::DOC);
     }

Member Data Documentation

◆ value_

template<typename T>

T edm::ParameterDescription< T >::value_

private

Definition at line 195 of file ParameterDescription.h.

Referenced by edm::ParameterDescription< std::vector< std::string > >::getDefaultValue(), edm::ParameterDescription< std::vector< std::string > >::hasNestedContent_(), edm::ParameterDescription< std::vector< std::string > >::insertDefault_(), edm::ParameterDescription< std::vector< std::string > >::writeCfi_(), and edm::ParameterDescription< std::vector< std::string > >::writeDoc_().

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ ParameterDescription() [1/4]

◆ ParameterDescription() [2/4]

◆ ParameterDescription() [3/4]

◆ ParameterDescription() [4/4]

◆ ~ParameterDescription()

Member Function Documentation

◆ clone()

◆ exists_() [1/2]

◆ exists_() [2/2]

◆ getDefaultValue()

◆ hasNestedContent_()

◆ insertDefault_()

◆ writeCfi_()

◆ writeDoc_()

Member Data Documentation

◆ value_

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