Trk::MagneticFieldProperties Class Reference

magnetic field properties to steer the behavior of the extrapolation More...

#include <MagneticFieldProperties.h>

Collaboration diagram for Trk::MagneticFieldProperties:

Public Member Functions
	MagneticFieldProperties (MagneticFieldMode mode=Trk::FullField)
	Constructor for magnetic field mode - full field is default.
	MagneticFieldProperties (const Amg::Vector3D &field)
	Constructor for magnetic field mode.
	MagneticFieldProperties (const MagneticFieldProperties &)=default
	MagneticFieldProperties (MagneticFieldProperties &&)=default
MagneticFieldProperties &	operator= (const MagneticFieldProperties &)=default
MagneticFieldProperties &	operator= (MagneticFieldProperties &&)=default
	~MagneticFieldProperties ()=default
	operator MagneticFieldMode () const
	Cast operator.
MagneticFieldMode	magneticFieldMode () const
	Returns the MagneticFieldMode as specified.
const Amg::Vector3D &	magneticField () const
	Get the magnetic field - in case of constant field only - throws exception if mode is not constant.

Protected Attributes
MagneticFieldMode	m_magneticFieldMode
Amg::Vector3D	m_magneticField

Detailed Description

magnetic field properties to steer the behavior of the extrapolation

Author

Andre.nosp@m.as.S.nosp@m.alzbu.nosp@m.rger.nosp@m.@cern.nosp@m..ch

(Athena MT) Christos Anastopoulos

Definition at line 30 of file MagneticFieldProperties.h.

Constructor & Destructor Documentation

MagneticFieldProperties() [1/4]

Trk::MagneticFieldProperties::MagneticFieldProperties

(

MagneticFieldMode

mode = Trk::FullField

)

Constructor for magnetic field mode - full field is default.

MagneticFieldProperties() [2/4]

Trk::MagneticFieldProperties::MagneticFieldProperties

(

const Amg::Vector3D &

field

)

Constructor for magnetic field mode.

MagneticFieldProperties() [3/4]

Trk::MagneticFieldProperties::MagneticFieldProperties ( const MagneticFieldProperties & )

default

MagneticFieldProperties() [4/4]

Trk::MagneticFieldProperties::MagneticFieldProperties ( MagneticFieldProperties && )

default

~MagneticFieldProperties()

Trk::MagneticFieldProperties::~MagneticFieldProperties ( )

default

Member Function Documentation

magneticField()

const Amg::Vector3D & Trk::MagneticFieldProperties::magneticField

(

)

const

Get the magnetic field - in case of constant field only - throws exception if mode is not constant.

magneticFieldMode()

MagneticFieldMode Trk::MagneticFieldProperties::magneticFieldMode

(

)

const

Returns the MagneticFieldMode as specified.

operator MagneticFieldMode()

Trk::MagneticFieldProperties::operator MagneticFieldMode

(

)

const

Cast operator.

operator=() [1/2]

MagneticFieldProperties & Trk::MagneticFieldProperties::operator= ( const MagneticFieldProperties & )

default

operator=() [2/2]

MagneticFieldProperties & Trk::MagneticFieldProperties::operator= ( MagneticFieldProperties && )

default

Member Data Documentation

m_magneticField

Amg::Vector3D Trk::MagneticFieldProperties::m_magneticField

protected

Definition at line 57 of file MagneticFieldProperties.h.

m_magneticFieldMode

MagneticFieldMode Trk::MagneticFieldProperties::m_magneticFieldMode

protected

Definition at line 56 of file MagneticFieldProperties.h.

---

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

• MagneticFieldProperties.h