elm::option::StringList Class Reference

#include <elm/option/StringList.h>

Inheritance diagram for elm::option::StringList:

Public Member Functions
	StringList (Manager &manager, char short_name, cstring description, cstring arg_description)
	StringList (Manager &manager, cstring long_name, cstring description, cstring arg_description)
	StringList (Manager &manager, char short_name, cstring long_name, cstring description, cstring arg_description)
virtual usage_t	usage (void)
virtual cstring	argDescription (void)
virtual void	process (string arg)
	operator bool (void) const
const string &	operator[] (int index) const
int	count (void) const
Public Member Functions inherited from elm::option::StandardOption
	StandardOption (Manager &manager, int tag,...)
	StandardOption (Manager &manager, int tag, VarArg &args)
	StandardOption (Manager &manager, char short_name, cstring description)
	StandardOption (Manager &manager, cstring long_name, cstring description)
	StandardOption (Manager &manager, char short_name, cstring long_name, cstring description)
virtual char	shortName (void)
virtual cstring	longName (void)
virtual cstring	description (void)
Public Member Functions inherited from elm::option::Option
	Option (void)
	Option (const Make &make)
virtual	~Option (void)
void	output (io::Output &out)

Additional Inherited Members
Protected Member Functions inherited from elm::option::StandardOption
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 composed of several strings each one prefixed with the option short or long name.

Constructor & Destructor Documentation

elm::option::StringList::StringList	(	Manager &	manager,
		char	short_name,
		cstring	description,
		cstring	arg_description
	)

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.

elm::option::StringList::StringList	(	Manager &	manager,
		cstring	long_name,
		cstring	description,
		cstring	arg_description
	)

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.

elm::option::StringList::StringList	(	Manager &	manager,
		char	short_name,
		cstring	long_name,
		cstring	description,
		cstring	arg_description
	)

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.

Member Function Documentation

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

virtual

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

Returns

Argument description.

Implements elm::option::Option.

int elm::option::StringList::count

(

void

)

const

Get the count of arguments in this option.

Returns

Argument count.

elm::option::StringList::operator bool

(

void

)

const

Test if some argument has been passed.

Returns

True if there is some value, false else.

const string & elm::option::StringList::operator[]

(

int

index

)

const

Get the indexed argument in the argument list.

Parameters

index

Index of the argument to get.

Returns

Argument matching the index.

Warning

It is an error if index >= count() .

void elm::option::StringList::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.

Implements elm::option::Option.

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

virtual

Get the argument usage type of this function.

Returns

Argument usage type.

Implements elm::option::Option.

References elm::option::arg_required.

---

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

• include/elm/option/StringList.h
• src/option_StringList.cpp