hitfit::Defaults_Text Class Reference

A lightweight implementation of the Defaults interface that uses simple ASCII text files. More...

#include <Defaults_Text.h>

Inheritance diagram for hitfit::Defaults_Text:

Public Member Functions
	Defaults_Text (std::string def_file)
	Constructor, create a Default_Text object from an ASCII text file. Pass an empty string to skip reading a file. More...
	Defaults_Text (std::string def_file, int argc, char **argv)
	Constructor, create a Default_Text object from an ASCII text file and argument list. More...
virtual bool	exists (std::string name) const
virtual bool	get_bool (std::string name) const
virtual double	get_float (std::string name) const
virtual int	get_int (std::string name) const
virtual std::string	get_string (std::string name) const
	~Defaults_Text ()
	Destructor. More...
Public Member Functions inherited from hitfit::Defaults
	Defaults ()
virtual	~Defaults ()

Private Attributes
Defaults_Textrep *	_rep

Friends
std::ostream &	operator<< (std::ostream &s, const Defaults_Text &def)

Detailed Description

A lightweight implementation of the Defaults interface that uses simple ASCII text files.

Create instances of these objects passing in the name of a file. Each line of the file should contain a parameter setting like

name = value

Anything following a `;' or `#' is stried off; leading and trailing whitespaces on value are also removed. Blank lines are ignored.

User can also pass an argument list to the constructor. After the default ASCII input file is read, the argument list will be scanned, to possibly override some of the parameter settings. An argument of the form

–name=value

is equivalent to the parameter setting

name = value

while

–name

is equivalent to

name = 1

and

–noname

is equivalent to

name = 0.

Definition at line 121 of file Defaults_Text.h.

Constructor & Destructor Documentation

hitfit::Defaults_Text::Defaults_Text

(

std::string

def_file

)

Constructor, create a Default_Text object from an ASCII text file. Pass an empty string to skip reading a file.

Parameters

def_file

The ASCII text file to read. Pass an empty string to skip reading a file.

Definition at line 337 of file Defaults_Text.cc.

hitfit::Defaults_Text::Defaults_Text	(	std::string	def_file,
		int	argc,
		char **	argv
	)

Constructor, create a Default_Text object from an ASCII text file and argument list.

Parameters

def_file	The ASCII text file to read. Pass an empty string to skip reading a file.
argc	The length of the argument list.
argv	The argument list.

Definition at line 352 of file Defaults_Text.cc.

hitfit::Defaults_Text::~Defaults_Text

(

)

Destructor.

Definition at line 368 of file Defaults_Text.cc.

Member Function Documentation

bool hitfit::Defaults_Text::exists ( std::string  name ) const

virtual

Test to see if parameter name exists.

Parameters

name	The name of the parameter.

Return:

true if the parameter exists.
false if the parameter does not exist.

Implements hitfit::Defaults.

Definition at line 377 of file Defaults_Text.cc.

Referenced by hitfit::EtaDepResolution::Read().

bool hitfit::Defaults_Text::get_bool ( std::string  name ) const

virtual

Get the value of name as boolean.

Parameters

name	The name of the parameter.

Return:

The value of the parameter a C/C++ bool.

Implements hitfit::Defaults.

Definition at line 424 of file Defaults_Text.cc.

double hitfit::Defaults_Text::get_float ( std::string  name ) const

virtual

Get the value of name as a floating-point of type double.

Parameters

name	The name of the parameter.

Return:

The value of the parameter as a floating-point number (C/C++ double).

Implements hitfit::Defaults.

Definition at line 409 of file Defaults_Text.cc.

Referenced by hitfit::EtaDepResolution::Read().

int hitfit::Defaults_Text::get_int ( std::string  name ) const

virtual

Get the value of name as integer.

Parameters

name	The name of the parameter.

Return:

The value of the parameter an integer (C/C++ int).

Implements hitfit::Defaults.

Definition at line 394 of file Defaults_Text.cc.

string hitfit::Defaults_Text::get_string ( std::string  name ) const

virtual

Get the value of name as a string.

Parameters

name	The name of the parameter.

Return:

The value of the parameter as a string.

Implements hitfit::Defaults.

Definition at line 444 of file Defaults_Text.cc.

Referenced by hitfit::METTranslatorBase< AMet >::METTranslatorBase(), and hitfit::EtaDepResolution::Read().

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  s, const Defaults_Text &  def  )

friend

Output stream operator. Print out all parameters' names and their values.

Parameters

s	The output stream to write.
def	The instance to print.

Return:

The output stream s

Definition at line 459 of file Defaults_Text.cc.

Member Data Documentation

Defaults_Textrep* hitfit::Defaults_Text::_rep

private

The internal representation.

Definition at line 217 of file Defaults_Text.h.