GeometryDBSvc Class Reference

Concrete class for interface to geometry database with possibility to override entries from a text file. More...

#include <GeometryDBSvc.h>

Inheritance diagram for GeometryDBSvc:

Collaboration diagram for GeometryDBSvc:

Public Member Functions
	GeometryDBSvc (const std::string &name, ISvcLocator *sl)
virtual	~GeometryDBSvc ()
virtual StatusCode	initialize ()
	Service init.
virtual StatusCode	finalize ()
	Service finalize.
virtual double	getDouble (IRDBRecordset_ptr recordSet, const std::string &name, int index=0) const
virtual int	getInt (IRDBRecordset_ptr recordSet, const std::string &name, int index=0) const
virtual std::string	getString (IRDBRecordset_ptr recordSet, const std::string &name, int index=0) const
virtual bool	testField (IRDBRecordset_ptr recordSet, const std::string &name, int index=0) const
virtual bool	testFieldTxt (IRDBRecordset_ptr recordSet, const std::string &name, int index=0) const
virtual unsigned int	getTableSize (IRDBRecordset_ptr recordSet) const
virtual double	getDouble (const std::string &recordSetName, const std::string &name, int index=0) const
virtual int	getInt (const std::string &recordSetName, const std::string &name, int index=0) const
virtual std::string	getString (const std::string &recordSetName, const std::string &name, int index=0) const
virtual bool	testField (const std::string &recordSetName, const std::string &name, int index=0) const
virtual unsigned int	getTableSize (const std::string &recordSetName) const
virtual void	printParameters (const std::string &section="") const
	Print paramaters read in from text file. If section is supplied only consider the parameters in that section.
virtual void	printNotUsed (const std::string &section="") const
	Print paramaters from text file which are not used. If section is supplied only consider the parameters in that section.

Private Member Functions
void	setParameterFileName (const std::string &filename)
std::string	parameterKey (const std::string &recordSetName, const std::string &name, int index) const
bool	getValue (const std::string &recordSetName, const std::string &name, int index, std::string &var) const
bool	getValue (const std::string &recordSetName, const std::string &name, int index, double &var) const
bool	getValue (const std::string &recordSetName, const std::string &name, int index, int &var) const
bool	getTableSizeFromTextFile (const std::string &recordSetName, int &var) const

Private Attributes
TextFileDBReader *	m_textParameters
std::string	m_textFileName
bool	m_printParameters
bool	m_printNotUsed
std::vector< std::string >	m_sections

Detailed Description

Concrete class for interface to geometry database with possibility to override entries from a text file.

Definition at line 25 of file GeometryDBSvc.h.

Constructor & Destructor Documentation

GeometryDBSvc()

GeometryDBSvc::GeometryDBSvc	(	const std::string &	name,
		ISvcLocator *	sl )

Definition at line 14 of file GeometryDBSvc.cxx.

                                                                              : 
  base_class(name, pSvcLocator),
  m_textParameters(0)
{
  declareProperty("TextFileName",m_textFileName, "Text file name for overriding database.");
  declareProperty("PrintParameters",m_printParameters = true, "Print parameters read in from text file.");
  declareProperty("PrintNotUsed", m_printNotUsed = true, "Print parameters not used.");
  declareProperty("Sections", m_sections, "Sections considered for logging. Empty list means all.");
}

~GeometryDBSvc()

GeometryDBSvc::~GeometryDBSvc ( )

virtual

Definition at line 24 of file GeometryDBSvc.cxx.

{
  delete m_textParameters;
}

Member Function Documentation

finalize()

StatusCode GeometryDBSvc::finalize ( )

virtual

Service finalize.

Definition at line 67 of file GeometryDBSvc.cxx.

{
  
  if (m_textParameters && m_printNotUsed && msgLvl(MSG::INFO)) {
    if (m_sections.empty()) {
      // Consider all parameters if no sections are requested.
      msg(MSG::INFO) << "The following parameters were not used:" << endmsg;
      m_textParameters->printNotUsed();
    } else {
      // Otherwise consider only those parameters that belong to sections requested.
      bool printedUnnamed = false;
      for (std::vector<std::string>::const_iterator iter = m_sections.begin(); iter != m_sections.end(); ++iter) {
    msg(MSG::INFO) << "The following parameters were not used from section: " << *iter <<endmsg;
    if (m_textParameters->sectionPresent(*iter)) {
      m_textParameters->printNotUsed(*iter);
    } else {
      // If section not present consider those in unnamed section (passing a section name that is not present will do this) 
      // If we already printed those in the unnamed section don't do so again.
      if (printedUnnamed) {
        msg(MSG::INFO) << " Section not present. Parameters from text file from unnamed section already printed above." << endmsg;
      } else {      
        msg(MSG::INFO) << " Section not present. Parameters from text file from unnamed section will be printed." << endmsg;
        m_textParameters->printNotUsed(*iter);
        printedUnnamed = true;
      }
    }
      }
    }
  }
  return StatusCode::SUCCESS;
}

getDouble() [1/2]

double GeometryDBSvc::getDouble ( const std::string & recordSetName, const std::string & name, int index = 0 ) const

virtual

Definition at line 148 of file GeometryDBSvc.cxx.

{
  double tmpPar = 0;
  if (getValue(recordSetName,name,index,tmpPar)) {
    if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "TEXTFILE: Parameter " << parameterKey(recordSetName,name,index) << " from text file: " << tmpPar << endmsg; 
    return tmpPar;
  } else  {
    msg(MSG::ERROR) << "Parameter " << parameterKey(recordSetName,name,index) << " not found." << endmsg; 
    return 0;
  } 
}

getDouble() [2/2]

double GeometryDBSvc::getDouble ( IRDBRecordset_ptr recordSet, const std::string & name, int index = 0 ) const

virtual

Definition at line 129 of file GeometryDBSvc.cxx.

{
  if (!recordSet.get()) return getDouble("",name,index);
  double tmpPar = 0;
  std::string recordSetName = recordSet->nodeName();
  if (getValue(recordSetName,name,index,tmpPar)) {
    if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "TEXTFILE: Parameter " << parameterKey(recordSetName,name,index) << " from text file: " << tmpPar << endmsg; 
  } else {
    if (index >= (int)recordSet->size()) {
      msg(MSG::ERROR) << "Parameter " << parameterKey(recordSetName,name,index) << " not found. " << endmsg; 
    } else {
      tmpPar = (*recordSet)[index]->getDouble(name);
      if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "Parameter " << parameterKey(recordSetName,name,index) << " from database: " << tmpPar << endmsg; 
    }
  } 
  return tmpPar;
}

getInt() [1/2]

int GeometryDBSvc::getInt ( const std::string & recordSetName, const std::string & name, int index = 0 ) const

virtual

Definition at line 180 of file GeometryDBSvc.cxx.

{
  int tmpPar = 0;
  if (getValue(recordSetName,name,index,tmpPar)) {
    if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "TEXTFILE: Parameter " << parameterKey(recordSetName,name,index) << " from text file: " << tmpPar << endmsg; 
    return tmpPar;
  } else  {
    msg(MSG::ERROR) << "Parameter " << parameterKey(recordSetName,name,index) << index << " not found." << endmsg; 
    return 0;
  } 
}

getInt() [2/2]

int GeometryDBSvc::getInt ( IRDBRecordset_ptr recordSet, const std::string & name, int index = 0 ) const

virtual

Definition at line 161 of file GeometryDBSvc.cxx.

{
  if (!recordSet.get()) return getInt("",name,index);
  int tmpPar = 0;
  std::string recordSetName = recordSet->nodeName();
  if (getValue(recordSetName,name,index,tmpPar)) {
    if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "TEXTFILE: Parameter " << parameterKey(recordSetName,name,index) << " from text file: " << tmpPar << endmsg; 
  } else {
    if (index >= (int)recordSet->size()) {
      msg(MSG::ERROR) << "Parameter " << parameterKey(recordSetName,name,index) << " not found. " << endmsg; 
    } else {
      tmpPar = (*recordSet)[index]->getInt(name);
      if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "Parameter " << parameterKey(recordSetName,name,index) << " from database: " << tmpPar << endmsg; 
    }
  } 
  return tmpPar;
}

getString() [1/2]

std::string GeometryDBSvc::getString ( const std::string & recordSetName, const std::string & name, int index = 0 ) const

virtual

Definition at line 212 of file GeometryDBSvc.cxx.

{
  std::string tmpPar;
  if (getValue(recordSetName,name,index,tmpPar)) {
    if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "TEXTFILE: Parameter " << parameterKey(recordSetName,name,index) << " from text file: " << tmpPar << endmsg; 
    return tmpPar;
  } else  {
    msg(MSG::ERROR) << "Parameter " << parameterKey(recordSetName,name,index) << " not found." << endmsg; 
    return "";
  } 
}

getString() [2/2]

std::string GeometryDBSvc::getString ( IRDBRecordset_ptr recordSet, const std::string & name, int index = 0 ) const

virtual

Definition at line 193 of file GeometryDBSvc.cxx.

{
  if (!recordSet.get()) return getString("",name,index);
  std::string tmpPar;
  std::string recordSetName = recordSet->nodeName();
  if (getValue(recordSetName,name,index,tmpPar)) {
    if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "TEXTFILE: Parameter " << parameterKey(recordSetName,name,index) << " from text file: " << tmpPar << endmsg; 
  } else {
    if (index >= (int)recordSet->size()) {
      msg(MSG::ERROR) << "Parameter " << parameterKey(recordSetName,name,index) << index << " not found. " << endmsg; 
    } else {
      tmpPar = (*recordSet)[index]->getString(name);
      if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "Parameter " << parameterKey(recordSetName,name,index) << " from database: " << tmpPar << endmsg; 
    }
  } 
  return tmpPar;
}

getTableSize() [1/2]

unsigned int GeometryDBSvc::getTableSize ( const std::string & recordSetName ) const

virtual

Definition at line 347 of file GeometryDBSvc.cxx.

{
  int tmpPar = 0;
  unsigned int tmpParUnsigned = 0;
  // Table size stored with key of form TableSize:TableName
  if (getTableSizeFromTextFile(recordSetName,tmpPar)) {
    if (tmpPar < 0) {
      msg(MSG::ERROR) << "Table " << recordSetName << " size from text file is negative: " << tmpPar << endmsg;  
      tmpPar = 0;
    } else {
      if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "TEXTFILE: Table " << recordSetName << " size from text file: " << tmpPar << endmsg;     
    }
    tmpParUnsigned = static_cast<unsigned int>(tmpPar);
  } else {
    msg(MSG::ERROR) << "getTableSize: Table " << recordSetName << " does not exist in text file." << endmsg;  
  }
  return tmpParUnsigned;
}

getTableSize() [2/2]

unsigned int GeometryDBSvc::getTableSize ( IRDBRecordset_ptr recordSet ) const

virtual

Definition at line 324 of file GeometryDBSvc.cxx.

{
  int tmpPar = 0;
  unsigned int tmpParUnsigned = 0;
  std::string recordSetName = recordSet->nodeName();
  // Table size stored with key of form TableSize:TableName
  if (getTableSizeFromTextFile(recordSetName,tmpPar)) {
    if (tmpPar < 0) {
      msg(MSG::ERROR) << "Table " << recordSetName << " size from text file is negative: " << tmpPar << endmsg;  
      tmpPar = 0;
    } else {
      if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "TEXTFILE: Table " << recordSetName << " size from text file: " << tmpPar << endmsg;     
    }
    tmpParUnsigned = static_cast<unsigned int>(tmpPar);
  } else {
    // Get from database
    tmpParUnsigned = recordSet->size();
    if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "Table " << recordSetName << " size from database: " << tmpParUnsigned << endmsg;       
  }
  return tmpParUnsigned;
}

getTableSizeFromTextFile()

bool GeometryDBSvc::getTableSizeFromTextFile ( const std::string & recordSetName, int & var ) const

private

Definition at line 368 of file GeometryDBSvc.cxx.

{ 
  if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "Looking for TableSize for " << recordSetName << endmsg; 
  std::string result;
  var = -1;
  if (!m_textParameters) return false;
  std::ostringstream key;
  key << "TableSize:" << recordSetName;
  if (m_textParameters->find(key.str(),result)) {
    // Convert to int
    std::istringstream istr(result);
    istr >> var;
    if (!istr.eof()) { // Should have read the whole stream
      msg(MSG::ERROR) << "Error retrieving parameter TableSize:" << recordSetName << " as an int: " << result << endmsg; 
      return false;
    }
    return true;
  } 
  return false;
}

getValue() [1/3]

bool GeometryDBSvc::getValue ( const std::string & recordSetName, const std::string & name, int index, double & var ) const

private

Definition at line 247 of file GeometryDBSvc.cxx.

{
  std::string result;
  var = 0;
  // Get the parameter as a string first
  if (getValue(recordSetName, name, index, result)) {
    std::istringstream istr(result);
    istr >> var;
    if (!istr.eof()) { // Should have read the whole stream
      msg(MSG::ERROR) << "Error retrieving parameter " << parameterKey(recordSetName,name,index) << " as a double: " << result << endmsg; 
      return false;
    }
    return true;
  }
  return false;
}

getValue() [2/3]

bool GeometryDBSvc::getValue ( const std::string & recordSetName, const std::string & name, int index, int & var ) const

private

Definition at line 265 of file GeometryDBSvc.cxx.

{
  std::string result;
  var = 0;
  // Get the parameter as a string first
  if (getValue(recordSetName, name, index, result)) {
    std::istringstream istr(result);
    istr >> var;
    if (!istr.eof()) {  // Should have read the whole stream
      msg(MSG::ERROR) << "Error retrieving parameter " << parameterKey(recordSetName,name,index) << " as an int: " << result << endmsg;
      return false;
    }
    return true;
  }
  return false;
}

getValue() [3/3]

bool GeometryDBSvc::getValue ( const std::string & recordSetName, const std::string & name, int index, std::string & var ) const

private

Definition at line 226 of file GeometryDBSvc.cxx.

{ 
  if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "Looking for Parameter " << parameterKey(recordSetName,name,index) << endmsg; 
  if (recordSetName.empty() && index) {
    msg(MSG::WARNING) << "Non zero index for parameter with empry record set. Index will be ignored: " << index << endmsg; 
  }
  var = "";
  if (!m_textParameters) return false;
  std::string lookupKey = parameterKey(recordSetName,name,index);
  bool result = m_textParameters->find(parameterKey(recordSetName,name,index),var);
  if (!result && !recordSetName.empty()) {
    if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "Not found. Looking for default entry with #ALL" << endmsg; 
    std::ostringstream keyalt;
    keyalt << recordSetName << "#ALL:" << name;
    result = m_textParameters->find(keyalt.str(),var);
  }
  return result;
}

initialize()

StatusCode GeometryDBSvc::initialize ( )

virtual

Service init.

Definition at line 30 of file GeometryDBSvc.cxx.

{ 
  msg(MSG::INFO) << "GeometryDBSvc Initialized" << endmsg;
  setParameterFileName(m_textFileName);
 
  // Some printout
  if (m_textParameters && m_printParameters && msgLvl(MSG::INFO)) {
    if (m_sections.empty()) {
      // Print all parameters if no sections are requested
      msg(MSG::INFO) << "Parameters from text file:" << endmsg;
      m_textParameters->printParameters();
    } else {
      // Otherwise print only those parameters that belong to sections requested.
      bool printedUnnamed = false;
      for (std::vector<std::string>::const_iterator iter = m_sections.begin(); iter != m_sections.end(); ++iter) {
    msg(MSG::INFO) << "Parameters from text file from section: " << *iter << endmsg;
    if (m_textParameters->sectionPresent(*iter)) {
      m_textParameters->printParameters(*iter);
    } else {
      // If section not present print those in unnamed section (passing a section name that is not present will do this) 
      // If we already printed those in the unnamed section don't do so again.
      if (printedUnnamed) {
        msg(MSG::INFO) << " Section not present. Parameters from text file from unnamed section already printed above." << endmsg;
      } else {      
        msg(MSG::INFO) << " Section not present. Parameters from text file from unnamed section will be printed." << endmsg;
        m_textParameters->printParameters(*iter);
        printedUnnamed = true;
      }
    }
      }
    }
  }
  return StatusCode::SUCCESS;  
}

parameterKey()

std::string GeometryDBSvc::parameterKey ( const std::string & recordSetName, const std::string & name, int index ) const

private

Definition at line 117 of file GeometryDBSvc.cxx.

{
  std::ostringstream ostr;
  if (!recordSetName.empty()) {
    ostr << recordSetName << "#" << index << ":" << name;
  } else {
    ostr << name;
  }
  return ostr.str();
}

printNotUsed()

void GeometryDBSvc::printNotUsed ( const std::string & section = "" ) const

virtual

Print paramaters from text file which are not used. If section is supplied only consider the parameters in that section.

Definition at line 396 of file GeometryDBSvc.cxx.

{
  m_textParameters->printNotUsed(section);   
}

printParameters()

void GeometryDBSvc::printParameters ( const std::string & section = "" ) const

virtual

Print paramaters read in from text file. If section is supplied only consider the parameters in that section.

Definition at line 390 of file GeometryDBSvc.cxx.

{
  m_textParameters->printParameters(section); 
}

setParameterFileName()

void GeometryDBSvc::setParameterFileName ( const std::string & filename )

private

Definition at line 101 of file GeometryDBSvc.cxx.

{
  if (!filename.empty()) {
    msg(MSG::INFO) << "Parameters overriden from text file: " << filename << endmsg; 
    msg(MSG::WARNING) << "Overriding from a text file is NOT recommended for production use." << endmsg; 
    if (!m_textParameters)  m_textParameters = new TextFileDBReader;
    bool status = m_textParameters->readFile(filename);
    if (!status) {
      msg(MSG::ERROR) << "Problem reading text file: " << filename << endmsg; 
    }
  }
}

testField() [1/2]

bool GeometryDBSvc::testField ( const std::string & recordSetName, const std::string & name, int index = 0 ) const

virtual

Definition at line 316 of file GeometryDBSvc.cxx.

{
  std::string tmpStr;
  return getValue(recordSetName, name, index, tmpStr);
}

testField() [2/2]

bool GeometryDBSvc::testField ( IRDBRecordset_ptr recordSet, const std::string & name, int index = 0 ) const

virtual

Definition at line 290 of file GeometryDBSvc.cxx.

{
  std::string recordSetName = recordSet->nodeName();
  if (testField(recordSetName, name, index)) {
    if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "Parameter " << parameterKey(recordSetName,name,index) << " found in text file. " << endmsg; 
    return true;
  }
  bool result = false;
  if (index < (int)recordSet->size()) {
    try {
      result = !(*recordSet)[index]->isFieldNull(name);
    }
    catch(std::runtime_error& ex) {
      if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "Exception caught: " << ex.what() << endmsg;
      result = false;
    }
  } 
  if (result){ 
    if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "Parameter " << parameterKey(recordSetName,name,index) << " found in database. " << endmsg; 
  } else {
    if (msgLvl(MSG::VERBOSE)) msg(MSG::VERBOSE) << "Parameter " << parameterKey(recordSetName,name,index) << " not found. " << endmsg; 
  }
  return result;
}

testFieldTxt()

bool GeometryDBSvc::testFieldTxt ( IRDBRecordset_ptr recordSet, const std::string & name, int index = 0 ) const

virtual

Definition at line 283 of file GeometryDBSvc.cxx.

{
  std::string recordSetName = recordSet->nodeName();
  return testField(recordSetName, name, index);
}

Member Data Documentation

m_printNotUsed

bool GeometryDBSvc::m_printNotUsed

private

Definition at line 69 of file GeometryDBSvc.h.

m_printParameters

bool GeometryDBSvc::m_printParameters

private

Definition at line 68 of file GeometryDBSvc.h.

m_sections

std::vector<std::string> GeometryDBSvc::m_sections

private

Definition at line 70 of file GeometryDBSvc.h.

m_textFileName

std::string GeometryDBSvc::m_textFileName

private

Definition at line 67 of file GeometryDBSvc.h.

m_textParameters

TextFileDBReader* GeometryDBSvc::m_textParameters

private

Definition at line 64 of file GeometryDBSvc.h.

---

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

• GeometryDBSvc.h
• GeometryDBSvc.cxx