Option Class Reference

Option class defines an abstract type for storing options in an ArgParser container. More...

#include <ArgParser.h>

Public Member Functions
	Option (void)
	Option (int, string, string, bool, bool)
	Option (int, char *, char *, char *, char *, char *)
	Option (int, char *, char *, char *, char *, bool)

Friends
class	ArgParser

Detailed Description

Option class defines an abstract type for storing options in an ArgParser container.

Constructor & Destructor Documentation

Option::Option

(

void

)

Constructs an empty Option object

Option::Option	(	int	id,
		string	name,
		string	value,
		bool	isLong,
		bool	isString
	)

Constructs an Option object with a given name, value (if applicable) and type.

Parameters

id	the identification of the Option object
name	the option name having the format: -x (when short) or –x{x} (when long)
value	the option value if string, or empty if boolean
isLong	true when the option name has long format ( –x{x} ), false when is short ( -x )
isString	true when the option is a string, false when is boolean

Option::Option	(	int	id,
		char *	s,
		char *	l,
		char *	d,
		char *	u,
		char *	v
	)

Constructs an Option string type object.

Parameters

id	the identification of the Option object
s	short name for the optin (-x)
l	long name for the optin (–xxxxx)
d	a word describing the option value
u	a explanation for usage of this option
v	default value for the option

Option::Option	(	int	id,
		char *	s,
		char *	l,
		char *	d,
		char *	u,
		bool	v
	)

Constructs an Option boolean type object.

Parameters

id	the identification of the Option object
s	short name for the option (-x)
l	long name for the option (–xxxxx)
d	a word describing the option value
u	a explanation for usage of this option
v	default value for the option

---

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

• CommonClasses/src/ArgParser.h
• CommonClasses/src/ArgParser.cpp