IMagneticFieldSvc.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2019 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#ifndef GAUDIKERNEL_IMAGNETICFIELDSVC_H
#define GAUDIKERNEL_IMAGNETICFIELDSVC_H

// Include files
#include "GaudiKernel/IService.h"
#include "GaudiKernel/StatusCode.h"

// Forward declarations
namespace ROOT {
  namespace Math {
    class DefaultCoordinateSystemTag;

    // from Math/Point3Dfwd.h
    template <class CoordSystem, class Tag>
    class PositionVector3D;
    // from Math/Vector3Dfwd.h
    template <class CoordSystem, class Tag>
    class DisplacementVector3D;
    // from Math/Point3Dfwd.h
    template <typename T>
    class Cartesian3D;
    // from Math/Point3Dfwd.h
    typedef PositionVector3D<Cartesian3D<double>, DefaultCoordinateSystemTag> XYZPoint;
    // from Math/Vector3Dfwd.h
    typedef DisplacementVector3D<Cartesian3D<double>, DefaultCoordinateSystemTag> XYZVector;
  } // namespace Math
} // namespace ROOT

class GAUDI_API IMagneticFieldSvc : virtual public IService {

public:
  DeclareInterfaceID( IMagneticFieldSvc, 2, 0 );

  // Get the magnetic field vector at a given point in space.
  // Input: XYZPoint - Point at which magnetic field vector is to be given.
  // Output: XYZVector - Magnetic field vector.
  // Return: StatusCode SUCCESS if calculation was performed.
  virtual StatusCode fieldVector( const ROOT::Math::XYZPoint& xyz, ROOT::Math::XYZVector& fvec ) const = 0;
};

#endif // GAUDIKERNEL_IMAGNETICFIELDSVC_H