Mimotera::AnyOption Class Reference

Command line option parser. More...

#include <mimotera++/MimoteraAnyOption.hh>

List of all members.

Public Member Functions

AnyOption ()

AnyOption (int maxoptions)

AnyOption (int maxoptions, int maxcharoptions)

~AnyOption ()

void setCommandPrefixChar (char _prefix)

void setCommandLongPrefix (char *_prefix)

void setFileCommentChar (char _comment)

void setFileDelimiterChar (char _delimiter)

void useCommandArgs (int _argc, char **_argv)

void useFiileName (const char *_filename)

void noPOSIX ()

void setVerbose ()

void setOption (const char *opt_string)

void setOption (char opt_char)

void setOption (const char *opt_string, char opt_char)

void setFlag (const char *opt_string)

void setFlag (char opt_char)

void setFlag (const char *opt_string, char opt_char)

void setCommandOption (const char *opt_string)

void setCommandOption (char opt_char)

void setCommandOption (const char *opt_string, char opt_char)

void setCommandFlag (const char *opt_string)

void setCommandFlag (char opt_char)

void setCommandFlag (const char *opt_string, char opt_char)

void setFileOption (const char *opt_string)

void setFileOption (char opt_char)

void setFileOption (const char *opt_string, char opt_char)

void setFileFlag (const char *opt_string)

void setFileFlag (char opt_char)

void setFileFlag (const char *opt_string, char opt_char)

void processOptions ()

void processCommandArgs ()

void processCommandArgs (int max_args)

bool processFile ()

void processCommandArgs (int _argc, char **_argv)

void processCommandArgs (int _argc, char **_argv, int max_args)

bool processFile (const char *_filename)

char * getValue (const char *_option)

bool getFlag (const char *_option)

char * getValue (char _optchar)

bool getFlag (char _optchar)

void printUsage ()

void printAutoUsage ()

void addUsage (const char *line)

void printHelp ()

void autoUsagePrint (bool flag)

int getArgc ()

char * getArgv (int index)

bool hasOptions ()

Detailed Description

Command line option parser.

This class was not originally developed for the Mimotera++ API and was written by kishan at hackorama dot com and sligtly adjusted to fullfil our requirements.

It is used to parse the command line options and (not for Mimotera++) to read and parse configuration file.

The use of this class is quite intuitive and having a look at the examples will make things even clearer.

Author:: kishan at hackorama dot com
Antonio Bulgheroni <antonio.bulgheroni@gmail.com>

Examples:: examples/convert2ASCII.cxx, examples/convert2ROOT.cxx, and examples/createDummyData.cxx.

Definition at line 73 of file MimoteraAnyOption.hh.

Constructor & Destructor Documentation

AnyOption::AnyOption ( )

Definition at line 92 of file MimoteraAnyOption.cc.

AnyOption::AnyOption ( int maxoptions )

Definition at line 96 of file MimoteraAnyOption.cc.

AnyOption::AnyOption	(	int	maxoptions,
		int	maxcharoptions
	)

Definition at line 100 of file MimoteraAnyOption.cc.

AnyOption::~AnyOption ( )

Definition at line 104 of file MimoteraAnyOption.cc.

Member Function Documentation

void AnyOption::addUsage ( const char * line )

Definition at line 1103 of file MimoteraAnyOption.cc.

void AnyOption::autoUsagePrint ( bool flag )

Definition at line 343 of file MimoteraAnyOption.cc.

int AnyOption::getArgc ( )

Definition at line 855 of file MimoteraAnyOption.cc.

char * AnyOption::getArgv ( int index )

Definition at line 861 of file MimoteraAnyOption.cc.

bool AnyOption::getFlag ( char _optchar )

Definition at line 767 of file MimoteraAnyOption.cc.

bool AnyOption::getFlag ( const char * _option )

Definition at line 743 of file MimoteraAnyOption.cc.

char * AnyOption::getValue ( char _optchar )

Definition at line 755 of file MimoteraAnyOption.cc.

char * AnyOption::getValue ( const char * _option )

Definition at line 730 of file MimoteraAnyOption.cc.

bool AnyOption::hasOptions ( )

Definition at line 339 of file MimoteraAnyOption.cc.

void AnyOption::noPOSIX ( )

Definition at line 306 of file MimoteraAnyOption.cc.

void AnyOption::printAutoUsage ( )

Definition at line 1083 of file MimoteraAnyOption.cc.

References printUsage().

Referenced by processCommandArgs().

Here is the call graph for this function:

void Mimotera::AnyOption::printHelp ( )

void AnyOption::printUsage ( )

Definition at line 1089 of file MimoteraAnyOption.cc.

Referenced by printAutoUsage().

void AnyOption::processCommandArgs	(	int	_argc,
		char **	_argv,
		int	max_args
	)

Definition at line 546 of file MimoteraAnyOption.cc.

References processCommandArgs().

Here is the call graph for this function:

void AnyOption::processCommandArgs	(	int	_argc,
		char **	_argv
	)

Definition at line 553 of file MimoteraAnyOption.cc.

References processCommandArgs(), and useCommandArgs().

Here is the call graph for this function:

void AnyOption::processCommandArgs ( int max_args )

Definition at line 539 of file MimoteraAnyOption.cc.

References processCommandArgs().

Here is the call graph for this function:

void AnyOption::processCommandArgs ( )

Definition at line 560 of file MimoteraAnyOption.cc.

References printAutoUsage().

Referenced by processCommandArgs().

Here is the call graph for this function:

bool AnyOption::processFile ( const char * _filename )

Definition at line 880 of file MimoteraAnyOption.cc.

References processFile(), and useFiileName().

Here is the call graph for this function:

bool AnyOption::processFile ( )

Definition at line 872 of file MimoteraAnyOption.cc.

Referenced by processFile().

void AnyOption::processOptions ( )

Definition at line 532 of file MimoteraAnyOption.cc.

void AnyOption::setCommandFlag	(	const char *	opt_string,
		char	opt_char
	)

Definition at line 390 of file MimoteraAnyOption.cc.

References COMMAND_FLAG.

void AnyOption::setCommandFlag ( char opt_char )

Definition at line 385 of file MimoteraAnyOption.cc.

References COMMAND_FLAG.

void AnyOption::setCommandFlag ( const char * opt_string )

Definition at line 380 of file MimoteraAnyOption.cc.

References COMMAND_FLAG.

void AnyOption::setCommandLongPrefix ( char * _prefix )

Definition at line 281 of file MimoteraAnyOption.cc.

References MAX_LONG_PREFIX_LENGTH.

void AnyOption::setCommandOption	(	const char *	opt_string,
		char	opt_char
	)

Definition at line 374 of file MimoteraAnyOption.cc.

References COMMAND_OPT.

void AnyOption::setCommandOption ( char opt_char )

Definition at line 369 of file MimoteraAnyOption.cc.

References COMMAND_OPT.

void AnyOption::setCommandOption ( const char * opt_string )

Definition at line 364 of file MimoteraAnyOption.cc.

References COMMAND_OPT.

void AnyOption::setCommandPrefixChar ( char _prefix )

Definition at line 277 of file MimoteraAnyOption.cc.

void AnyOption::setFileCommentChar ( char _comment )

Definition at line 289 of file MimoteraAnyOption.cc.

void AnyOption::setFileDelimiterChar ( char _delimiter )

Definition at line 294 of file MimoteraAnyOption.cc.

void AnyOption::setFileFlag	(	const char *	opt_string,
		char	opt_char
	)

Definition at line 422 of file MimoteraAnyOption.cc.

References FILE_FLAG.

void AnyOption::setFileFlag ( char opt_char )

Definition at line 417 of file MimoteraAnyOption.cc.

References FILE_FLAG.

void AnyOption::setFileFlag ( const char * opt_string )

Definition at line 412 of file MimoteraAnyOption.cc.

References FILE_FLAG.

void AnyOption::setFileOption	(	const char *	opt_string,
		char	opt_char
	)

Definition at line 406 of file MimoteraAnyOption.cc.

References FILE_OPT.

void AnyOption::setFileOption ( char opt_char )

Definition at line 401 of file MimoteraAnyOption.cc.

References FILE_OPT.

void AnyOption::setFileOption ( const char * opt_string )

Definition at line 396 of file MimoteraAnyOption.cc.

References FILE_OPT.

void AnyOption::setFlag	(	const char *	opt_string,
		char	opt_char
	)

Definition at line 463 of file MimoteraAnyOption.cc.

References COMMON_FLAG.

void AnyOption::setFlag ( char opt_char )

Definition at line 456 of file MimoteraAnyOption.cc.

References COMMON_FLAG.

void AnyOption::setFlag ( const char * opt_string )

Definition at line 449 of file MimoteraAnyOption.cc.

References COMMON_FLAG.

void AnyOption::setOption	(	const char *	opt_string,
		char	opt_char
	)

Definition at line 441 of file MimoteraAnyOption.cc.

References COMMON_OPT.

void AnyOption::setOption ( char opt_char )

Definition at line 434 of file MimoteraAnyOption.cc.

References COMMON_OPT.

void AnyOption::setOption ( const char * opt_string )

Definition at line 428 of file MimoteraAnyOption.cc.

References COMMON_OPT.

void AnyOption::setVerbose ( )

Definition at line 315 of file MimoteraAnyOption.cc.

void AnyOption::useCommandArgs	(	int	_argc,
		char **	_argv
	)

Definition at line 347 of file MimoteraAnyOption.cc.

Referenced by processCommandArgs().

void AnyOption::useFiileName ( const char * _filename )

Definition at line 355 of file MimoteraAnyOption.cc.

Referenced by processFile().

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

include/mimotera++/MimoteraAnyOption.hh
src/MimoteraAnyOption.cc


Public Member Functions
	AnyOption ()
	AnyOption (int maxoptions)
	AnyOption (int maxoptions, int maxcharoptions)
	~AnyOption ()
void	setCommandPrefixChar (char _prefix)
void	setCommandLongPrefix (char *_prefix)
void	setFileCommentChar (char _comment)
void	setFileDelimiterChar (char _delimiter)
void	useCommandArgs (int _argc, char **_argv)
void	useFiileName (const char *_filename)
void	noPOSIX ()
void	setVerbose ()
void	setOption (const char *opt_string)
void	setOption (char opt_char)
void	setOption (const char *opt_string, char opt_char)
void	setFlag (const char *opt_string)
void	setFlag (char opt_char)
void	setFlag (const char *opt_string, char opt_char)
void	setCommandOption (const char *opt_string)
void	setCommandOption (char opt_char)
void	setCommandOption (const char *opt_string, char opt_char)
void	setCommandFlag (const char *opt_string)
void	setCommandFlag (char opt_char)
void	setCommandFlag (const char *opt_string, char opt_char)
void	setFileOption (const char *opt_string)
void	setFileOption (char opt_char)
void	setFileOption (const char *opt_string, char opt_char)
void	setFileFlag (const char *opt_string)
void	setFileFlag (char opt_char)
void	setFileFlag (const char *opt_string, char opt_char)
void	processOptions ()
void	processCommandArgs ()
void	processCommandArgs (int max_args)
bool	processFile ()
void	processCommandArgs (int _argc, char **_argv)
void	processCommandArgs (int _argc, char **_argv, int max_args)
bool	processFile (const char *_filename)
char *	getValue (const char *_option)
bool	getFlag (const char *_option)
char *	getValue (char _optchar)
bool	getFlag (char _optchar)
void	printUsage ()
void	printAutoUsage ()
void	addUsage (const char *line)
void	printHelp ()
void	autoUsagePrint (bool flag)
int	getArgc ()
char *	getArgv (int index)
bool	hasOptions ()