VolumeManager.h

Go to the documentation of this file.

//==========================================================================
//  AIDA Detector description implementation for LCD
//--------------------------------------------------------------------------
// Copyright (C) Organisation europeenne pour la Recherche nucleaire (CERN)
// All rights reserved.
//
// For the licensing terms see $DD4hepINSTALL/LICENSE.
// For the list of contributors see $DD4hepINSTALL/doc/CREDITS.
//
// Author     : M.Frank
//
//==========================================================================

#ifndef DD4hep_GEOMETRY_VOLUMEMANAGER_H
#define DD4hep_GEOMETRY_VOLUMEMANAGER_H

// Framework include files
#include "DD4hep/Volumes.h"
#include "DD4hep/Detector.h"
#include "DD4hep/NamedObject.h"
#include "DD4hep/IDDescriptor.h"

// ROOT include files
#include "TGeoMatrix.h"


namespace DD4hep {

  namespace Geometry {

    // Forward declarations
    class LCDD;
    class VolumeManagerContext;
    class VolumeManagerObject;


    class VolumeManager: public Handle<VolumeManagerObject> {
    public:
      typedef DD4hep::VolumeID VolumeID;
      typedef VolumeID VolIdentifier;
      // Creation flags
      enum PopulateFlags {
        NONE = 0,
        TREE = 1 << 1,   // Build 1 level DetElement hierarchy while populating
        ONE = 1 << 2,    // Populate all daughter volumes into one big lookup-container
        // This flag may be in parallel with 'TREE'
        LAST
      };

      typedef VolumeManagerObject Object;
      typedef VolumeManagerContext Context;
      typedef std::map<VolumeID, VolumeManager> Managers;
      typedef std::map<DetElement, VolumeManager> Detectors;
      typedef std::map<VolumeID, VolumeManagerContext*> Volumes;
      typedef PlacedVolume::VolIDs VolIDs;
      typedef std::map<TGeoNode*, Context*> PhysVolumes;

    protected:
      Object& _data() const {
        return *(Object*) ptr();
      }

    public:
      VolumeManager()
        : Handle<VolumeManagerObject>() {
      }
      VolumeManager(const VolumeManager& e)
        : Handle<VolumeManagerObject>(e) {
      }
#ifndef __CINT__
      VolumeManager(const Handle<VolumeManagerObject>& e)
        : Handle<VolumeManagerObject>(e) {
      }
#endif
      template <typename Q> VolumeManager(const Handle<Q>& e)
        : Handle<VolumeManagerObject>(e) {
      }
      VolumeManager(LCDD& lcdd, const std::string& name, DetElement world = DetElement(), Readout ro = Readout(), int flags =
                    NONE);
      VolumeManager(DetElement subdetector, Readout ro);

      VolumeManager& operator=(const VolumeManager& m)  {
        if ( this != &m ) m_element = m.m_element;
        return *this;
      }
      VolumeManager addSubdetector(DetElement detector, Readout ro);
      VolumeManager subdetector(VolumeID id) const;

      DetElement detector() const;
      IDDescriptor idSpec() const;

      bool adoptPlacement(Context* context);
      bool adoptPlacement(VolumeID volume_id, Context* context);

      Context* lookupContext(VolumeID volume_id) const;
      PlacedVolume lookupPlacement(VolumeID volume_id) const;
      DetElement lookupDetector(VolumeID volume_id) const;
      DetElement lookupDetElement(VolumeID volume_id) const;
      const TGeoMatrix& worldTransformation(VolumeID volume_id) const;
    };

    std::ostream& operator<<(std::ostream& os, const VolumeManager& m);

  } /* End namespace Geometry               */
} /* End namespace DD4hep                */
#endif    /* DD4hep_GEOMETRY_READOUT_H           */