CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Public Attributes | Private Member Functions | Private Attributes
edm::ParameterDescription< T > Class Template Reference

#include <ParameterDescription.h>

Inheritance diagram for edm::ParameterDescription< T >:
edm::ParameterDescriptionBase edm::ParameterDescriptionNode

Public Member Functions

ParameterDescriptionNodeclone () const override
 
T getDefaultValue () const
 
 ParameterTypeToEnum::toEnum ()
 
 ParameterTypeToEnum::toEnum ()
 
 ParameterTypeToEnum::toEnum ()
 
 ParameterTypeToEnum::toEnum ()
 
 value_ (value)
 
 value_ (value)
 
 value_ ()
 
 value_ ()
 
 ~ParameterDescription () override
 
- Public Member Functions inherited from edm::ParameterDescriptionBase
bool hasDefault () const
 
bool isTracked () const
 
std::string const & label () const
 
virtual
ParameterSetDescription const * 
parameterSetDescription () const
 
virtual ParameterSetDescriptionparameterSetDescription ()
 
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 (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, bool &wroteSomething) const
 
virtual ~ParameterDescriptionNode ()
 

Public Attributes

 __pad0__: ParameterDescriptionBase(iLabel
 
 __pad1__: ParameterDescriptionBase(iLabel
 
 __pad2__: ParameterDescriptionBase(iLabel
 
 __pad3__: ParameterDescriptionBase(iLabel
 
 false
 
 iComment
 
 isTracked
 
 true
 

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

template<typename T>
edm::ParameterDescription< T >::~ParameterDescription ( )
inlineoverride

Definition at line 160 of file ParameterDescription.h.

160 {}

Member Function Documentation

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); }
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()); }
long double T
std::string const & label() const
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.

183  {
184  return pset.existsAs<T>(label(), isTracked);
185  }
long double T
std::string const & label() const
template<typename T>
T edm::ParameterDescription< T >::getDefaultValue ( ) const
inline

Definition at line 164 of file ParameterDescription.h.

template<typename T>
bool edm::ParameterDescription< T >::hasNestedContent_ ( ) const
inlineoverrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 169 of file ParameterDescription.h.

169  {
170  if (!hasDefault())
171  return false;
173  }
bool hasNestedContent(int const &value)
template<typename T>
void edm::ParameterDescription< T >::insertDefault_ ( ParameterSet pset) const
inlineoverrideprivatevirtual

Implements edm::ParameterDescriptionBase.

Definition at line 187 of file ParameterDescription.h.

187  {
188  if (isTracked()) {
189  pset.addParameter(label(), value_);
190  } else {
191  pset.addUntrackedParameter(label(), value_);
192  }
193  }
std::string const & label() const
template<typename T>
edm::ParameterDescription< T >::value_ ( value  )
inline

Definition at line 122 of file ParameterDescription.h.

122 {}
template<typename T>
edm::ParameterDescription< T >::value_ ( value  )
inline

Definition at line 134 of file ParameterDescription.h.

134 {}
template<typename T>
edm::ParameterDescription< T >::value_ ( )
inline
template<typename T>
edm::ParameterDescription< T >::value_ ( )
inline

Definition at line 158 of file ParameterDescription.h.

158 {}
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.

175  {
177  }
void writeValue(std::ostream &os, int indentation, int const &value_, ValueFormat format)
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.

179  {
181  }
void writeValue(std::ostream &os, int indentation, int const &value_, ValueFormat format)

Member Data Documentation

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

Definition at line 121 of file ParameterDescription.h.

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

Definition at line 133 of file ParameterDescription.h.

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

Definition at line 145 of file ParameterDescription.h.

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

Definition at line 157 of file ParameterDescription.h.

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

Definition at line 145 of file ParameterDescription.h.

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

Definition at line 121 of file ParameterDescription.h.

template<typename T>
edm::ParameterDescription< T >::isTracked
template<typename T>
edm::ParameterDescription< T >::true

Definition at line 121 of file ParameterDescription.h.

template<typename T>
T edm::ParameterDescription< T >::value_
private

Definition at line 195 of file ParameterDescription.h.