Belle II Software  release-08-01-10
MagneticFieldComponentConstant Class Referencefinalabstract

Describe one component of the Geometry. More...

#include <MagneticFieldComponentConstant.h>

Inheritance diagram for MagneticFieldComponentConstant:
Collaboration diagram for MagneticFieldComponentConstant:

Public Member Functions

 MagneticFieldComponentConstant ()
 empty constructor for ROOT
 
 MagneticFieldComponentConstant (const ROOT::Math::XYZVector &field, float minR, float maxR, float minZ, float maxZ)
 full constructor More...
 
 MagneticFieldComponentConstant (const ROOT::Math::XYZVector &field)
 constructor for unlimited field
 
bool inside (const ROOT::Math::XYZVector &pos) const override
 return whether we are inside the active region for this component
 
ROOT::Math::XYZVector getField (__attribute((unused)) const ROOT::Math::XYZVector &pos) const override
 return the field assuming we are inside the active region as returned by inside()
 
void setExclusive (bool exclusive)
 set the state of the exclusive flag
 
bool isExclusive () const
 returns whether the field is set to exclusive mode
 
virtual ROOT::Math::XYZVector getField (const ROOT::Math::XYZVector &pos) const =0
 return the field at point pos
 
 ClassDef (MagneticFieldComponent, 1)
 ROOT Dictionary.
 

Private Member Functions

 ClassDefOverride (MagneticFieldComponentConstant, 2)
 ROOT dictionary.
 

Private Attributes

ROOT::Math::XYZVector m_field
 magnetic field strength
 
float m_minR {0}
 minimal R=sqrt(x^2+y^2) for which this field is present
 
float m_maxR {0}
 maximal R=sqrt(x^2+y^2) for which this field is present
 
float m_minZ {0}
 minimal Z for which this field is present
 
float m_maxZ {0}
 maximal Z for which this field is present
 
bool m_exclusive {false}
 whether or not the component is exclusive
 

Detailed Description

Describe one component of the Geometry.

Definition at line 19 of file MagneticFieldComponentConstant.h.

Constructor & Destructor Documentation

◆ MagneticFieldComponentConstant()

MagneticFieldComponentConstant ( const ROOT::Math::XYZVector &  field,
float  minR,
float  maxR,
float  minZ,
float  maxZ 
)
inline

full constructor

Parameters
fieldmagnetic field strength inside the defined region
minRminimal R=sqrt(x^2+y^2) for which this field is present
maxRmaximal R=sqrt(x^2+y^2) for which this field is present
minZminimal Z for which this field is present
maxZmaximal Z for which this field is present

Definition at line 30 of file MagneticFieldComponentConstant.h.

31  : MagneticFieldComponent(false),
32  m_field(field), m_minR(minR), m_maxR(maxR), m_minZ(minZ), m_maxZ(maxZ) {}
float m_maxR
maximal R=sqrt(x^2+y^2) for which this field is present
float m_maxZ
maximal Z for which this field is present
ROOT::Math::XYZVector m_field
magnetic field strength
float m_minZ
minimal Z for which this field is present
float m_minR
minimal R=sqrt(x^2+y^2) for which this field is present
MagneticFieldComponent(bool exclusive)
Constructor.

The documentation for this class was generated from the following file: