Class Reference for E1039 Core & Analysis Software
PHFieldConfig.h
Go to the documentation of this file.
1 // $Id: $
2 
11 #ifndef PHFieldConfig_H_
12 #define PHFieldConfig_H_
13 
14 #include <phool/PHObject.h>
15 #include <string>
16 
19 class PHFieldConfig : public PHObject
20 {
21  public:
22  virtual ~PHFieldConfig();
23 
27  virtual void
28  identify(std::ostream& os = std::cout) const;
29 
31  virtual void
32  Reset();
33 
35  virtual int
36  isValid() const;
37 
39  {
43  kField2D = 2,
52 
54  kFieldInvalid = 9999
55  };
56 
57  virtual FieldConfigTypes get_field_config() const;
58 
59  std::string get_field_config_description() const;
60 
61  virtual void set_field_config(FieldConfigTypes fieldConfig);
62 
63  virtual const std::string & get_filename() const;
64 
65  virtual void set_filename(const std::string& filename);
66 
67  virtual double get_magfield_rescale() const;
68 
69  virtual void set_magfield_rescale(double magfieldRescale);
70 
72  virtual double get_field_mag_x() const;
73 
75  virtual void set_field_mag_x(double fieldMagX);
76 
78  virtual double get_field_mag_y() const;
79 
81  virtual void set_field_mag_y(double fieldMagY);
82 
84  virtual double get_field_mag_z() const;
86  virtual void set_field_mag_z(double fieldMagZ);
87 
89 
91 
93  virtual const std::string & get_filename1() const {return kInvalid_FileName;}
94  virtual const std::string & get_filename2() const {return kInvalid_FileName;}
95 
96  virtual double get_magfield_rescale1() const;
97  virtual double get_magfield_rescale2() const;
98 
99  virtual void set_taregetmag_y(double fieldMagX);
100  virtual double get_taregetmag_y() const;
101 
102  protected:
104  PHFieldConfig();
105 
106  static const std::string kInvalid_FileName;
107 
108  ClassDef(PHFieldConfig, 1)
109 };
110 
111 #endif /* PHFieldConfig_H_ */
PHFieldConfig store field configuration information.
Definition: PHFieldConfig.h:20
virtual double get_taregetmag_y() const
field value in Tesla for target field model ONLY for PHFieldConfig_v3
@ kFieldUniform
Constant field.
Definition: PHFieldConfig.h:41
@ kField2D
2D field map expressed in cylindrical coordinates
Definition: PHFieldConfig.h:43
@ kField3DCartesian
3D field map expressed in Cartesian coordinates
Definition: PHFieldConfig.h:47
@ kField3DCylindrical
3D field map expressed in cylindrical coordinates
Definition: PHFieldConfig.h:45
@ kFieldInvalid
invalid value
Definition: PHFieldConfig.h:54
std::string get_field_config_description() const
virtual void identify(std::ostream &os=std::cout) const
virtual void set_field_mag_z(double fieldMagZ)
field value in Tesla for uniform field model ONLY for PHFieldConfig_v2
virtual double get_magfield_rescale1() const
field value in Tesla for uniform field model ONLY for PHFieldConfig_v3
virtual void set_magfield_rescale(double magfieldRescale)
virtual void Reset()
Clear Event.
virtual void set_field_mag_x(double fieldMagX)
field value in Tesla for uniform field model ONLY for PHFieldConfig_v2
virtual double get_field_mag_x() const
field value in Tesla for uniform field model ONLY for PHFieldConfig_v2
virtual double get_field_mag_z() const
field value in Tesla for uniform field model ONLY for PHFieldConfig_v2
virtual FieldConfigTypes get_field_config() const
virtual double get_magfield_rescale() const
virtual void set_filename(const std::string &filename)
virtual const std::string & get_filename2() const
Definition: PHFieldConfig.h:94
PHFieldConfig()
pure virtual interface class. not for direct use
virtual const std::string & get_filename() const
virtual ~PHFieldConfig()
virtual const std::string & get_filename1() const
field value in Tesla for target field model ONLY for PHFieldConfig_v3
Definition: PHFieldConfig.h:93
virtual double get_magfield_rescale2() const
field value in Tesla for uniform field model ONLY for PHFieldConfig_v3
virtual void set_field_config(FieldConfigTypes fieldConfig)
virtual double get_field_mag_y() const
field value in Tesla for uniform field model ONLY for PHFieldConfig_v2
virtual void set_taregetmag_y(double fieldMagX)
field value in Tesla for target field model ONLY for PHFieldConfig_v3
virtual int isValid() const
isValid returns non zero if object contains vailid data
virtual void set_field_mag_y(double fieldMagY)
field value in Tesla for uniform field model ONLY for PHFieldConfig_v2
static const std::string kInvalid_FileName