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

optionServer Class Reference

Stores and applies options to a collection of optionVI derived classes. More...

#include <optionServer.h>

Inheritance diagram for optionServer:

List of all members.

Public Methods

optionServer ()

constructor.

virtual ~optionServer ()

destructor.

void setOptionFileName (std::string name)

void setOption ()

set a collection of options from a external file (set in m_optionFileName);.

virtual bool search (std::string name) const

virtual method that returns true if the named object is in the server.

virtual void addToServer (std::string name, optionVI* op)

method to include a optionVI class in the server.

virtual void writeOutOptionsServer () const

method to writeOut the option information of all the classes in the server.

virtual void writeOut () const

metho to writeOut information about this class.

Protected Methods

optionVI* getOption (std::string name) const

returns the optionVI of the object with name.

void setOption (std::string className, std::string par, std::string con)

set a string option in an object named className inserted in the server.

void setOption (std::string className, std::string par, double d)

set a double option in an object named className.

void setOption (std::string className, std::string par, int i)

set a int option in an object named className.

Protected Attributes

std::string m_optionFileName

default ASCII file with the list of options.

serverVI<optionVI>* m_server

Server with the classes where optionVI can be apply().

Friends

class optionManager

Detailed Description

Stores and applies options to a collection of optionVI derived classes.

OptionServer sets options to classed derived from optionVI and previously declared into its server.
OptionServer reads and sets options from an external file.

The options can be set to classes derived from optionVI.They should be declared into the server, using the method addToServer(). Every object should have a unique name into the server.
The setOption() method allows to set a collection of options from a external file. The options should be listed in the file in the following way: "objectName parName parType parContent", where parType can be "S" for string, "D" for double or "I" for integer. A line started with "//" in the file will be ignored and it can be use to put comments).
Use the method setOptionFileName() to set the name of the file with the list of options to apply.
Options can be apply from a external client via the methods setOption(objectName, parName, parContent). The option is called parName and the content is parContent.

Definition at line 33 of file optionServer.h.

Constructor & Destructor Documentation

optionServer::optionServer ( )

constructor.

Definition at line 5 of file optionServer.cpp.

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

destructor.

Definition at line 12 of file optionServer.cpp.

Member Function Documentation

void optionServer::addToServer ( std::string name,

optionVI * op ) [inline, virtual]

method to include a optionVI class in the server.

Definition at line 125 of file optionServer.cpp.

optionVI * optionServer::getOption ( std::string name ) const [protected]

returns the optionVI of the object with name.

Definition at line 118 of file optionServer.cpp.

bool optionServer::search ( std::string name ) const [inline, virtual]

virtual method that returns true if the named object is in the server.

Definition at line 50 of file optionServer.h.

void optionServer::setOption ( std::string className,

std::string par,

int i ) [protected]

set a int option in an object named className.

Definition at line 70 of file optionServer.cpp.

void optionServer::setOption ( std::string className,

std::string par,

double d ) [protected]

set a double option in an object named className.

Definition at line 70 of file optionServer.cpp.

void optionServer::setOption ( std::string className,

std::string par,

std::string con ) [protected]

set a string option in an object named className inserted in the server.

Definition at line 70 of file optionServer.cpp.

void optionServer::setOption ( )

set a collection of options from a external file (set in m_optionFileName);.

Definition at line 18 of file optionServer.cpp.

void optionServer::setOptionFileName ( std::string name ) [inline]

Definition at line 45 of file optionServer.h.

void optionServer::writeOut ( ) const [inline, virtual]

metho to writeOut information about this class.

Definition at line 142 of file optionServer.cpp.

void optionServer::writeOutOptionsServer ( ) const [inline, virtual]

method to writeOut the option information of all the classes in the server.

Definition at line 134 of file optionServer.cpp.

Friends And Related Function Documentation

class optionManager [friend]

Definition at line 36 of file optionServer.h.

Member Data Documentation

std::string optionServer::m_optionFileName [protected]

default ASCII file with the list of options.

Definition at line 74 of file optionServer.h.

serverVI<optionVI>* optionServer::m_server [protected]

Server with the classes where optionVI can be apply().

Definition at line 77 of file optionServer.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
	optionServer ()
	constructor.
virtual	~optionServer ()
	destructor.
void	setOptionFileName (std::string name)
void	setOption ()
	set a collection of options from a external file (set in m_optionFileName);.
virtual bool	search (std::string name) const
	virtual method that returns true if the named object is in the server.
virtual void	addToServer (std::string name, optionVI* op)
	method to include a optionVI class in the server.
virtual void	writeOutOptionsServer () const
	method to writeOut the option information of all the classes in the server.
virtual void	writeOut () const
	metho to writeOut information about this class.
Protected Methods
optionVI*	getOption (std::string name) const
	returns the optionVI of the object with name.
void	setOption (std::string className, std::string par, std::string con)
	set a string option in an object named className inserted in the server.
void	setOption (std::string className, std::string par, double d)
	set a double option in an object named className.
void	setOption (std::string className, std::string par, int i)
	set a int option in an object named className.
Protected Attributes
std::string	m_optionFileName
	default ASCII file with the list of options.
serverVI<optionVI>*	m_server
	Server with the classes where optionVI can be apply().
Friends
class	optionManager