AtlasFieldCacheCondObj Class Reference

#include <AtlasFieldCacheCondObj.h>

Collaboration diagram for AtlasFieldCacheCondObj:

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

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() [1/3]

AtlasFieldCacheCondObj::AtlasFieldCacheCondObj ( )

default

AtlasFieldCacheCondObj() [2/3]

AtlasFieldCacheCondObj::AtlasFieldCacheCondObj ( AtlasFieldCacheCondObj && )

default

AtlasFieldCacheCondObj() [3/3]

AtlasFieldCacheCondObj::AtlasFieldCacheCondObj ( const AtlasFieldCacheCondObj & )

default

~AtlasFieldCacheCondObj()

AtlasFieldCacheCondObj::~AtlasFieldCacheCondObj ( )

default

Member Function Documentation

fieldMap()

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

inline

access to non-owning AtlasFieldMap

Definition at line 43 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 or 3-d position.

Resets cache to an initialized state

Definition at line 32 of file AtlasFieldCacheCondObj.h.

                                                                 {
    cache = MagField::AtlasFieldCache(m_solFieldScale, m_torFieldScale, m_fieldMap);
  }

initialize()

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

inline

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

Definition at line 46 of file AtlasFieldCacheCondObj.h.

                                                         {
 
    m_solFieldScale = solFieldScale;
    m_torFieldScale = torFieldScale;
    m_fieldMap = fieldMap;
  }

operator=() [1/2]

AtlasFieldCacheCondObj & AtlasFieldCacheCondObj::operator= ( AtlasFieldCacheCondObj && )

default

operator=() [2/2]

AtlasFieldCacheCondObj & AtlasFieldCacheCondObj::operator= ( const AtlasFieldCacheCondObj & )

default

solenoidFieldScaleFactor()

double AtlasFieldCacheCondObj::solenoidFieldScaleFactor ( ) const

inline

access to solenoid field scale factor

Definition at line 37 of file AtlasFieldCacheCondObj.h.

{ return m_solFieldScale; }

toriodFieldScaleFactor()

double AtlasFieldCacheCondObj::toriodFieldScaleFactor ( ) const

inline

access to toroid field scale factor

Definition at line 40 of file AtlasFieldCacheCondObj.h.

{ return m_torFieldScale; }

Member Data Documentation

m_fieldMap

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

private

Definition at line 58 of file AtlasFieldCacheCondObj.h.

{nullptr};

m_solFieldScale

double AtlasFieldCacheCondObj::m_solFieldScale {1}

private

Definition at line 55 of file AtlasFieldCacheCondObj.h.

{1};

m_torFieldScale

double AtlasFieldCacheCondObj::m_torFieldScale {1}

private

Definition at line 56 of file AtlasFieldCacheCondObj.h.

{1};

---

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

• AtlasFieldCacheCondObj.h