Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

optionVI Class Reference

Interface to set options externally into a derived class. More...

#include <optionVI.h>

Inheritance diagram for optionVI:

List of all members.

Public Methods

optionVI ()

constructor.

virtual ~optionVI ()

default destructor.

Protected Methods

virtual void setName (std::string name)

add the derived object into the optionManager.

bool search (std::string name) const

returns true if an option with that name is in one of the servers. More...

virtual void defineOption ()

virtual method to be overwriten to define the options of the derived class.

void defineOption (std::string name, std::string* st)

define a string parameter of the derived class as option string.

void defineOption (std::string name, double* d)

define a double parameter of the derived class as option double.

void defineOption (std::string name, int* i)

define a integer paramter of the derived class as option integer.

virtual void setOption (std::string name, std::string c)

virtual method to set the option in a string parameter.

virtual void setOption (std::string name, double c)

virtual method to set the option in a double parameter.

virtual void setOption (std::string name, int c)

virtual method to set the option in a integer/bool parameter.

virtual void writeOutOptions () const

virtual method to writeOut the option defined in this class.

virtual void clear ()

clear the servers.

Private Attributes

serverVI<std::string> m_sserver

string option server.

serverVI<double> m_dserver

double option server.

serverVI<int> m_iserver

integer option server.

Friends

class optionServer

Detailed Description

Interface to set options externally into a derived class.

The derived class can declare some of its parameters as options. The parameters should be strings, doubles, integeres or bool. The derived class should rewrite the virtual method defineOption() to include the defineOption(parName, parPointer) methods with the parameter name and the pointer to this parameter. Usually defineOptions() is just a collection of defineOption(parname, parpointer).
The derived class or a external friend class (optionServer) can set the value of options via the methods setOption(parName, parContent). The options are identified with their names.
Note that the methods setOption() are not protected and they not returns information of errors. The external class that set the options should handle that.

Definition at line 29 of file optionVI.h.

Constructor & Destructor Documentation

optionVI::optionVI ( ) [inline]

constructor.

Definition at line 37 of file optionVI.h.

optionVI::~optionVI ( ) [inline, virtual]

default destructor.

Definition at line 39 of file optionVI.h.

Member Function Documentation

void optionVI::clear ( ) [inline, protected, virtual]

clear the servers.

Definition at line 70 of file optionVI.h.

void optionVI::defineOption ( std::string name,

int * i ) [inline, protected]

define a integer paramter of the derived class as option integer.

Definition at line 57 of file optionVI.h.

void optionVI::defineOption ( std::string name,

double * d ) [inline, protected]

define a double parameter of the derived class as option double.

Definition at line 55 of file optionVI.h.

void optionVI::defineOption ( std::string name,

std::string * st ) [inline, protected]

define a string parameter of the derived class as option string.

Definition at line 53 of file optionVI.h.

void optionVI::defineOption ( ) [inline, protected, virtual]

virtual method to be overwriten to define the options of the derived class.

Reimplemented in IOfileServer, algConditionalTask, algorithmTask, cutSelection, cutSelectionTask, eventTask, messageManager, optionManager, processManager, rHisto, and selectionManager.

Definition at line 50 of file optionVI.h.

bool optionVI::search ( std::string name ) const [protected]

returns true if an option with that name is in one of the servers.

add the object into the optionManager

Reimplemented in IOfileServer.

Definition at line 14 of file optionVI.cpp.

void optionVI::setName ( std::string name ) [inline, protected, virtual]

add the derived object into the optionManager.

Reimplemented from nameVI.

Reimplemented in serviceI.

Definition at line 6 of file optionVI.cpp.

void optionVI::setOption ( std::string selectionName,

int c ) [inline, protected, virtual]

virtual method to set the option in a integer/bool parameter.

Definition at line 64 of file optionVI.h.

void optionVI::setOption ( std::string selectionName,

double c ) [inline, protected, virtual]

virtual method to set the option in a double parameter.

Definition at line 62 of file optionVI.h.

void optionVI::setOption ( std::string selectionName,

std::string cutName ) [inline, protected, virtual]

virtual method to set the option in a string parameter.

Reimplemented in IOfileServer, algConditionalTask, algorithmTask, cutSelection, cutSelectionTask, eventTask, messageManager, processManager, and selectionManager.

Definition at line 60 of file optionVI.h.

void optionVI::writeOutOptions ( ) const [inline, protected, virtual]

virtual method to writeOut the option defined in this class.

Definition at line 20 of file optionVI.cpp.

Friends And Related Function Documentation

class optionServer [friend]

Definition at line 32 of file optionVI.h.

Member Data Documentation

serverVI<double> optionVI::m_dserver [private]

double option server.

Definition at line 77 of file optionVI.h.

serverVI<int> optionVI::m_iserver [private]

integer option server.

Definition at line 79 of file optionVI.h.

serverVI<std::string> optionVI::m_sserver [private]

string option server.

Definition at line 75 of file optionVI.h.

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

Generated at Fri Aug 18 12:57:41 2000 for centella framework by

Public Methods
	optionVI ()
	constructor.
virtual	~optionVI ()
	default destructor.
Protected Methods
virtual void	setName (std::string name)
	add the derived object into the optionManager.
bool	search (std::string name) const
	returns true if an option with that name is in one of the servers. More...
virtual void	defineOption ()
	virtual method to be overwriten to define the options of the derived class.
void	defineOption (std::string name, std::string* st)
	define a string parameter of the derived class as option string.
void	defineOption (std::string name, double* d)
	define a double parameter of the derived class as option double.
void	defineOption (std::string name, int* i)
	define a integer paramter of the derived class as option integer.
virtual void	setOption (std::string name, std::string c)
	virtual method to set the option in a string parameter.
virtual void	setOption (std::string name, double c)
	virtual method to set the option in a double parameter.
virtual void	setOption (std::string name, int c)
	virtual method to set the option in a integer/bool parameter.
virtual void	writeOutOptions () const
	virtual method to writeOut the option defined in this class.
virtual void	clear ()
	clear the servers.
Private Attributes
serverVI<std::string>	m_sserver
	string option server.
serverVI<double>	m_dserver
	double option server.
serverVI<int>	m_iserver
	integer option server.
Friends
class	optionServer