RAUL  0.8.0
Public Member Functions | List of all members
Raul::Configuration Class Reference

Program configuration (command line options and/or configuration file). More...

#include <Configuration.hpp>

Public Member Functions

 Configuration (const std::string &shortdesc, const std::string &desc)
 
Configurationadd (const std::string &name, char letter, const std::string &desc, const Atom::Type type, const Atom &value)
 Add a configuration option. More...
 
void print_usage (const std::string &program, std::ostream &os)
 
void parse (int argc, char **argv) throw (CommandLineError)
 Parse command line arguments.
 
void print (std::ostream &os, const std::string mime_type="text/plain") const
 
const Raul::Atomoption (const std::string &long_name)
 

Detailed Description

Program configuration (command line options and/or configuration file).

Member Function Documentation

◆ add()

Configuration & Raul::Configuration::add ( const std::string &  name,
char  letter,
const std::string &  desc,
const Atom::Type  type,
const Atom value 
)

Add a configuration option.

Parameters
nameLong name (without leading "--")
letterShort name (without leading "-")
descDescription
typeType (Atom::BOOL for flags)
valueDefault value

References Raul::Atom::type().


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