AtlasFieldCacheCondObj Class Reference

#include <AtlasFieldCacheCondObj.h>

Collaboration diagram for AtlasFieldCacheCondObj:

Public Member Functions
	AtlasFieldCacheCondObj ()
	~AtlasFieldCacheCondObj ()
void	getInitializedCache (MagField::AtlasFieldCache &cache) const
	get B field cache for evaluation as a function of 2-d (solenoid) or 3-d (toroid) position. More...
double	solenoidFieldScaleFactor () const
	access to solenoid field scale factor More...
double	toriodFieldScaleFactor () const
	access to toroid field scale factor More...
const MagField::AtlasFieldMap *	fieldMap () const
	access to non-owning AtlasFieldMap More...
void	initialize (double solFieldScale, double torFieldScale, const MagField::AtlasFieldMap *fieldMap)
	set values for field scale and service to be able to build the cache More...

Private Attributes
double	m_solFieldScale {1}
double	m_torFieldScale {1}
const MagField::AtlasFieldMap *	m_fieldMap {nullptr}

Detailed Description

Definition at line 19 of file AtlasFieldCacheCondObj.h.

Constructor & Destructor Documentation

AtlasFieldCacheCondObj()

AtlasFieldCacheCondObj::AtlasFieldCacheCondObj

(

)

Definition at line 6 of file AtlasFieldCacheCondObj.cxx.

{}

~AtlasFieldCacheCondObj()

AtlasFieldCacheCondObj::~AtlasFieldCacheCondObj

(

)

Definition at line 9 of file AtlasFieldCacheCondObj.cxx.

{}

Member Function Documentation

fieldMap()

const MagField::AtlasFieldMap* AtlasFieldCacheCondObj::fieldMap ( ) const

inline

access to non-owning AtlasFieldMap

Definition at line 37 of file AtlasFieldCacheCondObj.h.

{ return m_fieldMap; }

getInitializedCache()

void AtlasFieldCacheCondObj::getInitializedCache ( MagField::AtlasFieldCache &  cache ) const

inline

get B field cache for evaluation as a function of 2-d (solenoid) or 3-d (toroid) position.

Resets cache to an initialized state

Definition at line 52 of file AtlasFieldCacheCondObj.h.

{
 
    // setup with field scale and magnetic field service for first access to field */
    cache = MagField::AtlasFieldCache(m_solFieldScale, m_torFieldScale, m_fieldMap);
}

initialize()

void AtlasFieldCacheCondObj::initialize	(	double	solFieldScale,
		double	torFieldScale,
		const MagField::AtlasFieldMap *	fieldMap
	)

set values for field scale and service to be able to build the cache

Definition at line 13 of file AtlasFieldCacheCondObj.cxx.

{
    // temporary flag
    m_solFieldScale = solFieldScale;
    m_torFieldScale = torFieldScale;
    m_fieldMap      = fieldMap;
}

solenoidFieldScaleFactor()

double AtlasFieldCacheCondObj::solenoidFieldScaleFactor ( ) const

inline

access to solenoid field scale factor

Definition at line 31 of file AtlasFieldCacheCondObj.h.

{ return m_solFieldScale; } 

toriodFieldScaleFactor()

double AtlasFieldCacheCondObj::toriodFieldScaleFactor ( ) const

inline

access to toroid field scale factor

Definition at line 34 of file AtlasFieldCacheCondObj.h.

{ return m_torFieldScale; } 

Member Data Documentation

m_fieldMap

const MagField::AtlasFieldMap* AtlasFieldCacheCondObj::m_fieldMap {nullptr}

private

Definition at line 46 of file AtlasFieldCacheCondObj.h.

m_solFieldScale

double AtlasFieldCacheCondObj::m_solFieldScale {1}

private

Definition at line 44 of file AtlasFieldCacheCondObj.h.

m_torFieldScale

double AtlasFieldCacheCondObj::m_torFieldScale {1}

private

Definition at line 45 of file AtlasFieldCacheCondObj.h.

---

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

• AtlasFieldCacheCondObj.h
• AtlasFieldCacheCondObj.cxx