LOOS  v2.3.2
loos::OptionsFramework::AggregateOptions Class Reference

Combines a set of OptionsPackages. More...

#include <OptionsFramework.hpp>

Public Member Functions

 AggregateOptions ()
 Name is taken from argv[0] when AggregateOptions::parse() is called.
 
 AggregateOptions (const std::string &name)
 Explicitly set the program name (for help message and printing)
 
AggregateOptionsadd (OptionsPackage *pack)
 Add a pointer to an OptionsPackage that will be used for options. More...
 
bool parse (int argc, char *argv[])
 Parses a command line, returning true if parsing was ok.
 
std::vector< std::string > print () const
 
void showHelp ()
 Displays the help for this tool.
 

Detailed Description

Combines a set of OptionsPackages.

Definition at line 722 of file OptionsFramework.hpp.

Member Function Documentation

AggregateOptions & loos::OptionsFramework::AggregateOptions::add ( OptionsPackage pack)

Add a pointer to an OptionsPackage that will be used for options.

Takes a pointer to an OptionsPackage, and appends this to the list of options that will be used to build up the command-line. Returns a reference to itself so that add() calls can be chained.

Definition at line 586 of file OptionsFramework.cpp.

std::vector< std::string > loos::OptionsFramework::AggregateOptions::print ( ) const

Returns a string representing the option values in all contained OptionPackage objects

Definition at line 667 of file OptionsFramework.cpp.


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