DbmCmdOptions Class Reference

#include <DbmCmdOptions.h>

List of all members.

Public Member Functions
	DbmCmdOptions (const std::string &validOpts="", JobCommand *jcmd=0, const std::list< std::string > *defaultOpts=0)
virtual	~DbmCmdOptions ()
void	GetOptIntList (const std::string &opt, std::list< int > &nos) const
Int_t	GetOptInt (const std::string &opt) const
std::string	GetOptString (const std::string &opt) const
std::string	GetOpts () const
Bool_t	IsValid () const
Bool_t	IsValid (const std::string &opt) const
UInt_t	NumOpts () const
Bool_t	TestOpt (const std::string &opt) const
Bool_t	AddOpt (const std::string &opt, JobCommand &jcmd)
Bool_t	AddOpt (const std::string &opt, const std::string &val)
Bool_t	ProcessCmd (JobCommand &jcmd, const std::list< std::string > *defaultOpts=0)
Public Attributes
Bool_t	fIsValid
std::string	fValidOpts
std::map< std::string, std::string >	fOptsMap

---

Detailed Description

Definition at line 28 of file DbmCmdOptions.h.

---

Constructor & Destructor Documentation

DbmCmdOptions::DbmCmdOptions	(	const std::string &	validOpts = "",
		JobCommand *	jcmd = 0,
		const std::list< std::string > *	defaultOpts = 0
	)

DbmCmdOptions::~DbmCmdOptions

(

)

[virtual]

Definition at line 87 of file DbmCmdOptions.cxx.

References Msg::kVerbose, LEA_DTOR, and MSG.

                              {
//
//
//  Purpose: Destructor
//
//  Arguments: 
//    None.
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o  Destroy DbmCmdOptions.


//  Program Notes:-
//  =============

//  None.

  LEA_DTOR    //Leak Checker

  MSG("Dbm", Msg::kVerbose) << "Destroying DbmCmdOptions" << endl;

}

---

Member Function Documentation

Bool_t DbmCmdOptions::AddOpt	(	const std::string &	opt,
		const std::string &	val
	)

Bool_t DbmCmdOptions::AddOpt	(	const std::string &	opt,
		JobCommand &	jcmd
	)

Referenced by ProcessCmd().

Int_t DbmCmdOptions::GetOptInt

(

const std::string &

opt

)

const

Referenced by DbmModule::Import(), DbmModule::LogEntry(), and DbmModule::Query().

void DbmCmdOptions::GetOptIntList	(	const std::string &	opt,
		std::list< int > &	nos
	)			const

Definition at line 216 of file DbmCmdOptions.cxx.

References GetOptString(), UtilString::IsInt(), and UtilString::StringTok().

Referenced by DbmModule::ExportTables().

                                                                               {
//
//
//  Purpose:  Parse and return a comma separated list.
//
//  Arguments: 
//    opt          in    The option whose value is the comma separated list.
//    nos          in    The initial list
//                 out   Updated to include the list of numbers.
//                       If any error, the list will be cleared to zero 
//                        (including anything that pre-existed the call to this function).
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Treat option value associated with supplied option as a comma separated
//    list of integers and stored them in the supplied list.

  string optValue = this->GetOptString(opt);
  bool fail = (opt == "no");

  if ( ! fail ) {
    std::vector<std::string> ls;
    UtilString::StringTok(ls,optValue,",");
    if ( ls.size() == 0 ) fail = true;
    else {
      std::vector<std::string>::iterator    itr = ls.begin();
      std::vector<std::string>::iterator itrEnd = ls.end();
      while ( itr != itrEnd ) {
        if ( UtilString::IsInt(itr->c_str()) ) nos.push_back(atoi(itr->c_str()));
        else fail = true;
        ++itr;
      }
    }
  }

  if ( fail ) nos.clear();

}

string DbmCmdOptions::GetOpts

(

)

const

Definition at line 318 of file DbmCmdOptions.cxx.

References fOptsMap.

Referenced by DbmLogFile::LogCmd().

                                    {
//
//
//  Purpose:  Return string containing all options.
//
//  Arguments: None.
//
//  Return:  String containing all options.  
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Return string containing all options.

//  Program Notes:-
//  =============

//  None.

  string opts;
  for ( map<string,string>::const_iterator itr = fOptsMap.begin();
        itr != fOptsMap.end();
        ++itr ) {
    opts += (*itr).first + " " + (*itr).second + " ";
  }
  return opts;

}

std::string DbmCmdOptions::GetOptString

(

const std::string &

opt

)

const

Referenced by DbmModule::ExportTables(), GetOptIntList(), DbmModule::GlobaliseSeqNo(), DbmModule::Import(), DbmModule::LogEntry(), and DbmModule::Query().

Bool_t DbmCmdOptions::IsValid

(

const std::string &

opt

)

const

Bool_t DbmCmdOptions::IsValid

(

)

const [inline]

Definition at line 45 of file DbmCmdOptions.h.

References fIsValid.

Referenced by DbmModule::CheckMemory(), DbmModule::ExportTables(), DbmModule::GlobaliseSeqNo(), DbmModule::Import(), DbmModule::LogEntry(), ProcessCmd(), and DbmModule::Query().

{ return fIsValid; }

UInt_t DbmCmdOptions::NumOpts

(

)

const [inline]

Definition at line 47 of file DbmCmdOptions.h.

References fOptsMap.

{ return fOptsMap.size(); }

Bool_t DbmCmdOptions::ProcessCmd	(	JobCommand &	jcmd,
		const std::list< std::string > *	defaultOpts = 0
	)

Definition at line 380 of file DbmCmdOptions.cxx.

References AddOpt(), fIsValid, IsValid(), Msg::kWarning, MSG, option, JobCommand::PopOpt(), and TestOpt().

                                                                        {
//
//
//  Purpose:  Process JobCommand storing all options.
//
//  Arguments: 
//    jcmd         in    JobCommand to be processed.
//                 out   Exhausted JobCommand.
//    defaultOpts  in    Ordered list of default options.
//                       If none supplied, use --Table --File
//
//  Return:    
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Process JobCommand storing all options.
//  
//  o Supply default options to the first  parameters 
//    i.e. options that do not start "-" and are permitted.


//  Program Notes:-
//  =============

//  None.

  // Provide a default for the default!
  std::list<std::string> defDefOPts;
  defDefOPts.push_back("--Table");
  defDefOPts.push_back("--File");

  if ( defaultOpts == 0 ) defaultOpts = &defDefOPts;
  
  std::list<std::string>::const_iterator 
          defOptsItr    = defaultOpts->begin();
  std::list<std::string>::const_iterator 
          defOptsItrEnd = defaultOpts->end();

  const char* opt = jcmd.PopOpt();
  while (opt) {

//  Deal with option.
    if ( opt[0] == '-' ) {

      string option = opt;
      AddOpt(opt, jcmd);
    }
 
// Deal with parameter.
   else {

     // Pick up next default option, if any.
     std::string defaultOpt = "";
     if ( defOptsItr != defOptsItrEnd ) {
       defaultOpt = *defOptsItr;
       ++defOptsItr;
     }

     // Permit default if defined, not yet used and is valid.
      if (  defaultOpt != "" && ! TestOpt(defaultOpt) && IsValid(defaultOpt) 
          ) AddOpt(defaultOpt, opt);

      else {
        MSG("Dbm",Msg::kWarning) << "Unknown parameter " << opt << endl;
        fIsValid = kFALSE;
      }
    }

    opt = jcmd.PopOpt(); 
  }   // loop over options

  return fIsValid;

}

Bool_t DbmCmdOptions::TestOpt

(

const std::string &

opt

)

const

Referenced by DbmModule::ExportTables(), DbmModule::GlobaliseSeqNo(), DbmModule::Import(), DbmModule::LogEntry(), ProcessCmd(), and DbmModule::Query().

---

Member Data Documentation

Bool_t DbmCmdOptions::fIsValid

Definition at line 59 of file DbmCmdOptions.h.

Referenced by IsValid(), and ProcessCmd().

std::map<std::string,std::string> DbmCmdOptions::fOptsMap

Definition at line 61 of file DbmCmdOptions.h.

Referenced by GetOpts(), and NumOpts().

std::string DbmCmdOptions::fValidOpts

Definition at line 60 of file DbmCmdOptions.h.

---

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

• DbmCmdOptions.h
• DbmCmdOptions.cxx

---