elm::option::IntOption Class Reference

#include <elm/option/IntOption.h>

Inheritance diagram for elm::option::IntOption:

Public Member Functions
	IntOption (Manager &manager, char short_name, CString description, CString arg_description, int value=0)
	IntOption (Manager &manager, CString long_name, CString description, CString arg_description, int value=0)
	IntOption (Manager &manager, char short_name, CString long_name, CString description, CString arg_description, int value=0)
virtual void	process (String arg)
Public Member Functions inherited from elm::option::ValueOption< int >
	ValueOption (void)
	ValueOption (const Make &make)
	ValueOption (Manager &man, int tag...)
	ValueOption (Manager &man, int tag, VarArg &args)
	ValueOption (Manager &man, char s, cstring desc, cstring adesc, const int &val=type_info< int >::null)
	ValueOption (Manager &man, cstring l, cstring desc, cstring adesc, const int &_val=type_info< int >::null)
	ValueOption (Manager &man, char s, cstring l, cstring desc, cstring adesc, const int &_val=type_info< int >::null)
const int &	get (void) const
void	set (const int &value)
	operator const int & (void) const
ValueOption< int > &	operator= (const int &value)
const int &	operator* (void) const
	operator bool (void) const
const int &	value (void) const
Public Member Functions inherited from elm::option::AbstractValueOption
	AbstractValueOption (const Make &make)
	AbstractValueOption (Manager &man)
	AbstractValueOption (Manager &man, int tag,...)
	AbstractValueOption (Manager &man, int tag, VarArg &args)
virtual cstring	description (void)
virtual usage_t	usage (void)
virtual cstring	argDescription (void)
Public Member Functions inherited from elm::option::Option
	Option (void)
	Option (const Make &make)
virtual	~Option (void)
void	output (io::Output &out)
virtual char	shortName (void)
virtual CString	longName (void)

Additional Inherited Members
Protected Member Functions inherited from elm::option::ValueOption< int >
virtual void	configure (Manager &manager, int tag, VarArg &args)
Protected Member Functions inherited from elm::option::Option
void	init (Manager &manager, int tag,...)
void	init (Manager &manager, int tag, VarArg &args)
Protected Attributes inherited from elm::option::Option
cstring	desc

Detailed Description

This class is used for getting integer option usually marked by simple flag.

Constructor & Destructor Documentation

elm::option::IntOption::IntOption	(	Manager &	manager,
		char	short_name,
		CString	description,
		CString	arg_description,
		int	value = 0
	)

Build an integer option with a short name.

Parameters

manager	Parent option manager.
short_name	Single-letter name.
description	Option description.
arg_description	Help text describing the nature of the argument.
value	Option initial value.

elm::option::IntOption::IntOption	(	Manager &	manager,
		CString	long_name,
		CString	description,
		CString	arg_description,
		int	value = 0
	)

Build an integer option with a long name.

Parameters

manager	Parent option manager.
long_name	Multiple-letter name.
description	Option description.
arg_description	Help text describing the nature of the argument.
value	Option initial value.

elm::option::IntOption::IntOption	(	Manager &	manager,
		char	short_name,
		CString	long_name,
		CString	description,
		CString	arg_description,
		int	value = 0
	)

Build an integer option with a short name and a long name.

Parameters

manager	Parent option manager.
short_name	Single-letter name.
long_name	Multiple-letter name.
description	Option description.
arg_description	Help text describing the nature of the argument.
value	Option initial value.

Member Function Documentation

void elm::option::IntOption::process ( String  arg )

virtual

This method is called by the option manager when the option is encountered.

Parameters

arg	If the option requires an argument, the value of the argument.

Reimplemented from elm::option::ValueOption< int >.

References elm::io::in, elm::io::Input::scanLong(), and elm::option::ValueOption< int >::set().

---

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

• include/elm/option/IntOption.h
• src/option_IntOption.cpp