#include <ServiceExtensionTool.h>

Inheritance diagram for ITk::ServiceExtensionTool:

Collaboration diagram for ITk::ServiceExtensionTool:

Public Member Functions
	ServiceExtensionTool (const std::string &type, const std::string &name, const IInterface *parent)

virtual	~ServiceExtensionTool ()=default

virtual StatusCode	create () override final

virtual GeoVDetectorManager *	manager ()
	The Detector Node corresponding to this tool. More...

virtual const GeoVDetectorManager *	manager () const

virtual StatusCode	clear () override

virtual StatusCode registerCallback	ATLAS_NOT_THREAD_SAFE () override

virtual StatusCode	align (IOVSVC_CALLBACK_ARGS) override

Protected Member Functions
bool	isAvailable (const std::string &versionNode, const std::string &tableNode) const

std::string	getBlob (const std::string &versionNode, const std::string &tableNode) const

StatusCode	createBaseTool ()

GeoModelIO::ReadGeoModel *	getSqliteReader () const

const GeoVPhysVol *	createTopVolume (GeoPhysVol worldVol, GmxInterface &interface, const std::string &versionNode, const std::string &tableNode, const std::string &containingDetector="", const std::string &envelopeName="", const GeoModelIO::ReadGeoModel sqlreader=nullptr) const

Protected Attributes
Gaudi::Property< std::string >	m_gmxFilename {this, "GmxFilename", "", "The name of the local file to read the geometry from"}

Gaudi::Property< std::string >	m_detectorName {this, "DetectorName", "ITkStrip", ""}

ServiceHandle< IRDBAccessSvc >	m_rdbAccessSvc {this, "RDBAccessSvc", "RDBAccessSvc", ""}

ServiceHandle< IRDBAccessSvc >	m_sqliteReadSvc {this, "SqliteReadSvc", "SqliteReadSvc", ""}

ServiceHandle< IGeoDbTagSvc >	m_geoDbTagSvc {this, "GeoDbTagSvc", "GeoDbTagSvc", ""}

Gaudi::Property< std::string >	m_dtdName {this, "OverrideDtdName", "", "Override standard .dtd file from GeoModelXml"}

Gaudi::Property< bool >	m_deduplicateLogVol

Gaudi::Property< bool >	m_deduplicatePhysVol

Gaudi::Property< bool >	m_deduplicateShape

Gaudi::Property< bool >	m_deduplicateTransf

GeoVDetectorManager *	m_detector

Private Member Functions
void	createVolume (GeoPhysVol *worldVol, GmxInterface &interface, const std::string &versionNode, const std::string &tableNode) const

Private Attributes
const ServiceExtensionManager *	m_detManager {}

Gaudi::Property< std::string >	m_containingDetectorName {this, "ContainingDetector", "LArBarrel", "Containing detector name"}

Gaudi::Property< std::string >	m_envelopeVolumeName {this, "EnvelopeVolume", "", "Envelope volume name"}

Gaudi::Property< std::string >	m_node {this,"DataBaseNode","InnerDetector", "Node name in Geometry Database"}

Gaudi::Property< std::string >	m_table {this,"DataBaseTable","ITKSERVICESXDD", "Table name in Geometry Database"}

Gaudi::Property< std::string >	m_ServiceExtensionManagerName {this, "ServiceExtensionManagerName", "ITkServiceExtension", "Service Extension Manager Name"}

Gaudi::Property< std::string >	m_clobOutputFileName {this, "ClobOutputName", "", "Name of file to dump CLOB content to"}

Detailed Description

Definition at line 19 of file ServiceExtensionTool.h.

Constructor & Destructor Documentation

◆ ServiceExtensionTool()

ITk::ServiceExtensionTool::ServiceExtensionTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Definition at line 15 of file ServiceExtensionTool.cxx.

  : GeoModelXmlTool(type, name, parent)
 {
 }

◆ ~ServiceExtensionTool()

virtual ITk::ServiceExtensionTool::~ServiceExtensionTool ( )

virtualdefault

Member Function Documentation

◆ align()

StatusCode GeoModelTool::align ( IOVSVC_CALLBACK_ARGS )

overridevirtualinherited

Reimplemented in ALFA_DetectorTool, HGTD_DetectorTool, TRT_DetectorTool, LArDetectorToolNV, PixelDetectorTool, and SCT_DetectorTool.

Definition at line 33 of file GeoModelTool.cxx.

 {
   return StatusCode::SUCCESS;
 }

◆ ATLAS_NOT_THREAD_SAFE()

virtual StatusCode registerCallback GeoModelTool::ATLAS_NOT_THREAD_SAFE ( )

overridevirtualinherited

Reimplemented in PixelDetectorTool, HGTD_DetectorTool, TRT_DetectorTool, SCT_DetectorTool, PLRDetectorTool, BCMPrimeDetectorTool, HGTD_GMX_DetectorTool, and LArDetectorToolNV.

◆ clear()

StatusCode GeoModelTool::clear ( )

overridevirtualinherited

Reimplemented in ITk::StripDetectorTool, PixelDetectorTool, ITk::PixelDetectorTool, HGTD_DetectorTool, TRT_DetectorTool, MuonDetectorTool, MuonGMR4::MuonDetectorTool, PLRDetectorTool, SCT_DetectorTool, BCMPrimeDetectorTool, TileDetectorTool, HGTD_GMX_DetectorTool, BeamPipeDetectorTool, ForDetEnvelopeTool, LUCID_DetectorTool, LArDetectorToolNV, InDetServMatTool, and CavernInfraDetectorTool.

Definition at line 28 of file GeoModelTool.cxx.

 {
   return StatusCode::SUCCESS;
 }

◆ create()

StatusCode ITk::ServiceExtensionTool::create ( )

finaloverridevirtual

Definition at line 22 of file ServiceExtensionTool.cxx.

 {
   // retrieve the common stuff
   ATH_CHECK(createBaseTool());
  
   GeoModelExperiment *theExpt = nullptr;
   ATH_CHECK(detStore()->retrieve(theExpt, "ATLAS"));
   auto *manager = new ServiceExtensionManager(m_ServiceExtensionManagerName);
  
   const GeoModelIO::ReadGeoModel* sqlreader = getSqliteReader();
    
   if(!sqlreader){ 
       if (!isAvailable(m_node, m_table)) {
           ATH_MSG_ERROR("No ServiceExtension geometry found. ServiceExtension can not be built.");
           return StatusCode::FAILURE;
       }
   }
   ATH_MSG_INFO("Building Service Extension");
   
   GeoPhysVol *world = &*theExpt->getPhysVol();
  
   // Load the geometry, create the volume, 
   // node,table are the location in the DB to look for the clob
   // empty strings are the (optional) containing detector and envelope names
   // allowed to pass a null sqlreader ptr - it will be used to steer the source of the geometry
   GmxInterface gmxInterface;
   const GeoVPhysVol * topVol = createTopVolume(world, gmxInterface, m_node,m_table, m_containingDetectorName, m_envelopeVolumeName,sqlreader);
   if (!topVol) {
     ATH_MSG_FATAL("Could not find the Top Volume!!!");
     return StatusCode::FAILURE;
   }
   
   manager->addTreeTop(topVol);
   m_detManager = manager;
   
   ATH_CHECK(detStore()->record(m_detManager, m_detManager->getName()));
   theExpt->addManager(m_detManager);
   
   return StatusCode::SUCCESS;
 }

◆ createBaseTool()

StatusCode GeoModelXmlTool::createBaseTool ( )

protectedinherited

Definition at line 26 of file GeoModelXmlTool.cxx.

 {
   ATH_CHECK(m_geoDbTagSvc.retrieve());
   ATH_CHECK(m_rdbAccessSvc.retrieve());
   ATH_CHECK(m_sqliteReadSvc.retrieve());
  
   return StatusCode::SUCCESS;
 }

◆ createTopVolume()

const GeoVPhysVol * GeoModelXmlTool::createTopVolume	(	GeoPhysVol *	worldVol,
		GmxInterface &	interface,
		const std::string &	versionNode,
		const std::string &	tableNode,
		const std::string &	containingDetector = `""`,
		const std::string &	envelopeName = `""`,
		const GeoModelIO::ReadGeoModel *	sqlreader = `nullptr`
	)		const

protectedinherited

Definition at line 35 of file GeoModelXmlTool.cxx.

 {
   //If we have a valid sqlreader pointer, it means the volume should already exist,
   // so we don't need to create it  
   if(!sqlreader) createVolume(world, gmxInterface, vNode, tableName);
   else ATH_MSG_INFO("Using geometry from .sqlite file for"<<m_detectorName);
  
   unsigned int nChildren = world->getNChildVols();
  
   const GeoVPhysVol * envVol = nullptr;
   const GeoVPhysVol * topVol = nullptr;
  
   bool foundEnvelope = false;
   bool foundContainingDetector = false;
   // find the appropriate volume in the hierarchy, to allow it to be set as the topVolume in
   // our detectorManager
   std::string detectorName = m_detectorName; 
   //if a containingDetector is set, which the detector we are dealing with will sit inside, look for that first. 
   // Otherwise its just the name of the detector we are dealing with we look for
   if(containingDetector!="") detectorName = containingDetector;
  
   for (int iChild = nChildren - 1; iChild>=0; --iChild) {
     if (world->getNameOfChildVol(iChild) == detectorName) {
       // The * converts from a ConstPVLink to a reference to a GeoVPhysVol;
       // the & takes its address.
       envVol = &*world->getChildVol(iChild);
       foundContainingDetector = true;
       if(envelopeName=="") {topVol = envVol;break;}
       unsigned int nGrandchildren = envVol->getNChildVols();    
     for (int iGchild = nGrandchildren - 1; iGchild>=0; --iGchild) {
      if (envVol->getNameOfChildVol(iGchild) == envelopeName) {  
       topVol = &*(envVol->getChildVol(iGchild));
       foundEnvelope = true;
       break;
      }
     }
    }
   }
   if(containingDetector!="" && !foundContainingDetector) ATH_MSG_ERROR("Couldn't find the containing detector "<<containingDetector<<" in the world hierarchy!");
   else if(envelopeName!="" && !foundEnvelope) ATH_MSG_ERROR("Couldn't find the envelope volume "<<envelopeName<<" in the world hierarchy!");
   return topVol;
 }

◆ createVolume()

void GeoModelXmlTool::createVolume	(	GeoPhysVol *	worldVol,
		GmxInterface &	interface,
		const std::string &	versionNode,
		const std::string &	tableNode
	)		const

privateinherited

Definition at line 107 of file GeoModelXmlTool.cxx.

                                                                                                                                           {
   int flags{};
   std::string gmxInput;
  
   if (m_gmxFilename.empty()) {
     ATH_MSG_INFO("Getting " << m_detectorName.value() << " GeoModelXml description from the geometry database");
     flags = 0x1; // Lowest bit ==> string; next bit implies gzip'd but we decided not to gzip
     // how to propagate these to here best...?
     gmxInput = getBlob(vNode,tableName);
     if (gmxInput.empty()) { // Invalid blob?
       std::string errMessage("GeoModelXmlTool::createTopVolume: Empty response received from the database.");
       throw std::runtime_error(errMessage);
     }
   } else {
     flags = 0;
     gmxInput = PathResolver::find_file(m_gmxFilename, "DATAPATH");
     ATH_MSG_INFO("Getting " << m_detectorName.value() << " GeoModelXml description from file "<<gmxInput);
     if (gmxInput.empty()) { // File not found
       std::string errMessage("GeoModelXmlTool::createTopVolume: Unable to find file " + m_gmxFilename +
                              " with PathResolver; check filename and DATAPATH environment variable");
       throw std::runtime_error(errMessage);
     }
   }
  
   // Use the DTD from GeoModel
   if (m_gmxFilename.empty()) {
     std::string replacementName = "GeoModelXml/";
     //now, work out the specific dtd version in the input .gmx
     std::string startdelim = "SYSTEM \"";
     std::string enddelim = "\" [";
     unsigned startpos = gmxInput.find(startdelim) + startdelim.length();
     unsigned endpos = gmxInput.find(enddelim);
     std::string searchName = gmxInput.substr(startpos,(endpos - startpos));
     if(searchName=="geomodel.dtd") replacementName+="geomodel_v0.dtd"; //used in xml for initial geometry tags - special case
     else replacementName+=searchName;
     ATH_MSG_DEBUG("Searching for "<<searchName<<" and replacing it with "<<replacementName);
     size_t chars = searchName.length();
     size_t index = gmxInput.find(searchName);
     if(m_dtdName!="")  replacementName=m_dtdName; //allow overriding of dtd version
     if (index != std::string::npos) {
         std::string dtdFile = PathResolver::find_file(replacementName, "DATAPATH");
         ATH_MSG_DEBUG("dtdFile = " << dtdFile);  
         gmxInput.replace(index,chars, dtdFile);
     } else {  
       throw std::runtime_error("GeoModelXmlTool::createTopVolume: Did not find valid .dtd in the gmx input string.");
     }
   }
  
   // optionally dump to local file for examination
   if (m_clobOutputFileName != "") {
     std::ofstream out(m_clobOutputFileName);
     if (m_gmxFilename.empty()) {
       out << gmxInput;
     } else {
       std::ifstream in(gmxInput);
       out << in.rdbuf();
     }
     out.close();
   }
   gmxInterface.enableLogVolDeDuplication(m_deduplicateLogVol);
   gmxInterface.enablePhysVolDeDuplication(m_deduplicatePhysVol);
   gmxInterface.enableShapeDeDuplication(m_deduplicateShape);
   gmxInterface.enableTransformDeDuplication(m_deduplicateTransf);
  
   Gmx2Geo gmx2Geo(gmxInput, world, gmxInterface, flags);  
 }

◆ getBlob()

std::string GeoModelXmlTool::getBlob	(	const std::string &	versionNode,
		const std::string &	tableNode
	)		const

protectedinherited

Definition at line 94 of file GeoModelXmlTool.cxx.

 {
   DecodeVersionKey versionKey(&*m_geoDbTagSvc, vNode);
   const IRDBRecordset_ptr recordSet = m_rdbAccessSvc->getRecordsetPtr(tableName, versionKey.tag(), versionKey.node());
   if (!recordSet || recordSet->size() == 0) {
     ATH_MSG_FATAL("Unable to obtain " << vNode << " recordSet");
     throw std::runtime_error("Unable to obtain recordSet");
   }
   const IRDBRecord *record = (*recordSet)[0];
   std::string clobString = record->getString("XMLCLOB");
   return clobString;
 }

◆ getSqliteReader()

GeoModelIO::ReadGeoModel * GeoModelXmlTool::getSqliteReader ( ) const

protectedinherited

Definition at line 174 of file GeoModelXmlTool.cxx.

                                                               {
   return m_geoDbTagSvc->getSqliteReader();
 }

◆ isAvailable()

bool GeoModelXmlTool::isAvailable	(	const std::string &	versionNode,
		const std::string &	tableNode
	)		const

protectedinherited

Definition at line 78 of file GeoModelXmlTool.cxx.

 {
   if (m_gmxFilename.empty()) {
     DecodeVersionKey versionKey(&*m_geoDbTagSvc, vNode);
     const std::string& versionTag  = versionKey.tag();
     const std::string& versionNode = versionKey.node();
     const std::string version = m_rdbAccessSvc->getChildTag(tableName, versionTag, versionNode);
     if (version.empty()) {
       return false;
     }
     ATH_MSG_INFO("Using " << version << " from " << versionNode << " tag " << versionTag);
   }
  
   return true;
 }

◆ manager() [1/2]

GeoVDetectorManager * GeoModelTool::manager ( )

virtualinherited

The Detector Node corresponding to this tool.

Definition at line 21 of file GeoModelTool.cxx.

                                            {
   return m_detector;
 }

◆ manager() [2/2]

const GeoVDetectorManager * GeoModelTool::manager ( ) const

virtualinherited

Definition at line 24 of file GeoModelTool.cxx.

                                                        {
   return m_detector;
 }

Member Data Documentation

◆ m_clobOutputFileName

Gaudi::Property<std::string> GeoModelXmlTool::m_clobOutputFileName {this, "ClobOutputName", "", "Name of file to dump CLOB content to"}

privateinherited

Definition at line 60 of file GeoModelXmlTool.h.

◆ m_containingDetectorName

Gaudi::Property<std::string> ITk::ServiceExtensionTool::m_containingDetectorName {this, "ContainingDetector", "LArBarrel", "Containing detector name"}

private

Definition at line 28 of file ServiceExtensionTool.h.

◆ m_deduplicateLogVol

Gaudi::Property<bool> GeoModelXmlTool::m_deduplicateLogVol

protectedinherited

Initial value:

{this, "enableLogVolDeduplication", false,

"Remove duplications of equivalent logical volumes"}

Definition at line 48 of file GeoModelXmlTool.h.

◆ m_deduplicatePhysVol

Gaudi::Property<bool> GeoModelXmlTool::m_deduplicatePhysVol

protectedinherited

Initial value:

{this, "enablePhysVolDeduplication", false,

"Remove duplications of equivalent physical volumes"}

Definition at line 50 of file GeoModelXmlTool.h.

◆ m_deduplicateShape

Gaudi::Property<bool> GeoModelXmlTool::m_deduplicateShape

protectedinherited

Initial value:

{this, "enableShapeDeduplication", false,

"Remove duplications of equivalent shapes"}

Definition at line 52 of file GeoModelXmlTool.h.

◆ m_deduplicateTransf

Gaudi::Property<bool> GeoModelXmlTool::m_deduplicateTransf

protectedinherited

Initial value:

{this, "enableTransDeduplication", false,

"Remove duplications of equivalent transform nodes"}

Definition at line 54 of file GeoModelXmlTool.h.

◆ m_detector

GeoVDetectorManager* GeoModelTool::m_detector

protectedinherited

Definition at line 36 of file GeoModelTool.h.

◆ m_detectorName

Gaudi::Property<std::string> GeoModelXmlTool::m_detectorName {this, "DetectorName", "ITkStrip", ""}

protectedinherited

Definition at line 42 of file GeoModelXmlTool.h.

◆ m_detManager

const ServiceExtensionManager* ITk::ServiceExtensionTool::m_detManager {}

private

Definition at line 27 of file ServiceExtensionTool.h.

◆ m_dtdName

Gaudi::Property<std::string> GeoModelXmlTool::m_dtdName {this, "OverrideDtdName", "", "Override standard .dtd file from GeoModelXml"}

protectedinherited

Definition at line 46 of file GeoModelXmlTool.h.

◆ m_envelopeVolumeName

Gaudi::Property<std::string> ITk::ServiceExtensionTool::m_envelopeVolumeName {this, "EnvelopeVolume", "", "Envelope volume name"}

private

Definition at line 29 of file ServiceExtensionTool.h.

◆ m_geoDbTagSvc

ServiceHandle<IGeoDbTagSvc> GeoModelXmlTool::m_geoDbTagSvc {this, "GeoDbTagSvc", "GeoDbTagSvc", ""}

protectedinherited

Definition at line 45 of file GeoModelXmlTool.h.

◆ m_gmxFilename

Gaudi::Property<std::string> GeoModelXmlTool::m_gmxFilename {this, "GmxFilename", "", "The name of the local file to read the geometry from"}

protectedinherited

Definition at line 41 of file GeoModelXmlTool.h.

◆ m_node

Gaudi::Property<std::string> ITk::ServiceExtensionTool::m_node {this,"DataBaseNode","InnerDetector", "Node name in Geometry Database"}

private

Definition at line 30 of file ServiceExtensionTool.h.

◆ m_rdbAccessSvc

ServiceHandle<IRDBAccessSvc> GeoModelXmlTool::m_rdbAccessSvc {this, "RDBAccessSvc", "RDBAccessSvc", ""}

protectedinherited

Definition at line 43 of file GeoModelXmlTool.h.

◆ m_ServiceExtensionManagerName

Gaudi::Property<std::string> ITk::ServiceExtensionTool::m_ServiceExtensionManagerName {this, "ServiceExtensionManagerName", "ITkServiceExtension", "Service Extension Manager Name"}

private

Definition at line 32 of file ServiceExtensionTool.h.

◆ m_sqliteReadSvc

ServiceHandle<IRDBAccessSvc> GeoModelXmlTool::m_sqliteReadSvc {this, "SqliteReadSvc", "SqliteReadSvc", ""}

protectedinherited

Definition at line 44 of file GeoModelXmlTool.h.

◆ m_table

Gaudi::Property<std::string> ITk::ServiceExtensionTool::m_table {this,"DataBaseTable","ITKSERVICESXDD", "Table name in Geometry Database"}

private

Definition at line 31 of file ServiceExtensionTool.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ServiceExtensionTool()

◆ ~ServiceExtensionTool()

Member Function Documentation

◆ align()

◆ ATLAS_NOT_THREAD_SAFE()

◆ clear()

◆ create()

◆ createBaseTool()

◆ createTopVolume()

◆ createVolume()

◆ getBlob()

◆ getSqliteReader()

◆ isAvailable()

◆ manager() [1/2]

◆ manager() [2/2]

Member Data Documentation

◆ m_clobOutputFileName

◆ m_containingDetectorName

◆ m_deduplicateLogVol

◆ m_deduplicatePhysVol

◆ m_deduplicateShape

◆ m_deduplicateTransf

◆ m_detector

◆ m_detectorName

◆ m_detManager

◆ m_dtdName

◆ m_envelopeVolumeName

◆ m_geoDbTagSvc

◆ m_gmxFilename

◆ m_node

◆ m_rdbAccessSvc

◆ m_ServiceExtensionManagerName

◆ m_sqliteReadSvc

◆ m_table