Element.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef MUONNSWASBUILT_ELEMENT_H
#define MUONNSWASBUILT_ELEMENT_H
 
#include <vector>
#include <map>
#include <memory>
 
#include "MuonNSWAsBuilt/ElementModel.h"
#include "GeoPrimitives/GeoPrimitives.h"
 
namespace NswAsBuilt {

   
  class Element {
    public:
      using ParameterVector = ElementModel::ParameterVector;
      using ipar_t = ElementModel::ipar_t;
      using daughterVec_t = std::vector<std::unique_ptr<Element>>;
      using VectorSetRef = ElementModel::VectorSetRef;
 
     /* ParameterClass: choose NOMINAL or CORRECTION parameters.
      *
      * The CORRECTION parameters are the ones which are actually measured,
      * while the NOMINAL parameters are the ones of the design */
      enum class ParameterClass {
        NOMINAL,
        CORRECTION
      };
 
     /* Constructors: pass a unique_ptr to the deformation model */
      Element(std::unique_ptr<ElementModel> deformationModel);
 
      // delete others
      Element() = delete;
      Element(const Element&) = delete;
      Element& operator=(const Element&) = delete;
 
     /* Getters and setters for the ElementModel parameters */
      double getParameter(ParameterClass iclass, ipar_t ipar) const;
      void setParameter(ParameterClass iclass, ipar_t ipar, double value);
      void setParametersFromMap(ParameterClass iclass, const std::map<std::string, double>& values);
 
     /* Transforms a set of vectors in local coordinates of this Element's
      * frame to the coordinates of the mother frame */
      void transform(ParameterClass iclass, const VectorSetRef& local) const;
      
     /* Repeatedly call the transform method using all mothers up to frame.
      * Set frame to nullptr to loop on all mothers. */
      void transformToFrame(ParameterClass iclass, const VectorSetRef& local, const Element* frame) const;
 
     /* Cache the rigid component of the transform, for quicker access */
      void cacheTransforms();
 
     /* asapId: optional string identifier (imported from ASAP) */
      void setAsapId(const std::string& asapId) { m_asapId = asapId; }
      const std::string& asapId() const { return m_asapId; }
 
     /* Getters and setters for the tree structure */
      Element* addDaughter(std::unique_ptr<Element> daughter);
      const Element* mother() const { return m_mother; }
            Element* mother()       { return m_mother; }
 
     /* Applies the callback function to this Element and to all its daughters
      * down to the leaves*/
      void traverseTree(const std::function<void(Element&)>& callback);
 
 
    private:
 
      ParameterVector& parameterVector(ParameterClass iclass);
      const ParameterVector& parameterVector(ParameterClass iclass) const;
 
      std::unique_ptr<ElementModel> m_deformationModel; // The deformation model
      ParameterVector m_nominalPar;   // The parameter vector for the NOMINAL class
      ParameterVector m_correctedPar; // The parameter vector for the CORRECTION class
 
      daughterVec_t m_daughters;      // The list of daughter Elements
      Element* m_mother{nullptr};    // The mother Element
 
      std::string m_asapId{""};           // Optional string identifier (imported from ASAP)
  };
}
 
#endif