ITrackingVolumeHelper.h

Go to the documentation of this file.

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

// ITrackingVolumeHelper.h, (c) ATLAS Detector software
 
#ifndef TRKDETDESCRINTERFACES_ITRACKINGVOLUMEHELPER_H
#define TRKDETDESCRINTERFACES_ITRACKINGVOLUMEHELPER_H
 
// Gaudi
#include "GaudiKernel/IAlgTool.h"
// Trk - template classes & enums
#include "GeoPrimitives/GeoPrimitives.h"
#include "TrkDetDescrUtils/BinnedArray.h"
#include "TrkDetDescrUtils/BinningType.h"
#include "TrkVolumes/BoundarySurface.h"
#include "TrkVolumes/BoundarySurfaceFace.h"
// STL
#include <string>
#include <memory>
 
#include "CxxUtils/checker_macros.h"
namespace Trk {
 
class VolumeBounds;
class CylinderVolumeBounds;
class Material;
class Layer;
class TrackingVolume;

class ITrackingVolumeHelper : virtual public IAlgTool
{
 
public:
  DeclareInterfaceID(ITrackingVolumeHelper, 1, 0);

  virtual ~ITrackingVolumeHelper() = default;
  virtual void glueTrackingVolumes(TrackingVolume& firstVol,
                                   BoundarySurfaceFace firstFace,
                                   TrackingVolume& secondVol,
                                   BoundarySurfaceFace secondFace,
                                   bool buildBoundaryLayer = false) const = 0;

  virtual void glueTrackingVolumes(
    TrackingVolume& firstVol,
    BoundarySurfaceFace firstFace,
    const std::vector<TrackingVolume*>& secondVolumes,
    BoundarySurfaceFace secondFace,
    bool buildBoundaryLayer = false,
    bool boundaryFaceExchange = false) const = 0;

  virtual void glueTrackingVolumes(
    const std::vector<TrackingVolume*>& firstVolumes,
    BoundarySurfaceFace firstFace,
    const std::vector<TrackingVolume*>& secondVolumes,
    BoundarySurfaceFace secondFace,
    bool buildBoundaryLayer = false,
    bool boundaryFaceExchange = false) const = 0;

  virtual std::unique_ptr<Trk::TrackingVolume> glueTrackingVolumeArrays(
      std::shared_ptr<TrackingVolume> firstVol,
      BoundarySurfaceFace firstFace,
      std::shared_ptr<TrackingVolume> secondVol,
      BoundarySurfaceFace secondFace,
      const std::string& name) const = 0;

  virtual void setInsideTrackingVolume(TrackingVolume& tvol,
                                       BoundarySurfaceFace face,
                                       TrackingVolume* insidevol) const = 0;
  virtual void setInsideTrackingVolumeArray(
    TrackingVolume& tvol,
    BoundarySurfaceFace face,
    std::shared_ptr<BinnedArray<TrackingVolume>> insidevolarray) const = 0;

  virtual void setOutsideTrackingVolume(TrackingVolume& tvol,
                                        BoundarySurfaceFace face,
                                        TrackingVolume* outsidevol) const = 0;

  virtual void setOutsideTrackingVolumeArray(
    TrackingVolume& tvol,
    BoundarySurfaceFace face,
    std::shared_ptr<BinnedArray<TrackingVolume>> outsidevolarray) const = 0;
 
protected:
  void associateLayer(const Layer& lay, Surface& sf) const
  {
    sf.associateLayer(lay);
  }
};
 
} // end of namespace
 
#endif // TRKDETDESCRINTERFACES_IITRACKINGVOLUMEHELPER_H