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)
AggregateOptions &	add (OptionsPackage *pack)
	Add a pointer to an OptionsPackage that will be used for options.
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.

Member Function Documentation

add()

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.

print()

std::vector< std::string > loos::OptionsFramework::AggregateOptions::print

(

)

const

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

---

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

• src/OptionsFramework.hpp
• src/OptionsFramework.cpp