BmnFieldConst Class Reference

#include <BmnFieldConst.h>

Inheritance diagram for BmnFieldConst:

Collaboration diagram for BmnFieldConst:

Public Member Functions
	BmnFieldConst ()
	BmnFieldConst (const char *name, Double_t xMin, Double_t xMax, Double_t yMin, Double_t yMax, Double_t zMin, Double_t zMax, Double_t bX, Double_t bY, Double_t bZ)
	BmnFieldConst (BmnFieldPar *fieldPar)
virtual	~BmnFieldConst ()
void	FillParContainer ()
void	SetFieldRegion (Double_t xMin, Double_t xMax, Double_t yMin, Double_t yMax, Double_t zMin, Double_t zMax)
void	SetField (Double_t bX, Double_t bY, Double_t bZ)
void	SetFieldOff (Bool_t is_off=kTRUE)
virtual Double_t	GetBx (Double_t x, Double_t y, Double_t z)
virtual Double_t	GetBy (Double_t x, Double_t y, Double_t z)
virtual Double_t	GetBz (Double_t x, Double_t y, Double_t z)
Double_t	GetXmin () const
Double_t	GetXmax () const
Double_t	GetYmin () const
Double_t	GetYmax () const
Double_t	GetZmin () const
Double_t	GetZmax () const
Double_t	GetBx () const
Double_t	GetBy () const
Double_t	GetBz () const
Bool_t	IsFieldOff () const
virtual void	Print (Option_t *) const
	ClassDef (BmnFieldConst, 1)
	BmnFieldConst ()
	BmnFieldConst (const char *name, Double_t xMin, Double_t xMax, Double_t yMin, Double_t yMax, Double_t zMin, Double_t zMax, Double_t bX, Double_t bY, Double_t bZ)
	BmnFieldConst (BmnFieldPar *fieldPar)
virtual	~BmnFieldConst ()
void	FillParContainer ()
void	SetFieldRegion (Double_t xMin, Double_t xMax, Double_t yMin, Double_t yMax, Double_t zMin, Double_t zMax)
void	SetField (Double_t bX, Double_t bY, Double_t bZ)
void	SetFieldOff (Bool_t is_off=kTRUE)
virtual Double_t	GetBx (Double_t x, Double_t y, Double_t z)
virtual Double_t	GetBy (Double_t x, Double_t y, Double_t z)
virtual Double_t	GetBz (Double_t x, Double_t y, Double_t z)
Double_t	GetXmin () const
Double_t	GetXmax () const
Double_t	GetYmin () const
Double_t	GetYmax () const
Double_t	GetZmin () const
Double_t	GetZmax () const
Double_t	GetBx () const
Double_t	GetBy () const
Double_t	GetBz () const
Bool_t	IsFieldOff () const
virtual void	Print (Option_t *) const
	ClassDef (BmnFieldConst, 1)

Detailed Description

Definition at line 16 of file BmnFieldConst.h.

Constructor & Destructor Documentation

BmnFieldConst() [1/6]

BmnFieldConst::BmnFieldConst

(

)

Default constructor

Definition at line 25 of file BmnFieldConst.cxx.

BmnFieldConst() [2/6]

BmnFieldConst::BmnFieldConst	(	const char *	name,
		Double_t	xMin,
		Double_t	xMax,
		Double_t	yMin,
		Double_t	yMax,
		Double_t	zMin,
		Double_t	zMax,
		Double_t	bX,
		Double_t	bY,
		Double_t	bZ
	)

Standard constructor

Parameters

name	Object name
xMin,xMax	x region of field (global coordinates)
yMin,yMax	y region of field (global coordinates)
zMin,zMax	z region of field (global coordinates)
bX,bY,bZ	Field values [kG]

Definition at line 41 of file BmnFieldConst.cxx.

BmnFieldConst() [3/6]

BmnFieldConst::BmnFieldConst

(

BmnFieldPar *

fieldPar

)

Constructor from BmnFieldPar

Definition at line 67 of file BmnFieldConst.cxx.

References BmnFieldPar::GetBx(), BmnFieldPar::GetBy(), BmnFieldPar::GetBz(), BmnFieldPar::GetType(), BmnFieldPar::GetXmax(), BmnFieldPar::GetXmin(), BmnFieldPar::GetYmax(), BmnFieldPar::GetYmin(), BmnFieldPar::GetZmax(), BmnFieldPar::GetZmin(), and BmnFieldPar::IsFieldOff().

~BmnFieldConst() [1/2]

BmnFieldConst::~BmnFieldConst ( )

virtual

Destructor

Definition at line 98 of file BmnFieldConst.cxx.

BmnFieldConst() [4/6]

BmnFieldConst::BmnFieldConst

(

)

Default constructor

BmnFieldConst() [5/6]

BmnFieldConst::BmnFieldConst	(	const char *	name,
		Double_t	xMin,
		Double_t	xMax,
		Double_t	yMin,
		Double_t	yMax,
		Double_t	zMin,
		Double_t	zMax,
		Double_t	bX,
		Double_t	bY,
		Double_t	bZ
	)

Standard constructor

Parameters

name	Object name
xMin,xMax	x region of field (global coordinates)
yMin,yMax	y region of field (global coordinates)
zMin,zMax	z region of field (global coordinates)
bX,bY,bZ	Field values [kG]

BmnFieldConst() [6/6]

BmnFieldConst::BmnFieldConst

(

BmnFieldPar *

fieldPar

)

Constructor from BmnFieldPar

~BmnFieldConst() [2/2]

virtual BmnFieldConst::~BmnFieldConst ( )

virtual

Destructor

Member Function Documentation

ClassDef() [1/2]

BmnFieldConst::ClassDef	(	BmnFieldConst	,
		1
	)

ClassDef() [2/2]

BmnFieldConst::ClassDef	(	BmnFieldConst	,
		1
	)

FillParContainer() [1/2]

void BmnFieldConst::FillParContainer

(

)

Definition at line 164 of file BmnFieldConst.cxx.

References BmnFieldPar::SetParameters().

FillParContainer() [2/2]

void BmnFieldConst::FillParContainer

(

)

GetBx() [1/4]

Double_t BmnFieldConst::GetBx ( ) const

inline

Accessors to field values

Definition at line 79 of file BmnFieldConst.h.

GetBx() [2/4]

Double_t BmnFieldConst::GetBx ( ) const

inline

Accessors to field values

Definition at line 79 of file BmnFieldConst.h.

GetBx() [3/4]

Double_t BmnFieldConst::GetBx ( Double_t  x, Double_t  y, Double_t  z  )

virtual

Get components of field at a given point

Parameters

x,y,z

Point coordinates [cm]

Definition at line 124 of file BmnFieldConst.cxx.

Referenced by BmnFillDstTask::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

GetBx() [4/4]

virtual Double_t BmnFieldConst::GetBx ( Double_t  x, Double_t  y, Double_t  z  )

virtual

Get components of field at a given point

Parameters

x,y,z

Point coordinates [cm]

GetBy() [1/4]

Double_t BmnFieldConst::GetBy ( ) const

inline

Definition at line 80 of file BmnFieldConst.h.

GetBy() [2/4]

Double_t BmnFieldConst::GetBy ( ) const

inline

Definition at line 80 of file BmnFieldConst.h.

GetBy() [3/4]

Double_t BmnFieldConst::GetBy ( Double_t  x, Double_t  y, Double_t  z  )

virtual

Definition at line 132 of file BmnFieldConst.cxx.

Referenced by BmnFillDstTask::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

GetBy() [4/4]

virtual Double_t BmnFieldConst::GetBy ( Double_t  x, Double_t  y, Double_t  z  )

virtual

GetBz() [1/4]

Double_t BmnFieldConst::GetBz ( ) const

inline

Definition at line 81 of file BmnFieldConst.h.

GetBz() [2/4]

Double_t BmnFieldConst::GetBz ( ) const

inline

Definition at line 81 of file BmnFieldConst.h.

GetBz() [3/4]

Double_t BmnFieldConst::GetBz ( Double_t  x, Double_t  y, Double_t  z  )

virtual

Definition at line 140 of file BmnFieldConst.cxx.

Referenced by BmnFillDstTask::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

GetBz() [4/4]

virtual Double_t BmnFieldConst::GetBz ( Double_t  x, Double_t  y, Double_t  z  )

virtual

GetXmax() [1/2]

Double_t BmnFieldConst::GetXmax ( ) const

inline

Definition at line 72 of file BmnFieldConst.h.

Referenced by BmnFillDstTask::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

GetXmax() [2/2]

Double_t BmnFieldConst::GetXmax ( ) const

inline

Definition at line 72 of file BmnFieldConst.h.

GetXmin() [1/2]

Double_t BmnFieldConst::GetXmin ( ) const

inline

Accessors to field region

Definition at line 71 of file BmnFieldConst.h.

Referenced by BmnFillDstTask::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

GetXmin() [2/2]

Double_t BmnFieldConst::GetXmin ( ) const

inline

Accessors to field region

Definition at line 71 of file BmnFieldConst.h.

GetYmax() [1/2]

Double_t BmnFieldConst::GetYmax ( ) const

inline

Definition at line 74 of file BmnFieldConst.h.

Referenced by BmnFillDstTask::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

GetYmax() [2/2]

Double_t BmnFieldConst::GetYmax ( ) const

inline

Definition at line 74 of file BmnFieldConst.h.

GetYmin() [1/2]

Double_t BmnFieldConst::GetYmin ( ) const

inline

Definition at line 73 of file BmnFieldConst.h.

Referenced by BmnFillDstTask::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

GetYmin() [2/2]

Double_t BmnFieldConst::GetYmin ( ) const

inline

Definition at line 73 of file BmnFieldConst.h.

GetZmax() [1/2]

Double_t BmnFieldConst::GetZmax ( ) const

inline

Definition at line 76 of file BmnFieldConst.h.

Referenced by BmnMultiField::Init(), BmnFillDstTask::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

GetZmax() [2/2]

Double_t BmnFieldConst::GetZmax ( ) const

inline

Definition at line 76 of file BmnFieldConst.h.

GetZmin() [1/2]

Double_t BmnFieldConst::GetZmin ( ) const

inline

Definition at line 75 of file BmnFieldConst.h.

Referenced by BmnMultiField::Init(), BmnFillDstTask::Init(), BmnConstPar::SetParameters(), and BmnFieldPar::SetParameters().

GetZmin() [2/2]

Double_t BmnFieldConst::GetZmin ( ) const

inline

Definition at line 75 of file BmnFieldConst.h.

IsFieldOff() [1/2]

Bool_t BmnFieldConst::IsFieldOff ( ) const

inline

Whether magnetic field is off

Definition at line 84 of file BmnFieldConst.h.

Referenced by BmnFieldPar::SetParameters().

IsFieldOff() [2/2]

Bool_t BmnFieldConst::IsFieldOff ( ) const

inline

Whether magnetic field is off

Definition at line 84 of file BmnFieldConst.h.

Print() [1/2]

void BmnFieldConst::Print ( Option_t *  ) const

virtual

Screen output

Definition at line 148 of file BmnFieldConst.cxx.

Print() [2/2]

virtual void BmnFieldConst::Print ( Option_t *  ) const

virtual

Screen output

SetField() [1/2]

void BmnFieldConst::SetField	(	Double_t	bX,
		Double_t	bY,
		Double_t	bZ
	)

Set the field values

Parameters

bX,bY,bZ

Field values [kG]

Definition at line 115 of file BmnFieldConst.cxx.

SetField() [2/2]

void BmnFieldConst::SetField	(	Double_t	bX,
		Double_t	bY,
		Double_t	bZ
	)

Set the field values

Parameters

bX,bY,bZ

Field values [kG]

SetFieldOff() [1/2]

void BmnFieldConst::SetFieldOff ( Bool_t  is_off = kTRUE )

inline

Turn magnetic field off

Definition at line 61 of file BmnFieldConst.h.

SetFieldOff() [2/2]

void BmnFieldConst::SetFieldOff ( Bool_t  is_off = kTRUE )

inline

Turn magnetic field off

Definition at line 61 of file BmnFieldConst.h.

SetFieldRegion() [1/2]

void BmnFieldConst::SetFieldRegion	(	Double_t	xMin,
		Double_t	xMax,
		Double_t	yMin,
		Double_t	yMax,
		Double_t	zMin,
		Double_t	zMax
	)

Set the field region

Parameters

xMin,xMax	x region of field (global coordinates)
yMin,yMax	y region of field (global coordinates)
zMin,zMax	z region of field (global coordinates)

Definition at line 100 of file BmnFieldConst.cxx.

SetFieldRegion() [2/2]

void BmnFieldConst::SetFieldRegion	(	Double_t	xMin,
		Double_t	xMax,
		Double_t	yMin,
		Double_t	yMax,
		Double_t	zMin,
		Double_t	zMax
	)

Set the field region

Parameters

xMin,xMax	x region of field (global coordinates)
yMin,yMax	y region of field (global coordinates)
zMin,zMax	z region of field (global coordinates)

---

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

• field/BmnFieldConst.h
• install/include/BmnFieldConst.h
• field/BmnFieldConst.cxx