Changeset 10707 for trunk/FACT++/src/Configuration.cc

Timestamp:

05/13/11 15:48:57 (14 years ago)

Author:

tbretz

Message:

Use the functionality of boost program_options better; implemented po_bool() as a special po_switch() case; added some comments.

File:

• trunk/FACT++/src/Configuration.cc (modified) (2 diffs)

trunk/FACT++/src/Configuration.cc

@@ -92 +92 @@
     po::options_description config("Section");
     config.add_options()
-        ("option1",    po_string(),              "This is option1")
-        ("option2",    po_int(22),               "This is option2")
-        ("option3,o",  po_double()->required(),  "This option is mandatory")
-        ("option4",    po_int(&opt),             "This is option 4")
-        ("option5",    po_strings(),             "A list of strings")
-        ("option6",    po_strings(),             "A list of strings")
-        ("option7",    po_strings(),             "A list of strings")
+        ("option1",    var<string>(),                        "This is option1")
+        ("option2",    var<int>(22),                         "This is option2")
+        ("option3,o",  var<double>->required(),              "This option is mandatory")
+        ("option4",    var<int>(&opt),                       "This is option 4")
+        ("option5",    vars<string>(),                       "A list of strings")
+        ("option6",    vars<string>(),                       "A list of strings")
+        ("option7",    vars<string>,                         "A list of strings")
+        ("option8",    var<string>()->implicit_value("val"), "Just a string")
+        ("option9",    var<string>()->default_value("def"),  "Just a string")
+        ("optionA",    var<string>("def"),                   "Just a string")
+        ("bool",       po_bool(),                            "A special switch")
         ;
 
@@ -119 +123 @@
 Abbreviations po_ints(), po_doubles() and po_strings() are available.
 
-In addition to options introduced by a minus, so calles positional options
-can be given on the command line. To describe these options use
+There are several ways to define the behaviour of the options. In the
+example above Parse will throw an exception if the "--option3" or "-o"
+option is not given. "option9" will evaluate to "def" if it is not
+given on the command line. The syntax of "optionA" is just an
+abbreviation. "option8" will evaluate to "val" if just "--option5" but
+no argument is given. Note, that these modifiers can be concatenated.
+
+A special type po_bool() is provided which is an abbreviation of
+var<bool>()->implicit_value(true)->default_value(false). In
+contradiction to po_switch() this allows to set a true and
+false value in the setup file.
+
+In addition to options introduced by a minus or double minus, so called
+positional options can be given on the command line. To describe these
+options use
 
 \code