src/CommandLineParser.h

   1 //! \file CommandLineParser.h
   2
   3 #ifndef _COMMANDLINEPARSER_H
   4 #define _COMMANDLINEPARSER_H
   5
   6 #include <string>
   7
   8 //! Abstract base class for parsing command line arguments
   9 class CommandLineParser
  10 {
  11 public:
  12     virtual ~CommandLineParser() {};
  13
  14     /*! Parses command line args and stores results internally.
  15      * May throw an exception in case of error
  16      * \param argc number of arguments
  17      * \param argv arguments as passed to main
  18      */
  19     virtual void parse(int argc, char** argv) = 0;
  20
  21     /*! Query whether a specific flag was set on command line.
  22      * \param flag Command line switch without leading dash
  23      * \return whether specified flag was set on command line
  24      */
  25     virtual bool hasSet(std::string flag) = 0;
  26
  27     /*! get argument of switch (if available)
  28      * \param option command line switch without leading dash
  29      * \returns value as string
  30     */
  31     virtual std::string getValue(std::string option) = 0;
  32
  33     /*! Print usage help
  34      */
  35     virtual void printHelp() = 0;
  36 };
  37
  38 #endif // _COMMANDLINEPARSER_H