SiStripConfObject Class Reference

#include <SiStripConfObject.h>

Public Types
typedef std::map< std::string, std::string >	parMap

Public Member Functions
template<class valueType >
valueType	get (const std::string &name) const
bool	isParameter (const std::string &name) const
void	printDebug (std::stringstream &ss, const TrackerTopology *trackerTopo) const
	Prints the full list of parameters. More...
void	printSummary (std::stringstream &ss, const TrackerTopology *trackerTopo) const
	Prints the full list of parameters. More...
template<class valueType >
bool	put (const std::string &name, const valueType &inputValue)
	SiStripConfObject ()
template<class valueType >
bool	update (const std::string &name, const valueType &inputValue)

Public Attributes
parMap	parameters

Private Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Friends
class	boost::serialization::access
template<typename CondSerializationT , typename Enabled >
struct	cond::serialization::access

Detailed Description

Author M. De Mattia - 16/11/2009

Simple class used to store configuration values.
It stores a map<std::string, std::string> with all the parameters and their values.
The put and get methods are provided to store and access the parameters.
The put method retuns a bool which is true if the insertion was successuful. If the parameter is already existing the insertion will not happen and the return value will be false.
The get method is templated and works like the getParameter<type> of the framework.
The isParameter method can be used to check whether a parameter exists. It will return a bool with the result.
The printSummary and printDebug method return both the full list of parameters.

Definition at line 31 of file SiStripConfObject.h.

Member Typedef Documentation

parMap

typedef std::map<std::string, std::string> SiStripConfObject::parMap

Definition at line 83 of file SiStripConfObject.h.

Constructor & Destructor Documentation

SiStripConfObject()

SiStripConfObject::SiStripConfObject ( )

inline

Definition at line 33 of file SiStripConfObject.h.

{}

Member Function Documentation

get()

template<class valueType >

valueType SiStripConfObject::get ( const std::string &  name ) const

inline

Definition at line 63 of file SiStripConfObject.h.

                                             {
    valueType returnValue = 0;
    parMap::const_iterator it = parameters.find(name);
    std::stringstream ss;
    if (it != parameters.end()) {
      ss << it->second;
      ss >> returnValue;
    } else {
      std::cout << "WARNING: parameter " << name << " not found. Returning default value" << std::endl;
    }
    return returnValue;
  }

References gather_cfg::cout, Skims_PA_cff::name, and contentValuesCheck::ss.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), APVCyclePhaseProducerFromL1TS::beginRun(), rrapi.RRApi::columns(), util.rrapi.RRApi::columns(), rrapi.RRApi::count(), util.rrapi.RRApi::count(), rrapi.RRApi::data(), util.rrapi.RRApi::data(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), rrapi.RRApi::report(), util.rrapi.RRApi::report(), util.rrapi.RRApi::reports(), rrapi.RRApi::reports(), StripCPE::StripCPE(), util.rrapi.RRApi::tables(), rrapi.RRApi::tables(), rrapi.RRApi::tags(), util.rrapi.RRApi::tags(), util.rrapi.RRApi::templates(), rrapi.RRApi::templates(), util.rrapi.RRApi::workspaces(), and rrapi.RRApi::workspaces().

isParameter()

bool SiStripConfObject::isParameter ( const std::string &  name ) const

inline

Definition at line 76 of file SiStripConfObject.h.

{ return (parameters.find(name) != parameters.end()); }

References Skims_PA_cff::name.

Referenced by StripCPE::StripCPE().

printDebug()

void SiStripConfObject::printDebug	(	std::stringstream &	ss,
		const TrackerTopology *	trackerTopo
	)		const

Prints the full list of parameters.

Definition at line 115 of file SiStripConfObject.cc.

                                                                                                {
  printSummary(ss, trackerTopo);
}

References printSummary(), and contentValuesCheck::ss.

Referenced by APVCyclePhaseProducerFromL1TS::beginRun().

printSummary()

void SiStripConfObject::printSummary	(	std::stringstream &	ss,
		const TrackerTopology *	trackerTopo
	)		const

Prints the full list of parameters.

Definition at line 108 of file SiStripConfObject.cc.

                                                                                                  {
  parMap::const_iterator it = parameters.begin();
  for (; it != parameters.end(); ++it) {
    ss << "parameter name = " << it->first << " value = " << it->second << std::endl;
  }
}

References contentValuesCheck::ss.

Referenced by printDebug().

put()

template<class valueType >

bool SiStripConfObject::put ( const std::string &  name, const valueType &  inputValue  )

inline

Definition at line 36 of file SiStripConfObject.h.

                                                               {
    std::stringstream ss;
    ss << inputValue;
    if (parameters.insert(std::make_pair(name, ss.str())).second)
      return true;
    return false;
  }

References Skims_PA_cff::name, and contentValuesCheck::ss.

serialize()

template<class Archive >

void SiStripConfObject::serialize ( Archive &  ar, const unsigned int  version  )

private

update()

template<class valueType >

bool SiStripConfObject::update ( const std::string &  name, const valueType &  inputValue  )

inline

Updating the value stored as 'name' with 'inputValue'. False if parameter 'name' does not exist (and nothing is done then - use put(..) instead!), otherwise true.

Definition at line 48 of file SiStripConfObject.h.

                                                                  {
    parMap::iterator it = parameters.find(name);
    if (it == parameters.end()) {
      std::cout << "WARNING in SiStripConfObject::update: parameter " << name << " not found, "
                << "so cannot be updated to '" << inputValue << "'." << std::endl;
      return false;
    } else {
      std::stringstream ss;
      ss << inputValue;
      it->second = ss.str();
      return true;
    }
  }

References gather_cfg::cout, Skims_PA_cff::name, and contentValuesCheck::ss.

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), dqm-mbProfile.Profile::finish(), progressbar.ProgressBar::finish(), and MatrixUtil.Steps::overwrite().

Friends And Related Function Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Definition at line 87 of file SiStripConfObject.h.

cond::serialization::access

template<typename CondSerializationT , typename Enabled >

friend struct cond::serialization::access

friend

Definition at line 87 of file SiStripConfObject.h.

Member Data Documentation

parameters

parMap SiStripConfObject::parameters

Definition at line 85 of file SiStripConfObject.h.