CbmRoot
Public Member Functions | List of all members
CbmLitField Class Referenceabstract

Interface for accessing the magnetic field. More...

#include <CbmLitField.h>

Inheritance diagram for CbmLitField:
[legend]

Public Member Functions

 CbmLitField ()
 Constructor. More...
 
virtual ~CbmLitField ()
 Destructor. More...
 
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. More...
 
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 20 of file CbmLitField.h.

Constructor & Destructor Documentation

◆ CbmLitField()

CbmLitField::CbmLitField ( )
inline

Constructor.

Definition at line 25 of file CbmLitField.h.

◆ ~CbmLitField()

virtual CbmLitField::~CbmLitField ( )
inlinevirtual

Destructor.

Definition at line 30 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]xX coordinate [cm].
[in]yY coordinate [cm].
[in]zZ coordinate [cm].
[out]BxOutput Bx field value [kGauss].
[out]ByOutput By field value [kGauss].
[out]BzOutput Bz field value [kGauss].

Implemented in CbmLitMapField.

◆ 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: