ProgramOptions::OptionGroup Class Reference

A list of options logically grouped under a caption. More...

#include <program_options.h>

Collaboration diagram for ProgramOptions::OptionGroup:

Public Types
typedef std::vector< SharedOptPtr >	OptionList
typedef OptionList::const_iterator	option_iterator

Public Member Functions
	OptionGroup (const std::string &caption="", DescriptionLevel descLevel=desc_level_default)
	~OptionGroup ()
const std::string &	caption () const
	Returns the caption of this group. More...
std::size_t	size () const
bool	empty () const
option_iterator	begin () const
option_iterator	end () const
DescriptionLevel	descLevel () const
OptionInitHelper	addOptions ()
	Returns an object that can be used to add options. More...
void	addOption (std::auto_ptr< Option > option)
	Adds option to this group. More...
void	setDescriptionLevel (DescriptionLevel level)
void	format (OptionOutput &out, size_t maxW, DescriptionLevel level=desc_level_default) const
	Creates a formated description of all options with level() <= level in this group. More...
std::size_t	maxColumn (DescriptionLevel level) const

Friends
class	OptionContext

Detailed Description

A list of options logically grouped under a caption.

The class provides a logical grouping of options that is mainly useful for printing help.

Member Typedef Documentation

typedef OptionList::const_iterator ProgramOptions::OptionGroup::option_iterator

typedef std::vector<SharedOptPtr> ProgramOptions::OptionGroup::OptionList

Constructor & Destructor Documentation

ProgramOptions::OptionGroup::OptionGroup	(	const std::string &	caption = "",
		DescriptionLevel	descLevel = desc_level_default
	)

Creates a new group of options under the given caption.

ProgramOptions::OptionGroup::~OptionGroup

(

)

Member Function Documentation

void ProgramOptions::OptionGroup::addOption

(

std::auto_ptr< Option >

option

)

Adds option to this group.

OptionInitHelper ProgramOptions::OptionGroup::addOptions

(

)

Returns an object that can be used to add options.

usage

OptionGroup g("Some Options");
ValueMap m;
g.addOptions()
  ("opt1", store<int>(m), "some int value")   // <- no semicolon
  ("opt2", store<double>(m))                  // <- no semicolon
  ("opt3", store<char>(m))                    // <- no semicolon
;                                            // <- note the semicolon!

option_iterator ProgramOptions::OptionGroup::begin ( ) const

inline

const std::string& ProgramOptions::OptionGroup::caption ( ) const

inline

Returns the caption of this group.

DescriptionLevel ProgramOptions::OptionGroup::descLevel ( ) const

inline

bool ProgramOptions::OptionGroup::empty ( ) const

inline

option_iterator ProgramOptions::OptionGroup::end ( ) const

inline

void ProgramOptions::OptionGroup::format	(	OptionOutput &	out,
		size_t	maxW,
		DescriptionLevel	level = desc_level_default
	)		const

Creates a formated description of all options with level() <= level in this group.

Here is the call graph for this function:

std::size_t ProgramOptions::OptionGroup::maxColumn

(

DescriptionLevel

level

)

const

Here is the call graph for this function:

void ProgramOptions::OptionGroup::setDescriptionLevel ( DescriptionLevel  level )

inline

std::size_t ProgramOptions::OptionGroup::size ( ) const

inline

Friends And Related Function Documentation

friend class OptionContext

friend

---

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

• /Users/danielbaeck/Dropbox/Uni Klagenfurt/Diplomarbeit/gringo44/libprogram_opts/program_opts/program_options.h
• /Users/danielbaeck/Dropbox/Uni Klagenfurt/Diplomarbeit/gringo44/libprogram_opts/src/program_options.cpp