Classes
struct	initialised
	Empty structure for specification of parser element that is initialised (i.e. More...

class	JCounter
	Auxiliary class to handle multiple boolean-like I/O. More...

class	JCSV
	Auxiliary class to assign the remainder of a sequence of Comma Separated Values. More...

class	JOption
	Auxiliary class to handle optional I/O. More...

class	JParser
	Utility class to parse command line options. More...

class	JParserElement
	Auxiliary class to handle pointer to JPARSER::JParserElementInterface. More...

class	JParserElementInterface
	Interface for I/O of parser element. More...

class	JParserTemplateElement
	Template class holder for I/O of parser element. More...

class	JParserTemplateElement< bool >
	Template specialisation of JPARSER::JParserTemplateElement for type `bool`. More...

class	JParserTemplateElement< JCounter >
	Template specialisation of JPARSER::JParserTemplateElement for type `JCounter`. More...

class	JParserTemplateElement< JType_t, false >
	Template specialisation of JPARSER::JParserTemplateElement for data type without equal operator `==`. More...

class	JParserTemplateElement< JType_t, true >
	Template specialisation of JPARSER::JParserTemplateElement for data type with equal operator `==`. More...

struct	not_initialised
	Empty structure for specification of parser element that is not initialised (i.e. More...

struct	TStringHelper
	Auxiliary class for handling I/O of TString depending on its existence. More...

struct	TStringHelper< false >
	Specialisation of TStringHelper if TString does not exist. More...

struct	TStringHelper< true >
	Specialisation of TStringHelper if TString exists. More...

Functions
bool	fail (std::istream &in)
	Check for stream state. More...

JParserTemplateElement< bool >	getOption (bool &object, const std::string &name, const std::string &help="")
	Auxiliary method for creation of template parser element object. More...

JParserTemplateElement< JCounter >	getOption (JCounter &object, const std::string &name, const std::string &help="")
	Auxiliary method for creation of template parser element object. More...

template<class JType_t >
JParserTemplateElement< JType_t >	getOption (JType_t &object, const std::string &name, const std::string &help="")
	Auxiliary method for creation of template parser element object. More...

template<class JType_t , class T >
JParserTemplateElement< JType_t >	getOption (JType_t &object, const std::string &name, const std::string &help, T __begin, T __end)
	Auxiliary method for creation of template parser element object. More...

template<class JType_t , class T >
JParserTemplateElement< JType_t >	getOption (JType_t &object, const std::string &name, T __begin, T __end)
	Auxiliary method for creation of template parser element object. More...

Variables
static char	START_OF_OPTION = '-'
	Parser options. More...

static char	END_OF_OPTIONS = '-'
	end of all options More...

static char	HELP_OPTION = 'h'
	help option More...

static char	REVISION_OPTION = 'v'
	revision option More...

static char	PRINT_OPTION = '!'
	print option More...

static char	PID_OPTION = 'P'
	print PID to file More...

static int	NORMAL_EXIT_CODE = 0
	exit code of normal end More...

static int	WIDTH = 12
	format specifier More...

Function Documentation

◆ fail()

bool JPARSER::fail ( std::istream & in )

inline

Check for stream state.

Note that end-of-file is not defined as an error so to normally process e.g. std::string and std::vector.

Parameters

in	input stream

Returns: true if failure; else false

Definition at line 93 of file JParser.hh.

   {
     return in.bad() || (in.fail() && !in.eof());
   }

◆ getOption() [1/5]

JParserTemplateElement<bool> JPARSER::getOption	(	bool &	object,
		const std::string &	name,
		const std::string &	help = `""`
	)

inline

Auxiliary method for creation of template parser element object.

Parameters

object	object
name	name of object
help	help of object

Returns: parser element

Definition at line 1875 of file JParser.hh.

   {
     return JParserTemplateElement<bool>(object, name, help);
   }

◆ getOption() [2/5]

JParserTemplateElement<JCounter> JPARSER::getOption	(	JCounter &	object,
		const std::string &	name,
		const std::string &	help = `""`
	)

inline

Auxiliary method for creation of template parser element object.

Parameters

object	object
name	name of object
help	help of object

Returns: parser element

Definition at line 1889 of file JParser.hh.

   {
     return JParserTemplateElement<JCounter>(object, name, help);
   }

◆ getOption() [3/5]

template<class JType_t >

JParserTemplateElement<JType_t> JPARSER::getOption	(	JType_t &	object,
		const std::string &	name,
		const std::string &	help = `""`
	)

inline

Auxiliary method for creation of template parser element object.

Parameters

object	object
name	name of object
help	help of object

Returns: parser element

Definition at line 1904 of file JParser.hh.

   {
     return JParserTemplateElement<JType_t>(object, name, help);
   }

◆ getOption() [4/5]

template<class JType_t , class T >

JParserTemplateElement<JType_t> JPARSER::getOption	(	JType_t &	object,
		const std::string &	name,
		const std::string &	help,
		T	__begin,
		T	__end
	)

inline

Auxiliary method for creation of template parser element object.

Parameters

object	object
name	name of object
help	help of object
__begin	begin of possible values
__end	end of possible values

Returns: parser element

Definition at line 1921 of file JParser.hh.

   {
     return JParserTemplateElement<JType_t>(object, name, help, __begin, __end);
   }

◆ getOption() [5/5]

template<class JType_t , class T >

JParserTemplateElement<JType_t> JPARSER::getOption	(	JType_t &	object,
		const std::string &	name,
		T	__begin,
		T	__end
	)

inline

Auxiliary method for creation of template parser element object.

Parameters

object	object
name	name of object
__begin	begin of possible values
__end	end of possible values

Returns: parser element

Definition at line 1941 of file JParser.hh.

   {
     return getOption(object, name, "", __begin, __end);
   }

Variable Documentation

◆ START_OF_OPTION

char JPARSER::START_OF_OPTION = '-'

static

Parser options.

start of an option

Definition at line 75 of file JParser.hh.

◆ END_OF_OPTIONS

char JPARSER::END_OF_OPTIONS = '-'

static

end of all options

Definition at line 76 of file JParser.hh.

◆ HELP_OPTION

char JPARSER::HELP_OPTION = 'h'

static

help option

Definition at line 77 of file JParser.hh.

◆ REVISION_OPTION

char JPARSER::REVISION_OPTION = 'v'

static

revision option

Definition at line 78 of file JParser.hh.

◆ PRINT_OPTION

char JPARSER::PRINT_OPTION = '!'

static

print option

Definition at line 79 of file JParser.hh.

◆ PID_OPTION

char JPARSER::PID_OPTION = 'P'

static

print PID to file

Definition at line 80 of file JParser.hh.

◆ NORMAL_EXIT_CODE

int JPARSER::NORMAL_EXIT_CODE = 0

static

exit code of normal end

Definition at line 81 of file JParser.hh.

◆ WIDTH

int JPARSER::WIDTH = 12

static

format specifier

Definition at line 82 of file JParser.hh.

Classes

Functions

Variables

Function Documentation

◆ fail()

◆ getOption() [1/5]

◆ getOption() [2/5]

◆ getOption() [3/5]

◆ getOption() [4/5]

◆ getOption() [5/5]

Variable Documentation

◆ START_OF_OPTION

◆ END_OF_OPTIONS

◆ HELP_OPTION

◆ REVISION_OPTION

◆ PRINT_OPTION

◆ PID_OPTION

◆ NORMAL_EXIT_CODE

◆ WIDTH