elm::option::AbstractValueOption Class Reference

#include <elm/option/ValueOption.h>

Inheritance diagram for elm::option::AbstractValueOption:

Classes
class	Make

Public Member Functions
	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 void	process (String arg)=0
virtual char	shortName (void)
virtual CString	longName (void)

Protected Member Functions
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)

Additional Inherited Members
Protected Attributes inherited from elm::option::Option
cstring	desc

Detailed Description

Value type independent parts of a value option.

Constructor & Destructor Documentation

elm::option::AbstractValueOption::AbstractValueOption

(

const Make &

make

)

Constructor with an initializer as in the example velow:

Parameters

make	Current initializer.

elm::option::AbstractValueOption::AbstractValueOption

(

Manager &

man

)

Build an abstract value option.

Parameters

man	Owner option manager.

elm::option::AbstractValueOption::AbstractValueOption	(	Manager &	man,
		int	tag,
			...
	)

Constructor.

Parameters

man	Owner manager.
tag	First tag.
...	Tag and arguments.

References elm::option::Option::init().

elm::option::AbstractValueOption::AbstractValueOption	(	Manager &	man,
		int	tag,
		VarArg &	args
	)

Constructor.

Parameters

man	Owner manager.
tag	First tag.
args	Tag and arguments.

References elm::option::Option::init().

Member Function Documentation

cstring elm::option::AbstractValueOption::argDescription ( void  )

virtual

If the option requires an argument, get the description of the argument.

Returns

Argument description.

Implements elm::option::Option.

void elm::option::AbstractValueOption::configure ( Manager &  manager, int  tag, VarArg &  args  )

protectedvirtual

Handle a configuration tag and its value. May be override for extending the Option class but do no forget to call back the original configure() method.

Parameters

manager	Owner manager.
tag	Current tag.
args	List of arguments.

Reimplemented from elm::option::Option.

Reimplemented in elm::option::ValueOption< T >, elm::option::ValueOption< int >, and elm::option::ValueOption< string >.

References elm::option::arg_desc, elm::option::arg_optional, elm::option::arg_required, elm::option::Option::configure(), elm::option::Option::desc, elm::option::description, elm::VarArg::next(), elm::option::optional, and elm::option::require.

Referenced by elm::option::ValueOption< string >::configure().

cstring elm::option::AbstractValueOption::description ( void  )

virtual

Get the description of the option.

Returns

Option description.

Reimplemented from elm::option::Option.

References elm::option::Option::desc.

usage_t elm::option::AbstractValueOption::usage ( void  )

virtual

Get the argument usage type of this function.

Returns

Argument usage type.

Implements elm::option::Option.

---

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

• include/elm/option/ValueOption.h
• src/option_ValueOption.cpp