Detailed Description

specialization of argument for string options or parameters

Definition at line 267 of file cmdline.h.

Inheritance diagram for stxxl::cmdline_parser::argument_string:

Collaboration diagram for stxxl::cmdline_parser::argument_string:

Public Member Functions
	argument_string (char key, const std::string &longkey, const std::string &keytype, const std::string &desc, bool required, std::string &dest)
	contructor filling most attributes More...

virtual void	print_value (std::ostream &os) const
	format value to ostream More...

virtual bool	process (int &argc, const char const &argv)
	"process" string argument just by storing it. More...

virtual const char *	type_name () const
	return formatted type name to user More...

Public Member Functions inherited from stxxl::cmdline_parser::argument
	argument (char key, const std::string &longkey, const std::string &keytype, const std::string &desc, bool required)
	contructor filling most attributes More...

virtual	~argument ()
	empty virtual destructor More...

std::string	option_text () const
	return '-s, –longkey [keytype]' More...

std::string	param_text () const
	return 'longkey [keytype]' More...

Public Attributes
std::string &	m_dest

Public Attributes inherited from stxxl::cmdline_parser::argument
std::string	m_desc
	longer description, which will be wrapped More...

bool	m_found
	found during processing of command line More...

char	m_key
	single letter short option, or 0 is none More...

std::string	m_keytype
	option type description, e.g. "<#>" to indicate numbers More...

std::string	m_longkey
	long option key or name for parameters More...

bool	m_repeated
	repeated argument, i.e. std::vector<std::string> More...

bool	m_required
	required, process() fails if the option/parameter is not found. More...

Constructor & Destructor Documentation

stxxl::cmdline_parser::argument_string::argument_string	(	char	key,
		const std::string &	longkey,
		const std::string &	keytype,
		const std::string &	desc,
		bool	required,
		std::string &	dest
	)

inline

contructor filling most attributes

Definition at line 272 of file cmdline.h.

virtual void stxxl::cmdline_parser::argument_string::print_value ( std::ostream & os ) const

inlinevirtual

format value to ostream

Definition at line 290 of file cmdline.h.

virtual bool stxxl::cmdline_parser::argument_string::process	(	int &	argc,
		const char const &	argv
	)

inlinevirtual

"process" string argument just by storing it.

Definition at line 282 of file cmdline.h.

virtual const char* stxxl::cmdline_parser::argument_string::type_name ( ) const

inlinevirtual

return formatted type name to user

Definition at line 278 of file cmdline.h.

std::string& stxxl::cmdline_parser::argument_string::m_dest

Definition at line 269 of file cmdline.h.

The documentation for this struct was generated from the following file: