cond::Utilities Class Reference

#include <Utilities.h>

Public Member Functions
void	addAuthenticationOptions ()
void	addConfigFileOption ()
void	addConnectOption (std::string const &fullName, std::string const &shortName, std::string const &helpEntry)
template<typename T >
void	addOption (const std::string &fullName, const std::string &shortName, const std::string &helpEntry)
template<>
void	addOption (const std::string &fullName, const std::string &shortName, const std::string &helpEntry)
virtual int	execute ()
std::string	getAuthenticationPathValue ()
std::string	getConfigFileValue ()
std::string	getConnectValue ()
std::string	getDictionaryValue ()
std::string	getLogDBValue ()
template<typename T >
T	getOptionValue (const std::string &fullName)
std::string	getPasswordValue ()
std::string	getUserValue ()
bool	hasDebug ()
bool	hasOptionValue (const std::string &fullName)
void	initializePluginManager ()
void	parseCommand (int argc, char **argv)
int	run (int argc, char **argv)
	Utilities (const std::string &commandName, std::string positionalParameter=std::string(""))
virtual	~Utilities ()

Protected Attributes
edm::ServiceToken *	m_currentToken = 0

Private Member Functions
std::string	getValueIfExists (const std::string &fullName)
void	sendError (const std::string &message)
void	sendException (const std::string &message)

Private Attributes
std::string	m_name
boost::program_options::options_description	m_options
boost::program_options::positional_options_description	m_positionalOptions
boost::program_options::variables_map	m_values

Detailed Description

Definition at line 22 of file Utilities.h.

Constructor & Destructor Documentation

cond::Utilities::Utilities	(	const std::string &	commandName,
		std::string	positionalParameter = std::string("")
	)

Definition at line 22 of file Utilities.cc.

References m_options, and m_positionalOptions.

                                                          :m_name(commandName),
                                 m_options(std::string("Usage: ")+m_name+
                                       std::string(" [options] ")+positionalParameter
                                       +std::string(" \n")),
                                 m_positionalOptions(),
                                 m_values(){
  m_options.add_options()
    ("debug","switch on debug mode")
    ("help,h", "help message")
    ;
  if(!positionalParameter.empty()) {
    m_positionalOptions.add( positionalParameter.c_str(), -1);
    addOption<std::string>(positionalParameter,"",positionalParameter);
  }
}

cond::Utilities::~Utilities ( )

virtual

Definition at line 40 of file Utilities.cc.

                         {
}

Member Function Documentation

void cond::Utilities::addAuthenticationOptions

(

)

Definition at line 86 of file Utilities.cc.

                                       {
  addOption<std::string>("authPath","P","path to the authentication key");
  addOption<std::string>("user","u","user name");
  addOption<std::string>("pass","p","password");
}

void cond::Utilities::addConfigFileOption

(

)

Definition at line 93 of file Utilities.cc.

                                  {
  addOption<std::string>("configFile","f","configuration file(optional)");
}

void cond::Utilities::addConnectOption	(	std::string const &	fullName,
		std::string const &	shortName,
		std::string const &	helpEntry
	)

Definition at line 79 of file Utilities.cc.

                                                              {
  addOption<std::string>(connectionOptionName,shortName,helpEntry);
}

template<typename T >

void cond::Utilities::addOption ( const std::string &  fullName, const std::string &  shortName, const std::string &  helpEntry  )

inline

Definition at line 81 of file Utilities.h.

                                                                                 {
  std::stringstream optInfo;
  optInfo << fullName;
  if(!shortName.empty()) optInfo << ","<<shortName;
  m_options.add_options()
    (optInfo.str().c_str(),boost::program_options::value<T>(),helpEntry.c_str());
}

template<>

void cond::Utilities::addOption ( const std::string &  fullName, const std::string &  shortName, const std::string &  helpEntry  )

inline

Definition at line 91 of file Utilities.h.

                                                                             {
  std::stringstream optInfo;
  optInfo << fullName;
  if(!shortName.empty()) optInfo << ","<<shortName;
  m_options.add_options()
    (optInfo.str().c_str(),helpEntry.c_str());
}

int cond::Utilities::execute ( )

virtual

Definition at line 43 of file Utilities.cc.

Referenced by run().

                          {
  return 0;
}

std::string cond::Utilities::getAuthenticationPathValue

(

)

Definition at line 111 of file Utilities.cc.

                                                   {
  return getOptionValue<std::string>("authPath");
}

std::string cond::Utilities::getConfigFileValue

(

)

Definition at line 135 of file Utilities.cc.

                                           {
  return getOptionValue<std::string>("configFile");
}

std::string cond::Utilities::getConnectValue

(

)

Definition at line 123 of file Utilities.cc.

                                        {
  return getOptionValue<std::string>("connect");  
}

std::string cond::Utilities::getDictionaryValue

(

)

Definition at line 131 of file Utilities.cc.

                                           {
  return getOptionValue<std::string>("dictionary");
}

std::string cond::Utilities::getLogDBValue

(

)

Definition at line 127 of file Utilities.cc.

                                      {
  return getOptionValue<std::string>("logDB");  
}

template<typename T >

T cond::Utilities::getOptionValue ( const std::string &  fullName )

inline

Definition at line 104 of file Utilities.h.

References runEdmFileComparison::found, and python.rootplot.argparse::message.

                                                                                     {
  const void* found = m_options.find_nothrow(fullName, false);
  if(!found){
    std::stringstream message;
    message << "Utilities::getOptionValue: option \"" << fullName << "\" is not known by the command.";
    sendException(message.str());
  } 
  
  if (!m_values.count(fullName)) {
    std::stringstream message;
    message << "Error: Option \"" << fullName << "\" has not been provided.";
    sendError(message.str());
  }
  return m_values[fullName].as<T>();
}

std::string cond::Utilities::getPasswordValue

(

)

Definition at line 119 of file Utilities.cc.

                                         {
  return getOptionValue<std::string>("pass");  
}

std::string cond::Utilities::getUserValue

(

)

Definition at line 115 of file Utilities.cc.

                                     {
  return getOptionValue<std::string>("user");  
}

std::string cond::Utilities::getValueIfExists ( const std::string &  fullName )

private

Definition at line 158 of file Utilities.cc.

References m_values, AlCaHLTBitMon_QueryRunRegistry::string, and heppy_batch::val.

Referenced by parseCommand().

                                                                  {
  std::string val("");
  if(m_values.count(fullName)){
    val = m_values[fullName].as<std::string>();
  }
  return val;
}

bool cond::Utilities::hasDebug

(

)

Definition at line 150 of file Utilities.cc.

References m_values.

                            {
  return m_values.count("debug");  
}

bool cond::Utilities::hasOptionValue

(

const std::string &

fullName

)

Definition at line 140 of file Utilities.cc.

References runEdmFileComparison::found, m_options, m_values, python.rootplot.argparse::message, and sendException().

                                                           {
  const void* found = m_options.find_nothrow(fullName, false);
  if(!found){
    std::stringstream message;
    message << "Utilities::hasOptionValue: option \"" << fullName << "\" is not known by the command.";
    sendException(message.str());
  }
  return m_values.count(fullName);
}

void cond::Utilities::initializePluginManager

(

)

Definition at line 154 of file Utilities.cc.

                                           {
  // dummy, to avoid to adapt non-CondCore clients
}

void cond::Utilities::parseCommand	(	int	argc,
		char **	argv
	)

Definition at line 97 of file Utilities.cc.

References getValueIfExists(), recoMuon::in, m_options, m_positionalOptions, m_values, AlcaSiPixelAliHarvester0T_cff::options, run(), and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by run().

                                                       {
  boost::program_options::store(boost::program_options::command_line_parser(argc, argv).options(m_options).positional(m_positionalOptions).run(), m_values);
  if(m_options.find_nothrow("configFile",false)){
    std::string configFileName = getValueIfExists("configFile");
    if (! configFileName.empty()){
      std::fstream configFile;
      configFile.open(configFileName.c_str(), std::fstream::in);
      boost::program_options::store(boost::program_options::parse_config_file(configFile,m_options), m_values);
      configFile.close();
    }
  }
  boost::program_options::notify(m_values);
}

int cond::Utilities::run	(	int	argc,
		char **	argv
	)

Definition at line 47 of file Utilities.cc.

References edm::ParameterSet::addParameter(), edmplugin::standard::config(), looper::config, edmplugin::PluginManager::configure(), gather_cfg::cout, edm::ServiceRegistry::createSet(), cppFunctionSkipper::exception, execute(), m_currentToken, m_options, m_values, cmsPerfStripChart::operate(), parseCommand(), AlCaHLTBitMon_QueryRunRegistry::string, and cms::Exception::what().

Referenced by Types.EventID::cppID(), Types.LuminosityBlockID::cppID(), o2olib.O2OTool::execute(), and parseCommand().

                                             {
  edmplugin::PluginManager::Config config;
  edmplugin::PluginManager::configure(edmplugin::standard::config());

  std::vector<edm::ParameterSet> psets;
  edm::ParameterSet pSet;
  pSet.addParameter("@service_type",std::string("SiteLocalConfigService"));
  psets.push_back(pSet);
  edm::ServiceToken servToken(edm::ServiceRegistry::createSet(psets));
  m_currentToken = &servToken;
  edm::ServiceRegistry::Operate operate(servToken);

  int ret = 0;
  try{
    parseCommand( argc, argv );
    if (m_values.count("help")) {
      std::cout << m_options <<std::endl;;
      return 0;
    }
    ret = execute();
  }catch( cond::Exception& err ){
    std::cout << err.what() << std::endl;
    ret = 1;
  }catch( const std::exception& exc ){
    std::cout << exc.what() << std::endl;
    ret = 1;
  }
  m_currentToken = nullptr;
  return ret;
}

void cond::Utilities::sendError ( const std::string &  message )

private

Definition at line 166 of file Utilities.cc.

                                                       {
  throw cond::UtilitiesError(message);
}

void cond::Utilities::sendException ( const std::string &  message )

private

Definition at line 170 of file Utilities.cc.

Referenced by hasOptionValue().

                                                           {
  throw cond::Exception(message);
}

Member Data Documentation

edm::ServiceToken* cond::Utilities::m_currentToken = 0

protected

Definition at line 67 of file Utilities.h.

Referenced by run().

std::string cond::Utilities::m_name

private

Definition at line 71 of file Utilities.h.

boost::program_options::options_description cond::Utilities::m_options

private

Definition at line 73 of file Utilities.h.

Referenced by hasOptionValue(), parseCommand(), run(), and Utilities().

boost::program_options::positional_options_description cond::Utilities::m_positionalOptions

private

Definition at line 74 of file Utilities.h.

Referenced by parseCommand(), and Utilities().

boost::program_options::variables_map cond::Utilities::m_values

private

Definition at line 75 of file Utilities.h.

Referenced by getValueIfExists(), hasDebug(), hasOptionValue(), parseCommand(), and run().