UniformMagneticField Class Reference

#include <UniformMagneticField.h>

Inheritance diagram for UniformMagneticField:

Public Member Functions
GlobalVector	inTesla (const GlobalPoint &) const override
	Field value ad specified global point, in Tesla. More...
GlobalVector	inTeslaUnchecked (const GlobalPoint &gp) const override
bool	isDefined (const GlobalPoint &gp) const override
	True if the point is within the region where the concrete field. More...
void	set (GlobalVector value)
void	set (float value)
	UniformMagneticField (float value)
	Construct passing the Z field component in Tesla. More...
	UniformMagneticField (GlobalVector value)
	~UniformMagneticField () override
Public Member Functions inherited from MagneticField
virtual MagneticField *	clone () const
GlobalVector	inInverseGeV (const GlobalPoint &gp) const
	Field value ad specified global point, in 1/Gev. More...
GlobalVector	inKGauss (const GlobalPoint &gp) const
	Field value ad specified global point, in KGauss. More...
float	inverseBzAtOriginInGeV () const
	The inverse of field z component for this map in GeV. More...
	MagneticField ()
	MagneticField (const MagneticField &orig)
int	nominalValue () const
	The nominal field value for this map in kGauss. More...
virtual	~MagneticField ()

Private Attributes
GlobalVector	theField

Additional Inherited Members
Protected Member Functions inherited from MagneticField
void	setNominalValue ()

Detailed Description

A MagneticField engine that returns a constant programmable field value.

Author

N. Amapane - CERN

Definition at line 13 of file UniformMagneticField.h.

Constructor & Destructor Documentation

UniformMagneticField() [1/2]

UniformMagneticField::UniformMagneticField ( float  value )

inline

Construct passing the Z field component in Tesla.

Definition at line 16 of file UniformMagneticField.h.

References MagneticField::setNominalValue().

: theField(0.f, 0.f, value) { setNominalValue(); }

UniformMagneticField() [2/2]

UniformMagneticField::UniformMagneticField ( GlobalVector  value )

inline

Definition at line 18 of file UniformMagneticField.h.

References MagneticField::setNominalValue().

: theField(value) { setNominalValue(); }

~UniformMagneticField()

UniformMagneticField::~UniformMagneticField ( )

inlineoverride

Definition at line 23 of file UniformMagneticField.h.

{}

Member Function Documentation

inTesla()

GlobalVector UniformMagneticField::inTesla ( const GlobalPoint &  gp ) const

inlineoverridevirtual

Field value ad specified global point, in Tesla.

Implements MagneticField.

Definition at line 25 of file UniformMagneticField.h.

References theField.

{ return theField; }

inTeslaUnchecked()

GlobalVector UniformMagneticField::inTeslaUnchecked ( const GlobalPoint &  gp ) const

inlineoverridevirtual

Optional implementation that derived classes can implement to provide faster query by skipping the check to isDefined.

Reimplemented from MagneticField.

Definition at line 27 of file UniformMagneticField.h.

References theField.

{ return theField; }

isDefined()

bool UniformMagneticField::isDefined ( const GlobalPoint &  ) const

inlineoverridevirtual

True if the point is within the region where the concrete field.

Reimplemented from MagneticField.

Definition at line 29 of file UniformMagneticField.h.

{ return true; }

set() [1/2]

void UniformMagneticField::set ( GlobalVector  value )

inline

Definition at line 20 of file UniformMagneticField.h.

References theField, and relativeConstraints::value.

Referenced by MultiHitGeneratorFromChi2::initES().

{ theField = value; }

set() [2/2]

void UniformMagneticField::set ( float  value )

inline

Definition at line 21 of file UniformMagneticField.h.

References f.

{ set(GlobalVector(0.f, 0.f, value)); }

Member Data Documentation

theField

GlobalVector UniformMagneticField::theField

private

Definition at line 32 of file UniformMagneticField.h.

Referenced by inTesla(), inTeslaUnchecked(), and set().