elm::option::StringOption Class Reference

#include <elm/option/StringOption.h>

Inheritance diagram for elm::option::StringOption:

Public Member Functions
	StringOption (Manager &manager, char short_name, cstring description, cstring arg_description, string value="")
	StringOption (Manager &manager, cstring long_name, cstring description, CString arg_description, string value="")
	StringOption (Manager &manager, char short_name, cstring long_name, cstring description, cstring arg_description, string value="")
Public Member Functions inherited from elm::option::ValueOption< string >
	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 string &val=type_info< string >::null)
	ValueOption (Manager &man, cstring l, cstring desc, cstring adesc, const string &_val=type_info< string >::null)
	ValueOption (Manager &man, char s, cstring l, cstring desc, cstring adesc, const string &_val=type_info< string >::null)
const string &	get (void) const
void	set (const string &value)
	operator const string & (void) const
ValueOption< string > &	operator= (const string &value)
const string &	operator* (void) const
	operator bool (void) const
virtual void	process (String arg)
const string &	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< string >
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 a command line option with a string argument.

Constructor & Destructor Documentation

elm::option::StringOption::StringOption	(	Manager &	manager,
		char	short_name,
		cstring	description,
		cstring	arg_description,
		string	value = ""
	)

Build a string option with a short name.

Parameters

manager	Parent option manager.
short_name	Single-letter name.
description	Option description.
arg_description	Argument description.
value	Option initial value.

elm::option::StringOption::StringOption	(	Manager &	manager,
		cstring	long_name,
		cstring	description,
		CString	arg_description,
		string	value = ""
	)

Build a string option with a long name.

Parameters

manager	Parent option manager.
long_name	Multiple-letter name.
description	Option description.
arg_description	Argument description.
value	Option initial value.

elm::option::StringOption::StringOption	(	Manager &	manager,
		char	short_name,
		cstring	long_name,
		cstring	description,
		cstring	arg_description,
		string	value = ""
	)

Build a string 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	Argument description.
value	Option initial value.

---

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

• include/elm/option/StringOption.h
• src/option_StringOption.cpp