IAlignModuleTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRKALIGNINTERFACES_ALIGNMODULETOOL_IH
#define TRKALIGNINTERFACES_ALIGNMODULETOOL_IH
 
#include "GaudiKernel/IAlgTool.h"
#include "GaudiKernel/ToolHandle.h"
#include "AthContainers/DataVector.h"
 
#include "TrkAlignEvent/AlignModuleList.h"
#include "TrkAlignEvent/AlignModule.h"
#include "TrkAlignEvent/AlignPar.h"
 
#include <fstream>

 
namespace Trk {
  class Track;
  class AlignTrack;
  class AlignTSOS;
  class RIO_OnTrack;
 
  static const InterfaceID 
    IID_TRKALIGNINTERFACES_IAlignModuleTool("Trk::IAlignModuleTool",1,0);
  
  
  class IAlignModuleTool: virtual public IAlgTool {
   
  public:
    static const InterfaceID& interfaceID();
    
    virtual ~IAlignModuleTool() {};
 
    virtual StatusCode initialize() = 0;
    virtual StatusCode finalize() = 0;

    virtual AlignModuleListType alignModuleListType() const = 0;

    virtual AlignModule::DetectorType getDetectorType(const TrkDetElementBase* det) const = 0;    
 
    //    
    // GeometryManagerTool methods
    //

    virtual void setAlignModules(AlignModuleList* alignmods,
                 std::vector<AlignModuleList*>* idHashToAlignModMap) = 0;
    
    virtual void setAlignParLists(DataVector<DataVector<AlignPar> >* fullAlignParList, 
                  DataVector<DataVector<AlignPar> >* alignParList) = 0;
    
    virtual void setSubDetElement(AlignModule::DetectorType detType, bool status) = 0;
    virtual bool subDetElement(AlignModule::DetectorType detType) const = 0;
 
    //
    // AlignTrackCreator methods
    //

    virtual AlignModule * findAlignModule(const RIO_OnTrack * rio,
                                          AlignModule::DetectorType = AlignModule::NDetectorTypes) const = 0;

    virtual AlignModule * findAlignModule(const TrkDetElementBase* det,
                                          AlignModule::DetectorType = AlignModule::NDetectorTypes) const = 0;

    virtual void setMeasurementProperties(AlignTSOS *) const {};
 
    //    
    // MatrixTool methods
    //

    virtual int nAlignParameters() const = 0;
    
    virtual const AlignModuleList* alignModules1D() = 0;
    virtual DataVector<AlignPar>*  alignParList1D() = 0;
    
 
    // DerivCalcTool methods

    virtual DataVector<AlignPar>* getAlignPars(const AlignModule* alignModule) const = 0; 

    virtual void shiftModule(const AlignModule*, const Track*, 
                 AlignModule::TransformParameters, double) const {}              
    virtual void restoreModule(const AlignModule*) const {}   
 
 
    //
    // AlignDBTool methods
    // 
 
    virtual void fillDetAlignmentParameters(const TrkDetElementBase* det,
                        DataVector<AlignPar>* apVec,
                        AlignModule::DetectorType detType=
                        AlignModule::NDetectorTypes) const = 0;

    virtual const AlignModuleList* getAlignModuleCollection() const = 0;
 
 
    //
    // FillNtuple methods
    //

    virtual DataVector<AlignPar>* getFullAlignPars(const AlignModule* alignModule) const = 0;
 
    //
    // Other
    //

    virtual void setLogStream(std::ostream * os) { m_logStream = os; }
 
  protected:
 
    std::ostream * m_logStream = nullptr; 
 
  };
 
  inline const InterfaceID& IAlignModuleTool::interfaceID()
  { return   IID_TRKALIGNINTERFACES_IAlignModuleTool; }
  
} // end namespace
  
#endif // TRKALIGNINTERFACES_ALIGNMODULETOOL_IH