include/Plugins/BFieldPlugin.h

0001 /**
0002  *  @file   PandoraSDK/include/Plugins/BFieldPlugin.h
0003  *
0004  *  @brief  Header file for the bfield plugin interface class.
0005  *
0006  *  $Log: $
0007  */
0008 #ifndef PANDORA_BFIELD_PLUGIN_H
0009 #define PANDORA_BFIELD_PLUGIN_H 1
0010
0011 #include "Pandora/PandoraInternal.h"
0012 #include "Pandora/Process.h"
0013
0014 namespace pandora
0015 {
0016
0017 /**
0018  *  @brief  BFieldPlugin class
0019  */
0020 class BFieldPlugin : public Process
0021 {
0022 public:
0023     /**
0024      *  @brief  Get the bfield value for a specified position vector
0025      *
0026      *  @param  positionVector the specified position
0027      *
0028      *  @return the bfield, units Tesla
0029      */
0030     virtual float GetBField(const CartesianVector &positionVector) const = 0;
0031
0032 protected:
0033     friend class PluginManager;
0034 };
0035
0036 } // namespace pandora
0037
0038 #endif // #ifndef PANDORA_BFIELD_PLUGIN_H