#include <DumpGeo.h>

Inheritance diagram for DumpGeo:

Collaboration diagram for DumpGeo:

Public Member Functions
	DumpGeo (const std::string &name, ISvcLocator *pSvcLocator) ATLAS_CTORDTOR_NOT_THREAD_SAFE
	~DumpGeo ()=default
StatusCode	initialize ()
StatusCode	execute ()
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< std::string >	m_atlasRelease {this, "AtlasRelease", "", "The current, in use Atlas release"}
Gaudi::Property< std::string >	m_detDescrTag {this, "AtlasVersion", "", "The current, in use Atlas Detector Description Geometry TAG"}
Gaudi::Property< std::string >	m_outFileName {this, "OutSQLiteFileName", "", "The name of the output SQLite file"}
Gaudi::Property< std::vector< std::string > >	m_user_filterDetManagersList { this, "UserFilterDetManager", {}, "Doc", "OrderedSet<T>"}
Gaudi::Property< bool >	m_showTreetopContent {this, "ShowTreetopContent", false, "Show the content of the Treetops; by default, only the list of Treetops is shown."}
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 34 of file DumpGeo.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ DumpGeo()

DumpGeo::DumpGeo	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 79 of file DumpGeo.cxx.

80 : AthAlgorithm(name, svcLocator) {}

AthAlgorithm::AthAlgorithm

AthAlgorithm()

Default constructor:

◆ ~DumpGeo()

DumpGeo::~DumpGeo ( )

default

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode DumpGeo::execute ( )

inline

Definition at line 41 of file DumpGeo.h.

41{return StatusCode::SUCCESS;};

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ initialize()

StatusCode DumpGeo::initialize ( )

Definition at line 83 of file DumpGeo.cxx.

                               {
  ATH_MSG_DEBUG("in initialize()");
 
  ATH_MSG_INFO("===================================================");
  ATH_MSG_INFO("\t\tLaunching DumpGeo");
  ATH_MSG_INFO("===================================================");
 
  ATH_MSG_INFO("Accessing the ATLAS geometry...");
  const GeoModelExperiment* theExpt = nullptr;
  ATH_CHECK(detStore()->retrieve(theExpt, "ATLAS"));
 
  // Get the ATLAS GEOMETRY 'World' volume
  PVConstLink world(theExpt->getPhysVol());
 
  ATH_MSG_INFO(
      "User filter DetectorManagers: " << m_user_filterDetManagersList);
 
  ServiceHandle<IGeoDbTagSvc> geoDbTag("GeoDbTagSvc", name());
  ATH_CHECK(geoDbTag.retrieve());
  ATH_MSG_INFO(
      "This is the Geometry TAG we are dumping: " << geoDbTag->atlasVersion());
 
  GeoPhysVol* volTop = createTheWorld();
 
  // Get list of managers
  // We fill a set from the output vector,
  // so we can use its built-in 'count' method later,
  // to search for DetManagers
  ATH_MSG_INFO("Dumping the GeoModel tree...");
  std::set<std::string> managersList{};
  {
    std::vector<std::string> blub = theExpt->getListOfManagers();
    managersList.insert(blub.begin(), blub.end());
  }
  if (msgLvl(MSG::INFO)) {
    ATH_MSG_INFO("List of the GeoModel Detector Managers that are being dumped: ");
    for (auto const& man : managersList) {
      // get the DetectorManager
      const GeoVDetectorManager* manager = theExpt->getManager(man);
      unsigned int nTreetops = manager->getNumTreeTops();
      std::cout << "\t" << man << " [contains " << nTreetops << " treetops]"
                << std::endl;
      for (unsigned int i = 0; i < nTreetops; ++i) {
        PVConstLink treetop(manager->getTreeTop(i));
        // get treetop's volume
        const GeoVPhysVol* vol = treetop;
        // get treetop's logvol's name
        std::string volName = vol->getLogVol()->getName();
        std::cout << "\t\t treetop: " << volName << std::endl;
      }
    }
  }
 
  if (!(m_user_filterDetManagersList.empty())) {
    // Convert the list of det managers passed by the user into a set
    std::set<std::string> user_managersList{};
    {
      user_managersList.insert(m_user_filterDetManagersList.begin(),
                               m_user_filterDetManagersList.end());
    }
    // safety check:
    // check that all DetManagers requested by the user are in the list
    // If not, print an error message to warn the user and return
    for (auto& userDet : user_managersList) {
      if (!managersList.count(userDet)) {
        ATH_MSG_FATAL(
            "This Detector Manager you requested to dump is not in the list of "
            "DetectorManagers for the geometry tag you are using: "
            << userDet);
        throw GaudiException(
            "The Detector Manager you requested to dump is not in the list of "
            "DetectorManagers.",
            "DumpGeo", StatusCode::FAILURE);
      }
    }
 
    if (!(managersList.empty())) {
      for (auto const& mm : managersList) {
        // get the DetectorManager
        const GeoVDetectorManager* manager = theExpt->getManager(mm);
 
        // get the name of the DetectorManager
        std::string detManName = manager->getName();
        ATH_MSG_INFO("\tDetectorManager: " << detManName);
 
        // get the DetManager's TreeTops
        unsigned int nTreetops = manager->getNumTreeTops();
        ATH_MSG_INFO("\t" << mm << " - # TreeTops: " << nTreetops);
 
        if ((nTreetops > 0) && user_managersList.count(detManName)) {
 
          for (unsigned int i = 0; i < nTreetops; ++i) {
 
            PVConstLink treetop(manager->getTreeTop(i));
 
            // get treetop's volume
            const GeoVPhysVol* vol = treetop;
 
            // get volume's transform
            // NOTE: we use getDefX() to get the transform without any alignment
            GeoTransform* volXf = new GeoTransform(vol->getDefX());
 
            // get volume's logvol's name
            std::string volName = vol->getLogVol()->getName();
            ATH_MSG_INFO("\t* treetop " << i << ": " << volName);
 
            // Add to the main volume a GeoNameTag with the name of the
            // DetectorManager
            volTop->add(new GeoNameTag(detManName));
            // add Transform and Volume to the main PhysVol
            volTop->add(volXf);
            volTop->add(const_cast<GeoVPhysVol*>(vol));
 
            if (m_showTreetopContent) {
                ATH_MSG_INFO("You enabled the option 'showTreetopContent', so we now print the content of the first layers of child volumes of the Treetops...");
                unsigned v1{0};
                GeoVolumeCursor av(treetop);
                while (!av.atEnd()) {
                    ++v1;
                    if(1==v1) ATH_MSG_INFO("first level of child volumes:");
                    ATH_MSG_INFO("\t\t- child's name: " << av.getName());
                    ATH_MSG_INFO("\t\t- child's n. sub-nodes: " << av.getVolume()->getNChildNodes());
                    ATH_MSG_INFO("\t\t- child's n. sub-volumes: " << av.getVolume()->getNChildVols());
 
 
                    unsigned v2{0};
                    GeoVolumeCursor av2(av.getVolume());
                    while (!av2.atEnd()) {
                        ++v2;
                        if(1==v2) ATH_MSG_INFO("second level of child volumes:");
                        ATH_MSG_INFO("\t\t\t- child's logvol's name: " << av2.getVolume()->getLogVol()->getName());
 
                        unsigned v3{0};
                        GeoVolumeCursor av3(av2.getVolume());
                        while (!av3.atEnd()) {
                            ++v3;
                            if(1==v3) ATH_MSG_INFO("third level of child volumes:");
                            ATH_MSG_INFO("\t\t\t\t- child's logvol's name: " << av3.getVolume()->getLogVol()->getName());
                            av3.next();  // increment volume cursor.
                        }             // end while
 
                        av2.next();  // increment volume cursor.
                    }             // end while
 
                    av.next();  // increment volume cursor.
                }             // end while
            }
          }
        }
      }
    }
  }
 
  // DEBUG inspection
  if (msgLvl(MSG::DEBUG)) {
    ATH_MSG_DEBUG(
        "Looping over top volumes in the GeoModel tree (children of the "
        "'World' volume)...");
    GeoVolumeCursor av(world);
    while (!av.atEnd()) {
      std::string volname = av.getName();
      ATH_MSG_DEBUG("\t* relevant NameTag:" << volname);
      av.next();  // increment volume cursor.
    }
  }
 
  ATH_MSG_INFO("Creating the SQLite DB file...");
  if (m_outFileName.empty()) {
    ATH_MSG_FATAL("The name of the output SQLite file is not set!");
    throw GaudiException("The name of the output SQLite file is not set!",
                         "DumpGeo", StatusCode::FAILURE);
  }
  ATH_MSG_INFO("Output file name: " << m_outFileName);
 
  // open the DB connection
  GMDBManager db(m_outFileName);
 
  // check the DB connection
  if (db.checkIsDBOpen())
    ATH_MSG_INFO("OK! Database is open!");
  else {
    ATH_MSG_ERROR(" ***** Database ERROR!! Exiting...");
    throw GaudiException(
        "The GeoModel SQLite .db file could not be opened successfully.",
        "DumpGeo", StatusCode::FAILURE);
  }
 
  ATH_MSG_INFO("Traversing the GeoModel tree...");
  // Dump the tree volumes into a DB
  // 1. init the GeoModel node action
  GeoModelIO::WriteGeoModel dumpGeoModelGraph(db);  
  // 2. visit all GeoModel nodes
  if (!(m_user_filterDetManagersList.empty())) {
    volTop->exec(&dumpGeoModelGraph);
  } else {
    world->exec(&dumpGeoModelGraph);
  }
  ATH_MSG_INFO("Saving the GeoModel tree to the DB...");
  // 3. save it to an SQLite file
  dumpGeoModelGraph.saveToDB(); 
  ATH_MSG_ALWAYS("DONE. Geometry saved to " << m_outFileName);
 
  // Quick test if DEBUG
  if (msgLvl(MSG::DEBUG)) {
    ATH_MSG_DEBUG(
        "Test - list of all the GeoMaterial nodes in the persistified "
        "geometry:");
    db.printAllMaterials();
    ATH_MSG_DEBUG(
        "Test - list of all the GeoElement nodes in the persistified "
        "geometry:");
    db.printAllElements();
  }
 
  ATH_MSG_DEBUG("End of DumpGeo::init().");
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg()

MsgStream & AthCommonMsg< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_atlasRelease

Gaudi::Property<std::string> DumpGeo::m_atlasRelease {this, "AtlasRelease", "", "The current, in use Atlas release"}

private

Definition at line 46 of file DumpGeo.h.

46{this, "AtlasRelease", "", "The current, in use Atlas release"};

◆ m_detDescrTag

Gaudi::Property<std::string> DumpGeo::m_detDescrTag {this, "AtlasVersion", "", "The current, in use Atlas Detector Description Geometry TAG"}

private

Definition at line 47 of file DumpGeo.h.

47{this, "AtlasVersion", "", "The current, in use Atlas Detector Description Geometry TAG"};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_outFileName

Gaudi::Property<std::string> DumpGeo::m_outFileName {this, "OutSQLiteFileName", "", "The name of the output SQLite file"}

private

Definition at line 48 of file DumpGeo.h.

48{this, "OutSQLiteFileName", "", "The name of the output SQLite file"};

◆ m_showTreetopContent

Gaudi::Property<bool> DumpGeo::m_showTreetopContent {this, "ShowTreetopContent", false, "Show the content of the Treetops; by default, only the list of Treetops is shown."}

private

Definition at line 51 of file DumpGeo.h.

51{this, "ShowTreetopContent", false, "Show the content of the Treetops; by default, only the list of Treetops is shown."};

◆ m_user_filterDetManagersList

Gaudi::Property<std::vector<std::string> > DumpGeo::m_user_filterDetManagersList { this, "UserFilterDetManager", {}, "Doc", "OrderedSet<T>"}

private

Definition at line 49 of file DumpGeo.h.

50{ this, "UserFilterDetManager", {}, "Doc", "OrderedSet<T>"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ DumpGeo()

◆ ~DumpGeo()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_atlasRelease

◆ m_detDescrTag

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_outFileName

◆ m_showTreetopContent

◆ m_user_filterDetManagersList

◆ m_varHandleArraysDeclared

◆ m_vhka