Represents one program option. More...

Inheritance diagram for ProgramOptions::Option:

Collaboration diagram for ProgramOptions::Option:

Public Member Functions
	Option (const std::string &longName, char shortName, const char description, Value value)

	~Option ()

const std::string &	name () const

char	alias () const

Value *	value () const

const char *	description () const

const char *	argName () const

bool	assignDefault () const

std::size_t	maxColumn () const

DescriptionLevel	descLevel () const

Public Member Functions inherited from ProgramOptions::detail::RefCountable
	RefCountable ()

int	addRef ()

int	release ()

int	refCount () const

Detailed Description

Represents one program option.

An Option consists of a description (long name, short name, description), a (typed) value, and an optional default value.

Note: When printing an option, occurrences of D, I and A in its description are replaced with the option's default value, implicit value and the argument name, respectively.

Constructor & Destructor Documentation

ProgramOptions::Option::Option	(	const std::string &	longName,
		char	shortName,
		const char *	description,
		Value *	value
	)

Parameters

longName	name (and unique key) of the option
shortName	possible alias name
description	description of the option, used for printing help
value	value object to be associated with this option