JPARSER Namespace Reference

Local namespace for command line parser. More...

Classes
struct	initialised
	Empty structure for specification of parser element that is initialised (i.e. does not require input). More...
struct	not_initialised
	Empty structure for specification of parser element that is not initialised (i.e. does require input). More...
class	JOption
	Auxiliary class to handle optional I/O. More...
class	JCounter
	Auxiliary class to handle multiple boolean-like I/O. More...
class	JParserElementInterface
	Interface for I/O of parser element. More...
class	JParserTemplateElement
	Template class holder for I/O of parser element. More...
class	JCSV
	Auxiliary class to assign the remainder of a sequence of Comma Separated Values. More...
class	JParserTemplateElement< JType_t, false >
	Template specialisation of JPARSER::JParserTemplateElement for data type without equal operator ==. 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...
class	JParserTemplateElement< JType_t, true >
	Template specialisation of JPARSER::JParserTemplateElement for data type with equal operator ==. 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	JParserElement
	Auxiliary class to handle pointer to JPARSER::JParserElementInterface. More...
class	JParser
	Utility class to parse command line options. More...

Functions
std::ostream &	getOstream ()
	Get output stream for conversion to std::string. More...
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...

Detailed Description

Local namespace for command line parser.

Function Documentation

std::ostream& JPARSER::getOstream ( )

inline

Get output stream for conversion to std::string.

Note that the stream is emptied before use.

Returns

output stream

Definition at line 70 of file JParser.hh.

  {
    static std::ostringstream buffer;

    buffer.str("");

    return buffer;
  }

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 113 of file JParser.hh.

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

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 1895 of file JParser.hh.

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

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 1909 of file JParser.hh.

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

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 1924 of file JParser.hh.

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

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 1941 of file JParser.hh.

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

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 1961 of file JParser.hh.

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

Variable Documentation

char JPARSER::START_OF_OPTION = '-'

static

Parser options.

start of an option

Definition at line 95 of file JParser.hh.

char JPARSER::END_OF_OPTIONS = '-'

static

end of all options

Definition at line 96 of file JParser.hh.

char JPARSER::HELP_OPTION = 'h'

static

help option

Definition at line 97 of file JParser.hh.

char JPARSER::REVISION_OPTION = 'v'

static

revision option

Definition at line 98 of file JParser.hh.

char JPARSER::PRINT_OPTION = '!'

static

print option

Definition at line 99 of file JParser.hh.

char JPARSER::PID_OPTION = 'P'

static

print PID to file

Definition at line 100 of file JParser.hh.

int JPARSER::NORMAL_EXIT_CODE = 0

static

exit code of normal end

Definition at line 101 of file JParser.hh.

int JPARSER::WIDTH = 12

static

format specifier

Definition at line 102 of file JParser.hh.