VolumeBuilder.h

Go to the documentation of this file.

//==========================================================================
//  AIDA Detector description implementation 
//--------------------------------------------------------------------------
// 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 XML_VOLUMEBUILDER_H
#define XML_VOLUMEBUILDER_H
 
// Framework include files
#include <XML/XMLElements.h>
#include <XML/XMLDetector.h>
#include <DD4hep/Detector.h>
 
// C/C++ include files
#include <set>
#include <map>
#include <memory>
 
namespace dd4hep {
 
  namespace xml {
 
    namespace tools  {
 
 
      class VolumeBuilder   {
      public:        
        typedef ::dd4hep::DetElement DetElement;
        typedef ::dd4hep::xml::DetElement xml_det_h;
        typedef std::map<std::string,std::pair<Handle_t,Solid> >       Shapes;
        typedef std::map<std::string,std::pair<Handle_t,Volume> >      Volumes;
        typedef std::map<std::string,Material>                         Materials;
        typedef std::map<std::string,std::pair<Handle_t,Transform3D> > Transformations;
        std::map<std::string, std::unique_ptr<xml::DocumentHolder> > included_docs;
        Detector&             description;
        xml_det_h             x_det;
        int                   id = -1;
        std::string           name;
        DetElement            detector;
        SensitiveDetector     sensitive;
        DetectorBuildType     buildType;
        Shapes                shapes;
        Volumes               volumes;
        Materials             materials;
        Transformations       transformations;
        std::set<std::string> shape_veto, vol_veto;
        bool                  debug = false;
 
      protected:
        void _placeSingleVolume(DetElement de, Volume vol, Handle_t c);
        void _placeParamVolumes(DetElement de, Volume vol, Handle_t c);
 
      public:
        VolumeBuilder() = delete;
        VolumeBuilder(VolumeBuilder&& copy) = delete;
        VolumeBuilder(const VolumeBuilder& copy) = delete;
        VolumeBuilder(Detector& dsc,
                      Handle_t x_parent,
                      SensitiveDetector sd=SensitiveDetector());
        virtual ~VolumeBuilder() {}
        VolumeBuilder& operator=(VolumeBuilder&& copy) = delete;
        VolumeBuilder& operator=(const VolumeBuilder& copy) = delete;
 
        size_t collectMaterials(Handle_t element);
        
        Transform3D getTransform(const std::string& nam)  const;
        Solid getShape(const std::string& nam)  const;
        Solid makeShape(Handle_t handle);
        Volume volume(const std::string& nam)  const;
        void registerShape(const std::string& nam, Solid shape);
        void registerVolume(const std::string& nam, Volume volume);
        size_t buildShapes(Handle_t handle);
        size_t buildVolumes(Handle_t handle);
        size_t buildTransformations(Handle_t handle);
        size_t load(Handle_t element, const std::string& tag);
        VolumeBuilder& placeDaughters(Volume vol, Handle_t handle);
        VolumeBuilder& placeDaughters(DetElement parent, Volume vol, Handle_t handle);
        PlacedVolume placeDetector(Volume vol);
        PlacedVolume placeDetector(Volume vol, Handle_t handle);
      };
    }     /* End namespace tools            */    
  }       /* End namespace xml              */
}         /* End namespace dd4hep           */
#endif // XML_VOLUMEBUILDER_H