---

cond::CommonOptions Class Reference

#include <CondCore/Utilities/interface/CommonOptions.h>

List of all members.

Public Member Functions
void	addAuthentication (const bool withEnvironmentAuth=true)
void	addBlobStreamer ()
void	addConnect ()
void	addDictionary ()
void	addFileConfig ()
void	addLogDB ()
	CommonOptions (const std::string &commandname, const std::string &positionparameter)
	CommonOptions (const std::string &commandname)
boost::program_options::options_description &	description ()
boost::program_options::options_description &	visibles ()
	~CommonOptions ()
Private Attributes
boost::program_options::options_description *	m_description
std::string	m_name
boost::program_options::options_description *	m_visible

---

Detailed Description

Definition at line 7 of file CommonOptions.h.

---

Constructor & Destructor Documentation

cond::CommonOptions::CommonOptions

(

const std::string &

commandname

)

[explicit]

Definition at line 3 of file CommonOptions.cc.

References m_description, and m_visible.

                                                             :m_name(commandname),m_description(new boost::program_options::options_description("options")),m_visible(new boost::program_options::options_description(std::string("Usage: ")+m_name+std::string(" [options] \n")) ){
  m_visible->add_options()
    ("debug","switch on debug mode")
    ("help,h", "help message")
    ;
  m_description->add(*m_visible);
}

cond::CommonOptions::CommonOptions	(	const std::string &	commandname,
		const std::string &	positionparameter
	)

Definition at line 11 of file CommonOptions.cc.

References m_description, and m_visible.

                                                                       :m_name(commandname),m_description(new boost::program_options::options_description("options")),m_visible(new boost::program_options::options_description(std::string("Usage: ")+m_name+std::string(" [options] ")+positionparameter+std::string(" \n")) ){
  m_visible->add_options()
    ("debug","switch on debug mode")
    ("help,h", "help message")
    ;
  m_description->add(*m_visible);
}

cond::CommonOptions::~CommonOptions

(

)

Definition at line 20 of file CommonOptions.cc.

References m_description, and m_visible.

                                 {
  delete m_visible;
  m_visible=0;
  delete m_description;
  m_description=0;
}

---

Member Function Documentation

void cond::CommonOptions::addAuthentication

(

const bool

withEnvironmentAuth = true

)

Definition at line 27 of file CommonOptions.cc.

References m_description, and m_visible.

                                                                  {
  m_visible->add_options()
    ("authPath,P",boost::program_options::value<std::string>(),"path to authentication xml(default .)");
  if (withEnvironmentAuth){
    m_visible->add_options()
      ("user,u",boost::program_options::value<std::string>(),"user name (default \"\")")
      ("pass,p",boost::program_options::value<std::string>(),"password (default \"\")");
  }
  m_description->add(*m_visible);
}

void cond::CommonOptions::addBlobStreamer

(

)

Definition at line 63 of file CommonOptions.cc.

References m_description, and m_visible.

                                  {
  m_visible->add_options()
    ("blobStreamer,B",boost::program_options::value<std::string>(),"BlobStreamerName(default to COND/Services/TBufferBlobStreamingService)");
  m_description->add(*m_visible);
}

void cond::CommonOptions::addConnect

(

)

Definition at line 39 of file CommonOptions.cc.

References m_description, and m_visible.

                             {
  m_visible->add_options()
    ("connect,c",boost::program_options::value<std::string>(),"connection string(required)");
  m_description->add(*m_visible);
}

void cond::CommonOptions::addDictionary

(

)

Definition at line 51 of file CommonOptions.cc.

References m_description, and m_visible.

                                {
  m_visible->add_options()
    ("dictionary,D",boost::program_options::value<std::string>(),"data dictionary(required if no plugin available)");
  m_description->add(*m_visible);
}

void cond::CommonOptions::addFileConfig

(

)

Definition at line 57 of file CommonOptions.cc.

References m_description, and m_visible.

                                {
  m_visible->add_options()
    ("configFile,f",boost::program_options::value<std::string>(),"configuration file(optional)");
  m_description->add(*m_visible);
}

void cond::CommonOptions::addLogDB

(

)

Definition at line 45 of file CommonOptions.cc.

References m_description, and m_visible.

                           {
   m_visible->add_options()
     ("logDB,l",boost::program_options::value<std::string>(),"logDB(optional");
   m_description->add(*m_visible);
}

boost::program_options::options_description & cond::CommonOptions::description

(

)

Definition at line 70 of file CommonOptions.cc.

References m_description.

                              {
  return *m_description;
}

boost::program_options::options_description & cond::CommonOptions::visibles

(

)

Definition at line 75 of file CommonOptions.cc.

References m_visible.

                           {
  return *m_visible;
}

---

Member Data Documentation

boost::program_options::options_description* cond::CommonOptions::m_description [private]

Definition at line 25 of file CommonOptions.h.

Referenced by addAuthentication(), addBlobStreamer(), addConnect(), addDictionary(), addFileConfig(), addLogDB(), CommonOptions(), description(), and ~CommonOptions().

std::string cond::CommonOptions::m_name [private]

Definition at line 24 of file CommonOptions.h.

boost::program_options::options_description* cond::CommonOptions::m_visible [private]

Definition at line 26 of file CommonOptions.h.

Referenced by addAuthentication(), addBlobStreamer(), addConnect(), addDictionary(), addFileConfig(), addLogDB(), CommonOptions(), visibles(), and ~CommonOptions().

---

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

• CondCore/Utilities/interface/CommonOptions.h
• CondCore/Utilities/src/CommonOptions.cc

---