MagneticFieldProperties.h

Go to the documentation of this file.

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

// MagneticFieldProperties.h, (c) ATLAS Detector software
 
#ifndef TRKGEOMETRY_MAGNETICFIELDPROPERTIES_H
#define TRKGEOMETRY_MAGNETICFIELDPROPERTIES_H
 
// Gaudi
#include "GaudiKernel/GaudiException.h"
#include "GaudiKernel/MsgStream.h"
// Trk
#include "TrkGeometry/MagneticFieldMode.h"
// Amg
#include "GeoPrimitives/GeoPrimitives.h"
// STD
#include <iostream>
 
namespace Trk {

class MagneticFieldProperties
{
 
public:
  MagneticFieldProperties(MagneticFieldMode mode = Trk::FullField);
  MagneticFieldProperties(const Amg::Vector3D& field);
  // default copy/move/dtor
  MagneticFieldProperties(const MagneticFieldProperties&) = default;
  MagneticFieldProperties(MagneticFieldProperties&&) = default;
  MagneticFieldProperties& operator=(const MagneticFieldProperties&) = default;
  MagneticFieldProperties& operator=(MagneticFieldProperties&&) = default;
  ~MagneticFieldProperties() = default;

  operator MagneticFieldMode() const;

  MagneticFieldMode magneticFieldMode() const;

  const Amg::Vector3D& magneticField() const;
 
protected:
  MagneticFieldMode m_magneticFieldMode;
  Amg::Vector3D m_magneticField;
};

MsgStream&
operator<<(MsgStream& sl, const MagneticFieldProperties& mprop);
 
std::ostream&
operator<<(std::ostream& sl, const MagneticFieldProperties& mprop);
 
} // end of namespace
#include "TrkGeometry/MagneticFieldProperties.icc"
#endif // TRKGEOMETRY_MAGNETICFIELDPROPERTIES_H