CbmLitField Class Reference

Interface for accessing the magnetic field. More...

#include <CbmLitField.h>

Inheritance diagram for CbmLitField:

Public Member Functions
	CbmLitField ()
	Constructor.
virtual	~CbmLitField ()
	Destructor.
virtual void	GetFieldValue (litfloat x, litfloat y, litfloat z, litfloat &Bx, litfloat &By, litfloat &Bz) const =0
	Return field value at (x,y,z) position.
virtual string	ToString () const

Detailed Description

Interface for accessing the magnetic field.

Author

Andrey Lebedev andre.nosp@m.y.le.nosp@m.bedev.nosp@m.@gsi.nosp@m..de

Date

2009

Definition at line 25 of file CbmLitField.h.

Constructor & Destructor Documentation

CbmLitField()

CbmLitField::CbmLitField ( )

inline

Constructor.

Definition at line 30 of file CbmLitField.h.

~CbmLitField()

virtual CbmLitField::~CbmLitField ( )

inlinevirtual

Destructor.

Definition at line 35 of file CbmLitField.h.

Member Function Documentation

GetFieldValue()

virtual void CbmLitField::GetFieldValue ( litfloat x, litfloat y, litfloat z, litfloat & Bx, litfloat & By, litfloat & Bz ) const

pure virtual

Return field value at (x,y,z) position.

Parameters

[in]	x	X coordinate [cm].
[in]	y	Y coordinate [cm].
[in]	z	Z coordinate [cm].
[out]	Bx	Output Bx field value [kGauss].
[out]	By	Output By field value [kGauss].
[out]	Bz	Output Bz field value [kGauss].

Implemented in CbmLitMapField.

References x, and y.

ToString()

virtual string CbmLitField::ToString ( ) const

inlinevirtual

Reimplemented in CbmLitMapField.

Definition at line 52 of file CbmLitField.h.

---

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

• CbmLitField.h