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 = nullptr

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 24 of file Utilities.h.

Constructor & Destructor Documentation

Utilities()

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

Definition at line 72 of file Utilities.cc.

    : 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);
  }
}

References m_options, and m_positionalOptions.

~Utilities()

cond::Utilities::~Utilities ( )

virtual

Definition at line 85 of file Utilities.cc.

{}

Member Function Documentation

addAuthenticationOptions()

void cond::Utilities::addAuthenticationOptions

(

)

Definition at line 127 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");
}

addConfigFileOption()

void cond::Utilities::addConfigFileOption

(

)

Definition at line 133 of file Utilities.cc.

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

addConnectOption()

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

Definition at line 121 of file Utilities.cc.

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

addOption() [1/2]

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());
  }

References newFWLiteAna::fullName, and m_options.

addOption() [2/2]

template<>

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

inline

Definition at line 92 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());
  }

References newFWLiteAna::fullName, and m_options.

execute()

int cond::Utilities::execute ( )

virtual

Definition at line 87 of file Utilities.cc.

{ return 0; }

getAuthenticationPathValue()

std::string cond::Utilities::getAuthenticationPathValue

(

)

Definition at line 153 of file Utilities.cc.

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

getConfigFileValue()

std::string cond::Utilities::getConfigFileValue

(

)

Definition at line 165 of file Utilities.cc.

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

getConnectValue()

std::string cond::Utilities::getConnectValue

(

)

Definition at line 159 of file Utilities.cc.

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

getDictionaryValue()

std::string cond::Utilities::getDictionaryValue

(

)

Definition at line 163 of file Utilities.cc.

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

getLogDBValue()

std::string cond::Utilities::getLogDBValue

(

)

Definition at line 161 of file Utilities.cc.

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

getOptionValue()

template<typename T >

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

inline

Definition at line 105 of file Utilities.h.

                                                                {
  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>();
}

References newFWLiteAna::found, newFWLiteAna::fullName, m_options, m_values, sendError(), and sendException().

getPasswordValue()

std::string cond::Utilities::getPasswordValue

(

)

Definition at line 157 of file Utilities.cc.

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

getUserValue()

std::string cond::Utilities::getUserValue

(

)

Definition at line 155 of file Utilities.cc.

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

getValueIfExists()

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

private

Definition at line 183 of file Utilities.cc.

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

References newFWLiteAna::fullName, AlCaHLTBitMon_QueryRunRegistry::string, and heppy_batch::val.

hasDebug()

bool cond::Utilities::hasDebug

(

)

Definition at line 177 of file Utilities.cc.

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

hasOptionValue()

bool cond::Utilities::hasOptionValue

(

const std::string &

fullName

)

Definition at line 167 of file Utilities.cc.

                                                            {
  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);
}

References newFWLiteAna::found, and newFWLiteAna::fullName.

initializePluginManager()

void cond::Utilities::initializePluginManager

(

)

Definition at line 179 of file Utilities.cc.

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

parseCommand()

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

Definition at line 137 of file Utilities.cc.

                                                      {
  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);
}

References dir2webdir::argc, cmsBatch::argv, recoMuon::in, AlcaSiPixelAliHarvester0T_cff::options, writedatasetfile::run, and AlCaHLTBitMon_QueryRunRegistry::string.

run()

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

Definition at line 89 of file Utilities.cc.

                                            {
  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;
}

References edm::ParameterSet::addParameter(), dir2webdir::argc, cmsBatch::argv, edmplugin::standard::config(), submitPVResolutionJobs::config, edmplugin::PluginManager::configure(), gather_cfg::cout, edm::ServiceRegistry::createSet(), submitPVResolutionJobs::err, cppFunctionSkipper::exception, runTheMatrix::ret, and AlCaHLTBitMon_QueryRunRegistry::string.

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

sendError()

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

private

Definition at line 191 of file Utilities.cc.

{ throw cond::UtilitiesError(message); }

Referenced by getOptionValue().

sendException()

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

private

Definition at line 193 of file Utilities.cc.

{ throw cond::Exception(message); }

Referenced by getOptionValue().

Member Data Documentation

m_currentToken

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

protected

Definition at line 68 of file Utilities.h.

m_name

std::string cond::Utilities::m_name

private

Definition at line 71 of file Utilities.h.

m_options

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

private

Definition at line 73 of file Utilities.h.

Referenced by addOption(), getOptionValue(), and Utilities().

m_positionalOptions

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

private

Definition at line 74 of file Utilities.h.

Referenced by Utilities().

m_values

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

private

Definition at line 75 of file Utilities.h.

Referenced by getOptionValue().