elm::option Namespace Reference

Classes
class	AbstractValueOption
class	ActionOption
class	BoolOption
class	EnumOption
class	IntOption
class	ListOption
class	Manager
class	Option
class	OptionException
class	StandardOption
class	StringList
class	StringOption
class	SwitchOption
class	Value
class	ValueOption

Typedefs
typedef enum elm::option::usage_t	usage_t
typedef SwitchOption	Switch

Enumerations
enum	usage_t { arg_none, arg_optional, arg_required }

Functions
io::Output &	operator<< (io::Output &out, Option &opt)
template<class T >
T	read (string arg)
template<>
string	read< string > (string arg)
template<>
cstring	read< cstring > (string arg)

Variables
const int	end = 0
const int	program = 1
const int	version = 2
const int	author = 3
const int	copyright = 4
const int	description = 5
const int	help = 5
const int	free_arg = 6
const int	cmd = 7
const int	short_cmd = 8
const int	long_cmd = 9
const int	def = 10
const int	require = 12
const int	optional = 13
const int	arg_desc = 14

Typedef Documentation

typedef SwitchOption elm::option::Switch

typedef enum elm::option::usage_t elm::option::usage_t

Enumeration Type Documentation

enum elm::option::usage_t

Defines the kind of arguments used by an option.

Enumerator
arg_none	This option does not require an argument.
arg_optional	Accept but does not require an argument.
arg_required	Require an argument.

Function Documentation

io::Output& elm::option::operator<<	(	io::Output &	out,
		Option &	opt
	)

References elm::io::out, and elm::option::Option::output().

template<class T >

T elm::option::read

(

string

arg

)

template<>

cstring elm::option::read< cstring >

(

string

arg

)

template<>

string elm::option::read< string >

(

string

arg

)

Variable Documentation

const int elm::option::arg_desc = 14

Referenced by elm::option::AbstractValueOption::configure(), elm::option::Manager::configure(), elm::option::ValueOption< string >::ValueOption(), and elm::option::ValueOption< T >::ValueOption().

const int elm::option::author = 3

Referenced by elm::option::Manager::configure(), and elm::option::Manager::displayHelp().

const int elm::option::cmd = 7

Referenced by elm::option::Option::configure(), and elm::option::Option::Option().

const int elm::option::copyright = 4

Referenced by elm::option::Manager::configure(), and elm::option::Manager::displayHelp().

const int elm::option::def = 10

Referenced by elm::option::SwitchOption::configure(), elm::option::ValueOption< string >::configure(), elm::option::ValueOption< string >::ValueOption(), and elm::option::ValueOption< T >::ValueOption().

const int elm::option::description = 5

Referenced by elm::option::StandardOption::configure(), elm::option::SwitchOption::configure(), elm::option::AbstractValueOption::configure(), elm::option::Option::configure(), elm::option::Manager::configure(), elm::option::StandardOption::StandardOption(), elm::option::ValueOption< string >::ValueOption(), and elm::option::ValueOption< T >::ValueOption().

const int elm::option::end = 0

Referenced by elm::option::Option::init(), elm::option::Manager::Manager(), elm::option::StandardOption::StandardOption(), elm::option::ValueOption< string >::ValueOption(), and elm::option::ValueOption< T >::ValueOption().

const int elm::option::free_arg = 6

Referenced by elm::option::Manager::configure().

const int elm::option::help = 5

const int elm::option::long_cmd = 9

Referenced by elm::option::Option::configure(), elm::option::StandardOption::StandardOption(), and elm::option::ValueOption< T >::ValueOption().

const int elm::option::optional = 13

Referenced by elm::option::AbstractValueOption::configure().

const int elm::option::program = 1

Referenced by elm::option::Manager::configure().

const int elm::option::require = 12

Referenced by elm::option::AbstractValueOption::configure().

const int elm::option::short_cmd = 8

Referenced by elm::option::Option::configure(), elm::option::StandardOption::StandardOption(), elm::option::ValueOption< string >::ValueOption(), and elm::option::ValueOption< T >::ValueOption().

const int elm::option::version = 2

Referenced by elm::option::Manager::configure(), and elm::option::Manager::displayHelp().