---

edm::ParameterSetDescription Class Reference

#include <FWCore/ParameterSet/interface/ParameterSetDescription.h>

List of all members.

Public Types
typedef Parameters::const_iterator	parameter_const_iterator
typedef std::vector < boost::shared_ptr < ParameterDescription > >	Parameters
Public Member Functions
template<class T>
void	add (const std::string &iLabel)
template<class T>
void	addUntracked (const std::string &iLabel)
bool	anythingAllowed () const
bool	isUnknown () const
parameter_const_iterator	parameter_begin () const
parameter_const_iterator	parameter_end () const
	ParameterSetDescription ()
void	setAllowAnything ()
	allow any parameter label/value pairs
void	setUnknown ()
	This is set only for parameterizables which have not set their descriptions.
void	validate (const edm::ParameterSet &) const
virtual	~ParameterSetDescription ()
Private Attributes
bool	anythingAllowed_
Parameters	parameters_
bool	unknown_

---

Detailed Description

Definition at line 33 of file ParameterSetDescription.h.

---

Member Typedef Documentation

typedef Parameters::const_iterator edm::ParameterSetDescription::parameter_const_iterator

Definition at line 38 of file ParameterSetDescription.h.

typedef std::vector<boost::shared_ptr<ParameterDescription> > edm::ParameterSetDescription::Parameters

Definition at line 37 of file ParameterSetDescription.h.

---

Constructor & Destructor Documentation

ParameterSetDescription::ParameterSetDescription

(

)

Definition at line 30 of file ParameterSetDescription.cc.

                                                  :
  anythingAllowed_(false),
  unknown_(false)
{
}

ParameterSetDescription::~ParameterSetDescription

(

)

[virtual]

Definition at line 41 of file ParameterSetDescription.cc.

{
}

---

Member Function Documentation

template<class T>

void edm::ParameterSetDescription::add

(

const std::string &

iLabel

)

[inline]

Definition at line 52 of file ParameterSetDescription.h.

References parameters_.

                                          {
          parameters_.push_back( boost::shared_ptr<ParameterDescription>(new ParameterDescriptionTemplate<T>(iLabel,true) ) );
        }

template<class T>

void edm::ParameterSetDescription::addUntracked

(

const std::string &

iLabel

)

[inline]

Definition at line 57 of file ParameterSetDescription.h.

References parameters_.

                                                   {
          parameters_.push_back( new ParameterDescriptionTemplate<T>(iLabel,false) );
        }

bool edm::ParameterSetDescription::anythingAllowed

(

)

const [inline]

Definition at line 65 of file ParameterSetDescription.h.

References anythingAllowed_.

                                   {
        return anythingAllowed_;
      }

bool edm::ParameterSetDescription::isUnknown

(

)

const [inline]

Definition at line 69 of file ParameterSetDescription.h.

References unknown_.

                             {
        return unknown_;
      }

parameter_const_iterator edm::ParameterSetDescription::parameter_begin

(

)

const [inline]

Definition at line 73 of file ParameterSetDescription.h.

References parameters_.

                                                       {
        return parameters_.begin();
      }

parameter_const_iterator edm::ParameterSetDescription::parameter_end

(

)

const [inline]

Definition at line 76 of file ParameterSetDescription.h.

References parameters_.

                                                     {
        return parameters_.end();
      }

void ParameterSetDescription::setAllowAnything

(

)

allow any parameter label/value pairs

Definition at line 61 of file ParameterSetDescription.cc.

{
  anythingAllowed_ = true;
}

void ParameterSetDescription::setUnknown

(

)

This is set only for parameterizables which have not set their descriptions.

This should only be called to allow backwards compatibility.

Definition at line 67 of file ParameterSetDescription.cc.

References sistrip::unknown_.

Referenced by edm::EDProducer::fillDescription(), edm::EDFilter::fillDescription(), edm::EDAnalyzer::fillDescription(), and edm::OutputModule::fillDescription().

{
  unknown_ = true;
}

void ParameterSetDescription::validate

(

const edm::ParameterSet &

)

const

Definition at line 76 of file ParameterSetDescription.cc.

{ 
  //do nothing for now
  return;
  /*
  //Change this to 'not unknown_' when you want to enforce that all
  // parameterizables must declare their parameters
  if (unknown_) {
    return;
  }
  if( not anythingAllowed() ) {
    throw edm::Exception(errors::Configuration);
  }
   */
}

---

Member Data Documentation

bool edm::ParameterSetDescription::anythingAllowed_ [private]

Definition at line 89 of file ParameterSetDescription.h.

Referenced by anythingAllowed().

Parameters edm::ParameterSetDescription::parameters_ [private]

Definition at line 91 of file ParameterSetDescription.h.

Referenced by add(), addUntracked(), parameter_begin(), and parameter_end().

bool edm::ParameterSetDescription::unknown_ [private]

Definition at line 90 of file ParameterSetDescription.h.

Referenced by isUnknown().

---

The documentation for this class was generated from the following files:

• FWCore/ParameterSet/interface/ParameterSetDescription.h
• FWCore/ParameterSet/src/ParameterSetDescription.cc

---