AbstractValueOption Class Reference

#include <elm/option/ValueOption.h>

Inheritance diagram for AbstractValueOption:

Classes
class	Make

Public Member Functions
	AbstractValueOption (const Make &make)
	AbstractValueOption (Manager &man)
cstring	description (void) override
usage_t	usage (void) override
cstring	argDescription (void) override
Public Member Functions inherited from Option
	Option ()
	Option (const Make &make)
virtual	~Option ()
virtual void	process (String arg)=0

Additional Inherited Members
Protected Attributes inherited from Option
cstring	desc

Detailed Description

Value type independent parts of a value option.

Constructor & Destructor Documentation

AbstractValueOption() [1/2]

AbstractValueOption

(

const Make &

make

)

Constructor with an initializer as in the example velow:

Parameters

make	Current initializer.

AbstractValueOption() [2/2]

AbstractValueOption

(

Manager &

man

)

Build an abstract value option.

Parameters

man	Owner option manager.

Member Function Documentation

argDescription()

cstring argDescription ( void  )

overridevirtual

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

Returns

Argument description.

Implements Option.

description()

cstring description ( void  )

overridevirtual

Display the name of the option to the given output stream.

Parameters

out	Stream to output to. Get the single-character short name of the option.

Returns

Single character or '\0' if there is no short name.

Deprecated:

Get the multi-character long name of the option.

Returns

Multi-character or an empty string if there is no long name.

Deprecated:

Get the description of the option.

Returns

Option description.

Reimplemented from Option.

References Option::desc.

usage()

usage_t usage ( void  )

overridevirtual

Get the argument usage type of this function.

Returns

Argument usage type.

Implements Option.

---

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

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