TRT_BaseElement.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/

 
#ifndef TRT_READOUTGEOMETRY_TRT_BASEELEMENT_H
#define TRT_READOUTGEOMETRY_TRT_BASEELEMENT_H
 
//include the Amg packages they include the Eigen plug-ins
#include "EventPrimitives/EventPrimitives.h"
#include "GeoPrimitives/GeoPrimitives.h"
 
#include "TrkSurfaces/Surface.h"
#include "TrkSurfaces/StraightLineSurface.h"
 
#include "TrkDetElementBase/TrkDetElementBase.h"
#include "InDetReadoutGeometry/SurfaceCache.h"
#include "Identifier/IdentifierHash.h"
#include "Identifier/Identifier.h"
 
#include "CLHEP/Geometry/Transform3D.h"
#include "CLHEP/Geometry/Point3D.h"
 
#include "CxxUtils/CachedUniquePtr.h"
#include "CxxUtils/CachedValue.h"
#include <vector>
 
class TRT_ID;
class GeoAlignmentStore;
 
namespace TRTCond {
  class StrawDxContainer;
}
 
namespace InDetDD {
 
  class SurfaceCacheBase;
  class SurfaceCache;
  class TRT_Conditions;

 
  class TRT_BaseElement : public Trk::TrkDetElementBase  {
 
  public:
 
    enum Type {BARREL, ENDCAP};

    TRT_BaseElement(const GeoVFullPhysVol* volume,
                    const Identifier& id,
                    const TRT_ID* idHelper,
                    const TRT_Conditions* conditions);
 
    TRT_BaseElement(const TRT_BaseElement& right);

    virtual ~TRT_BaseElement() = default;

    virtual TRT_BaseElement::Type type() const = 0;

    virtual Identifier identify() const override final;

    virtual IdentifierHash identifyHash() const override final;
 
    // --- GeoModel transformation forwards ----------------------------------------------------- //

    const GeoTrf::Transform3D& defTransform() const;

    const HepGeom::Transform3D getAbsoluteTransform(int straw) const;
 
    // ---- Surface & Tracking information cache ------------------------------------------------ //
    // (a) Element Surface section - accesses the m_surfaceCache store

    virtual const Trk::Surface& surface () const override final;

    virtual const Trk::SurfaceBounds& bounds() const override final;

    virtual const Amg::Transform3D& transform() const override final;

    virtual const Amg::Vector3D& center() const override final;

    virtual const Amg::Vector3D& normal() const override final;

    virtual Trk::DetectorElemType detectorType() const override final;
 
    // (b) Straw Surface section - accesses the vector<SurfaceCache> m_strawSurfacesCache store

    virtual const Trk::Surface& surface (const Identifier& id) const override final;

    const std::vector<const Trk::Surface*>& surfaces() const;

    virtual const Trk::SurfaceBounds& bounds(const Identifier& id) const override final;

    virtual const Amg::Transform3D& transform(const Identifier& id) const override final;

    const Amg::Transform3D& strawTransform(unsigned int straw) const;

 
    virtual const Amg::Vector3D& center(const Identifier& id) const override final;

    virtual const Amg::Vector3D& normal(const Identifier& id) const override final;

    const Trk::StraightLineSurface& strawSurface(int straw) const;

    const Amg::Transform3D& strawTransform(int straw) const;

    const Amg::Vector3D& strawCenter(int straw) const;

    Amg::Vector3D strawAxis(int straw) const;

    unsigned int nStraws() const;

    virtual const double& strawLength() const = 0;

    virtual int strawDirection() const = 0;

    void invalidate();

    void updateAllCaches(GeoAlignmentStore* alignStore=nullptr) const;

    const TRT_Conditions* conditions() const;
 
    void setDxContainer(const TRTCond::StrawDxContainer* dxContainer) {m_dxContainer=dxContainer;}

    virtual HepGeom::Transform3D calculateStrawTransform(int straw, GeoAlignmentStore* alignStore=nullptr) const = 0;

    virtual const Trk::SurfaceBounds&  strawBounds() const = 0;

    virtual const Trk::Surface&  elementSurface() const = 0;

    virtual void createSurfaceCache(GeoAlignmentStore* alignStore=nullptr) const = 0;

    void createSurfaceCache(Identifier id, GeoAlignmentStore* alignStore=nullptr) const;

    void invalidateOther() const {};
 
  private:

    const TRT_BaseElement& operator=(const TRT_BaseElement&right);
    void deleteCache();
    std::unique_ptr<SurfaceCacheBase> createSurfaceCacheHelper(int straw, GeoAlignmentStore* alignStore=nullptr) const;
 
  protected:
    Identifier                                          m_id;
    IdentifierHash                                      m_idHash;
    /*
     * The number of straws and the vector below need to
     * initialosed in the derived constructors for now.
     * This should fine as this is pure virtual class
     */
    unsigned int m_nstraws = 0;
    const TRT_ID*                                       m_idHelper=nullptr;
    const TRT_Conditions*                               m_conditions=nullptr;
    const TRTCond::StrawDxContainer*                    m_dxContainer=nullptr;
    CxxUtils::CachedUniquePtr<Trk::Surface> m_surface;
   // Amg cache for the straw surfaces
    std::vector<CxxUtils::CachedUniquePtr<Trk::StraightLineSurface>> m_strawSurfaces{};
    std::vector<CxxUtils::CachedUniquePtr<SurfaceCacheBase>> m_strawSurfacesCache{};
    CxxUtils::CachedValue<std::vector<const Trk::Surface*>> m_surfaces;
    CxxUtils::CachedValue<SurfaceCache> m_surfaceCache;
 
    // Helper function for the use by derived classes
    const Amg::Vector3D& center(const Identifier& id, GeoAlignmentStore* alignStore) const;
  };
 
}
#include "TRT_ReadoutGeometry/TRT_BaseElement.icc"
#endif