ConfigObject Class Reference

#include <ConfigObject.h>

Inheritance diagram for ConfigObject:

[legend]
List of all members.

Public Member Functions

virtual string toXML () const
virtual string getObjectName () const =0
void setModified (bool b)
bool isModified ()
void setInt (string parameter, int val) throw (ILCException::Exception)
void setString (string parameter, string val) throw (ILCException::Exception)
void setIntVector (string parameter, vector< int > val) throw (ILCException::Exception)
void setNull (string parameter) throw (ILCException::Exception)
bool isNull (string parameter) throw (ILCException::Exception)
int getInt (string parameter) throw (ILCException::Exception)
string getString (string parameter) throw (ILCException::Exception)
vector< int > getIntVector (string parameter) throw (ILCException::Exception)
string getType (string parameter) throw (ILCException::Exception)
vector< string > getParametersNames () throw (ILCException::Exception)
vector< string > getParametersTypes () throw (ILCException::Exception)
vector< string > getParametersTables () throw (ILCException::Exception)
vector< string > getParametersFromTable (string tableName) throw (ILCException::Exception)
void setParameters (map< string, string > p)

Static Public Member Functions

static void terminate ()

Protected Member Functions

void createParameters (string objectName)
void addParameter (string param, string type)

Detailed Description

Abstract super class for basic objects (LDA, DIF, ASIC, ...)


Member Function Documentation

int ConfigObject::getInt ( string  parameter  )  throw (ILCException::Exception)

Get an int parameter value

Parameters:
parameter The name of the parameter.
Returns:
The value of the paramter

vector< int > ConfigObject::getIntVector ( string  parameter  )  throw (ILCException::Exception)

Get an vector<int> parameter value

Parameters:
parameter The name of the parameter.
Returns:
The value of the paramter

virtual string ConfigObject::getObjectName (  )  const [pure virtual]

Get the name of the actual object

Implemented in Asic, Dcc, Dif, and Lda.

vector< string > ConfigObject::getParametersFromTable ( string  tableName  )  throw (ILCException::Exception)

Get the list of the parameters in the given table

Returns:
A vector containing all the parameters names

vector< string > ConfigObject::getParametersNames (  )  throw (ILCException::Exception)

Get the list of the parameters names

Returns:
A vector containing all the parameters names

vector< string > ConfigObject::getParametersTables (  )  throw (ILCException::Exception)

Get the list of the tables where the parameters are stored

Returns:
A vector containing all the tables names

vector< string > ConfigObject::getParametersTypes (  )  throw (ILCException::Exception)

Get the list of the parameters types

Returns:
A vector containing all the parameters types (the order is the same than in the getParametersNames method)

string ConfigObject::getString ( string  parameter  )  throw (ILCException::Exception)

Get a string parameter value

Parameters:
parameter The name of the parameter.
Returns:
The value of the paramter

string ConfigObject::getType ( string  parameter  )  throw (ILCException::Exception)

Get The type of the given paramter

Parameters:
parameter The name of the parameter.
Returns:
A string describing the type ('int', 'string', 'vector<int>')

bool ConfigObject::isModified (  ) 

Get the modified status of the object

Returns:
True if the object was said to be modified, false otherwise.

bool ConfigObject::isNull ( string  parameter  )  throw (ILCException::Exception)

Check if the given parameter is null

Parameters:
parameter The name of the parameter.
Returns:
True if the parameter is null

void ConfigObject::setInt ( string  parameter,
int  val 
) throw (ILCException::Exception)

Change a int parameter of the object

Parameters:
parameter The name of the parameter.
val The value to set to the parameter

void ConfigObject::setIntVector ( string  parameter,
vector< int >  val 
) throw (ILCException::Exception)

Change a vector<int> parameter of the object

Parameters:
parameter The name of the parameter.
val The value to set to the parameter

void ConfigObject::setModified ( bool  b  ) 

Flag the object as beeing modified (or not modified). Only modified objects will be uploaded in a minor version.

Parameters:
b True if the object was modified, false otherwise.

void ConfigObject::setNull ( string  parameter  )  throw (ILCException::Exception)

Set a parameter of the object to NULL value

Parameters:
parameter The name of the parameter.

void ConfigObject::setParameters ( map< string, string >  p  ) 

Set all parameters contained in the map to the object

Parameters:
p A map containing <parameter_name, parameter_value>

void ConfigObject::setString ( string  parameter,
string  val 
) throw (ILCException::Exception)

Change a string parameter of the object

Parameters:
parameter The name of the parameter.
val The value to set to the parameter

string ConfigObject::toXML (  )  const [virtual]

Returns a XML description of the object

Returns:
A string containing the XML description

Reimplemented in Asic, Dcc, Dif, and Lda.


The documentation for this class was generated from the following files:
Generated on Tue Feb 28 15:35:34 2012 for ILCConfigurationDB by  doxygen 1.4.7