#include <AtlasFieldCacheCondAlg.h>

Inheritance diagram for MagField::AtlasFieldCacheCondAlg:

Collaboration diagram for MagField::AtlasFieldCacheCondAlg:

Classes
struct	Cache

Public Member Functions
	AtlasFieldCacheCondAlg (const std::string &name, ISvcLocator *pSvcLocator)

virtual	~AtlasFieldCacheCondAlg ()

StatusCode	initialize () override final

StatusCode	execute (const EventContext &ctx) const override final

virtual bool	isReEntrant () const override final

virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...

virtual bool	isClonable () const override
	Specify if the algorithm is clonable. More...

virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...

virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...

virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...

virtual bool	filterPassed (const EventContext &ctx) const

virtual void	setFilterPassed (bool state, const EventContext &ctx) const

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	updateCurrentFromConditions (const EventContext &ctx, Cache &cache) const

StatusCode	updateCurrentFromParameters (const EventContext &ctx, Cache &cache) const

void	scaleField (Cache &cache, const MagField::AtlasFieldMap *fieldMap) const

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
Gaudi::Property< double >	m_soleMinCurrent

Gaudi::Property< double >	m_toroMinCurrent

Gaudi::Property< bool >	m_useDCS

Gaudi::Property< bool >	m_lockMapCurrents

SG::ReadCondHandleKey< CondAttrListCollection >	m_currInputKey

SG::ReadCondHandleKey< AtlasFieldMapCondObj >	m_mapCondObjInputKey

SG::WriteCondHandleKey< AtlasFieldCacheCondObj >	m_condObjOutputKey

Gaudi::Property< double >	m_useSoleCurrent

Gaudi::Property< double >	m_useToroCurrent

DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. More...

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 23 of file AtlasFieldCacheCondAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ AtlasFieldCacheCondAlg()

AtlasFieldCacheCondAlg::AtlasFieldCacheCondAlg	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Definition at line 26 of file AtlasFieldCacheCondAlg.cxx.

29 : AthReentrantAlgorithm(name, pSvcLocator)

30 {}

◆ ~AtlasFieldCacheCondAlg()

AtlasFieldCacheCondAlg::~AtlasFieldCacheCondAlg ( )

virtualdefault

Member Function Documentation

◆ cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

 {
   return 0;
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ execute()

StatusCode AtlasFieldCacheCondAlg::execute ( const EventContext & ctx ) const

finaloverride

Definition at line 61 of file AtlasFieldCacheCondAlg.cxx.

 {
  
   ATH_MSG_DEBUG("execute: entering");
  
   // Check if output conditions object with field cache object is still valid,
   // if not replace it with new current scale factors
   SG::WriteCondHandle<AtlasFieldCacheCondObj> writeHandle{ m_condObjOutputKey,
                                                            ctx };
   if (writeHandle.isValid()) {
     ATH_MSG_DEBUG("execute: CondHandle "
                   << writeHandle.fullKey() << " is already valid. "
                   << " May happen if multiple concurrent events are being "
                      "processed out of order.");
     return StatusCode::SUCCESS;
   }
  
   // This will need to be filled before we construct the condition object
   Cache cache{};
  
   if (m_useDCS) {
     ATH_CHECK(updateCurrentFromConditions(ctx, cache));
   } else {
     ATH_CHECK(updateCurrentFromParameters(ctx, cache));
   }
  
   // Must read map cond object to get previously created map
   SG::ReadCondHandle<AtlasFieldMapCondObj> mapReadHandle{ m_mapCondObjInputKey,
                                                           ctx };
   const AtlasFieldMapCondObj* mapCondObj{ *mapReadHandle };
   if (mapCondObj == nullptr) {
     ATH_MSG_ERROR("execute: Could not access conditions map for key: "
                   << m_mapCondObjInputKey.fullKey());
     return StatusCode::FAILURE;
   }
  
   // simple pointer to the map, to be give to the AtlasFieldCacheCondObj, used
   // for the cache field map access
   const MagField::AtlasFieldMap* fieldMap = mapCondObj->fieldMap();
  
   // calculate the scale factors
   if (!m_lockMapCurrents) {
     scaleField(cache, fieldMap);
   }
  
   // save current scale factor in conditions object
   auto fieldCondObj = std::make_unique<AtlasFieldCacheCondObj>();
  
   // initialize cond obj with current scale factors and the field svc (needed to
   // setup cache)
   fieldCondObj->initialize(
     cache.m_solScaleFactor, cache.m_torScaleFactor, fieldMap);
  
   // Record in conditions store the conditions object with scale factors and map
   // pointer for cache
   if (writeHandle.record(cache.m_condObjOutputRange, std::move(fieldCondObj))
         .isFailure()) {
     ATH_MSG_ERROR(
       "execute: Could not record AtlasFieldCacheCondObj object with "
       << writeHandle.key() << " with EventRange " << cache.m_condObjOutputRange
       << " into Conditions Store");
     return StatusCode::FAILURE;
   }
  
   ATH_MSG_INFO(
     "execute: initialized AtlasFieldCacheCondObj and cache with SFs - sol/tor "
     << cache.m_solScaleFactor << "/" << cache.m_torScaleFactor
     << ", EventRange " << cache.m_condObjOutputRange);
   if (fieldMap) {
     ATH_MSG_INFO("execute: solenoid zone id  " << fieldMap->solenoidZoneId());
   } else {
     ATH_MSG_INFO("execute: no map read (currents == 0");
   }
  
   return StatusCode::SUCCESS;
 }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 94 of file AthCommonReentrantAlgorithm.cxx.

 {
   // If we didn't find any symlinks to add, just return the collection
   // from the base class.  Otherwise, return the extended collection.
   if (!m_extendedExtraObjects.empty()) {
     return m_extendedExtraObjects;
   }
   return BaseAlg::extraOutputDeps();
 }

◆ filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

                                                            {
     return execState( ctx ).filterPassed();
   }

◆ initialize()

StatusCode AtlasFieldCacheCondAlg::initialize ( )

finaloverride

Definition at line 35 of file AtlasFieldCacheCondAlg.cxx.

 {
   // Read Handle for the current
   ATH_CHECK(m_currInputKey.initialize(m_useDCS));
  
   // Read handle for the field map cond object
   ATH_CHECK(m_mapCondObjInputKey.initialize());
  
   // Output handle for scale factors/cache
   ATH_CHECK(m_condObjOutputKey.initialize());
  
   ATH_MSG_DEBUG("Initialize: Key " << m_condObjOutputKey.fullKey()
                 << " has been succesfully registered ");
  
   ATH_MSG_INFO("Initialize: Will update current from " <<
                (m_useDCS ? "conditions" : "parameters"));
  
   ATH_MSG_INFO("Initialize: useDCS, useSoleCurrent, useToroCurrent. "
                << (int)m_useDCS << ", " << m_useSoleCurrent << ", "
                << m_useToroCurrent << " LockMapCurrents "
                << (int)m_lockMapCurrents);
  
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ isClonable()

bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

 {
   // Reentrant algorithms are clonable.
   return true;
 }

◆ isReEntrant()

virtual bool MagField::AtlasFieldCacheCondAlg::isReEntrant ( ) const

inlinefinaloverridevirtual

Definition at line 31 of file AtlasFieldCacheCondAlg.h.

31 { return false; }

◆ msg() [1/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ scaleField()

void AtlasFieldCacheCondAlg::scaleField	(	Cache &	cache,
		const MagField::AtlasFieldMap *	fieldMap
	)		const

private

Definition at line 286 of file AtlasFieldCacheCondAlg.cxx.

 {
   // Calculate the scale factor for solenoid and toroid.
  
   // We have one piece of information coming from the map.
   // Do  we have a map including both Toroid/Solenoid or only one.
   // The values are typically the nominal value for the map
   // or 0.
   bool mapHasToroid = fieldMap && (fieldMap->toroidCurrent()>0);
   bool mapHasSolenoid = fieldMap && (fieldMap->solenoidCurrent()>0);
  
   // Then we have the info we get on the actual current we have
   // So we might need to scale the map with it.
   // Set the SF for the solenoid
   if (cache.m_solenoidCurrent > 0.0) {
     if (mapHasSolenoid &&
         std::abs(cache.m_solenoidCurrent / fieldMap->solenoidCurrent() - 1.0) >
             0.001) {
       cache.m_solScaleFactor =
           cache.m_solenoidCurrent / fieldMap->solenoidCurrent();
     }
     ATH_MSG_INFO("scaleField: Solenoid field scale factor "
                  << cache.m_solScaleFactor
                  << ". Desired current and map current: "
                  << cache.m_solenoidCurrent << ","
                  << (fieldMap ? fieldMap->solenoidCurrent() : 0));
   } else {
     // No SF set, set it to 0 - current was set to zero either here or for the
     // map, or the map was not read in
     cache.m_solScaleFactor = 0;
     ATH_MSG_INFO("scaleField: Solenoid field scale factor "
                  << cache.m_solScaleFactor
                  << ". Desired current and map current: "
                  << cache.m_solenoidCurrent << ","
                  << ((fieldMap) ? fieldMap->solenoidCurrent() : 0));
   }
  
  
   // Set the SF for the toroid
   if (cache.m_toroidCurrent > 0.0) {
     if (mapHasToroid &&
         std::abs(cache.m_toroidCurrent / fieldMap->toroidCurrent() - 1.0) >
           0.001) {
       // scale the field in all zones except for the solenoid zone
       cache.m_torScaleFactor =
         cache.m_toroidCurrent / fieldMap->toroidCurrent();
     }
     ATH_MSG_INFO("scaleField: Toroid field scale factor "
                  << cache.m_torScaleFactor
                  << ". Desired current and map current: "
                  << cache.m_toroidCurrent << ","
                  << (fieldMap ? fieldMap->toroidCurrent() : 0));
   } else {
     cache.m_torScaleFactor = 0;
     ATH_MSG_INFO("scaleField: Toroid field scale factor "
                  << cache.m_torScaleFactor
                  << ". Desired current and map current: "
                  << cache.m_toroidCurrent << ","
                  << ((fieldMap) ? fieldMap->toroidCurrent() : 0));
   }
   // If the map was toroid only set both to the toroid
   // the 0s in the  solenoid should be covered by the map
   if (mapHasToroid && !mapHasSolenoid) {
     cache.m_solScaleFactor = cache.m_torScaleFactor;
   }
   // if the map is solenoid only set both to the solenoid
   // the 0s in the  toroid should be covered by the map
   if (!mapHasToroid && mapHasSolenoid) {
     cache.m_torScaleFactor = cache.m_solScaleFactor;
   }
 }

◆ setFilterPassed()

virtual void AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed	(	bool	state,
		const EventContext &	ctx
	)		const

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

                                                                             {
     execState( ctx ).setFilterPassed( state );
   }

◆ sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

 {
   return BaseAlg::sysExecute (ctx);
 }

◆ sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysInitialize

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in InputMakerBase, and HypoBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

                                                                {
   StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::sysInitialize();
  
   if (sc.isFailure()) {
     return sc;
   }
   
   ServiceHandle<ICondSvc> cs("CondSvc",name());
   for (auto h : outputHandles()) {
     if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
       // do this inside the loop so we don't create the CondSvc until needed
       if ( cs.retrieve().isFailure() ) {
         ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
         return StatusCode::SUCCESS;
       }      
       if (cs->regHandle(this,*h).isFailure()) {
         sc = StatusCode::FAILURE;
         ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                       << " with CondSvc");
       }
     }
   }
   return sc;  
 }

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateCurrentFromConditions()

StatusCode AtlasFieldCacheCondAlg::updateCurrentFromConditions	(	const EventContext &	ctx,
		Cache &	cache
	)		const

private

Definition at line 139 of file AtlasFieldCacheCondAlg.cxx.

 {
  
   // readin current value
   SG::ReadCondHandle<CondAttrListCollection> readHandle{ m_currInputKey, ctx };
   const CondAttrListCollection* attrListColl{ *readHandle };
   if (attrListColl == nullptr) {
     ATH_MSG_ERROR("updateCurrentFromConditions: Failed to retrieve "
                   "CondAttributeListCollection with key "
                   << m_currInputKey.key());
     return StatusCode::FAILURE;
   }
  
   // Get the validitiy range
   EventIDRange rangeW;
   if (!readHandle.range(rangeW)) {
     ATH_MSG_FATAL(
       "updateCurrentFromConditions: Failed to retrieve validity range for "
       << readHandle.key());
     return StatusCode::FAILURE;
   }
   cache.m_condObjOutputRange = rangeW;
   ATH_MSG_INFO("UpdateCurrentFromConditions: Range of input/output is "
                << cache.m_condObjOutputRange);
  
   // get magnet currents from DCS
   double solcur{ 0. };
   double torcur{ 0. };
   bool gotsol{ false };
   bool gottor{ false };
  
   /*
    * due to inconsistencies between CONDBR2 and OFLP200/COMP200 (the former
    * includes channel names in the /EXT/DCS/MAGNETS/SENSORDATA folder, the
    * latter don't), we try to read currents in both ways
    */
   bool hasChanNames{ false };
   ATH_MSG_INFO("UpdateCurrentFromConditions: Attempt 1 at reading currents "
                "from DCS (using channel name)");
   for (CondAttrListCollection::const_iterator itr = attrListColl->begin();
        itr != attrListColl->end();
        ++itr) {
     const std::string& name = attrListColl->chanName(itr->first);
     ATH_MSG_INFO("UpdateCurrentFromConditions: Trying to read from DCS: "
                  "[channel name, index, value] "
                  << name << " , " << itr->first << " , "
                  << itr->second["value"].data<float>());
     if (name.compare("") != 0) {
       hasChanNames = true;
     }
     if (name.compare("CentralSol_Current") == 0) {
       // channel 1 is solenoid current
       solcur = itr->second["value"].data<float>();
       gotsol = true;
     } else if (name.compare("Toroids_Current") == 0) {
       // channel 3 is toroid current
       torcur = itr->second["value"].data<float>();
       gottor = true;
     }
   }
   if (!hasChanNames) {
     ATH_MSG_INFO("UpdateCurrentFromConditions: Attempt 2 at reading currents "
                  "from DCS (using channel index)");
     // in no channel is named, try again using channel index instead
     for (CondAttrListCollection::const_iterator itr = attrListColl->begin();
          itr != attrListColl->end();
          ++itr) {
  
       if (itr->first == 1) {
         // channel 1 is solenoid current
         solcur = itr->second["value"].data<float>();
         gotsol = true;
       } else if (itr->first == 3) {
         // channel 3 is toroid current
         torcur = itr->second["value"].data<float>();
         gottor = true;
       }
     }
   }
   if (!gotsol || !gottor) {
     if (!gotsol)
       ATH_MSG_ERROR("UpdateCurrentFromConditions: Missing solenoid current in "
                     "DCS information");
     if (!gottor)
       ATH_MSG_ERROR("UpdateCurrentFromConditions: Missing toroid current in "
                     "DCS information");
     return StatusCode::FAILURE;
   }
  
   ATH_MSG_INFO("UpdateCurrentFromConditions: Currents read from DCS - solenoid "
                << solcur << " toroid " << torcur);
  
   // round to zero if close to zero
   if (solcur < m_soleMinCurrent) {
     solcur = 0.0;
     ATH_MSG_INFO("UpdateCurrentFromConditions: Solenoid is off");
   }
   if (torcur < m_toroMinCurrent) {
     torcur = 0.0;
     ATH_MSG_INFO("UpdateCurrentFromConditions: Toroids are off");
   }
  
   cache.m_solenoidCurrent = solcur;
   cache.m_toroidCurrent = torcur;
  
   return StatusCode::SUCCESS;
 }

◆ updateCurrentFromParameters()

StatusCode AtlasFieldCacheCondAlg::updateCurrentFromParameters	(	const EventContext &	ctx,
		Cache &	cache
	)		const

private

Definition at line 250 of file AtlasFieldCacheCondAlg.cxx.

 {
  
   // take the current values from JobOptions
   double solcur{ m_useSoleCurrent };
   double torcur{ m_useToroCurrent };
   if (solcur < m_soleMinCurrent) {
     solcur = 0.0;
     ATH_MSG_INFO("updateCurrentFromParameters: Solenoid is off");
   }
   if (torcur < m_toroMinCurrent) {
     torcur = 0.0;
     ATH_MSG_INFO("updateCurrentFromParameters: Toroids are off");
   }
   cache.m_solenoidCurrent = solcur;
   cache.m_toroidCurrent = torcur;
  
   // in case of reading from DB or from FILE, the EventID range is always the
   // current run
   EventIDBase start, stop;
   start.set_run_number(ctx.eventID().run_number());
   start.set_lumi_block(0);
   stop.set_run_number(ctx.eventID().run_number() + 1);
   stop.set_lumi_block(0);
   cache.m_condObjOutputRange = EventIDRange(start, stop);
  
   ATH_MSG_INFO("updateCurrentFromParameters: Update from job options: Range of "
                "input/output is "
                << cache.m_condObjOutputRange);
  
   return StatusCode::SUCCESS;
 }

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_condObjOutputKey

SG::WriteCondHandleKey<AtlasFieldCacheCondObj> MagField::AtlasFieldCacheCondAlg::m_condObjOutputKey

private

Initial value:

{
    this,
    "AtlasFieldCacheCondObj",
    "fieldCondObj",
    "Name of the key for the Magnetic Field conditions object with currents "
    "for scaling"
  }

Definition at line 106 of file AtlasFieldCacheCondAlg.h.

◆ m_currInputKey

SG::ReadCondHandleKey<CondAttrListCollection> MagField::AtlasFieldCacheCondAlg::m_currInputKey

private

Initial value:

{
    this,
    "COOLCurrentsFolderName",
    "/EXT/DCS/MAGNETS/SENSORDATA",
    "Name of the COOL folder containing magnet currents"
  }

Definition at line 87 of file AtlasFieldCacheCondAlg.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

◆ m_lockMapCurrents

Gaudi::Property<bool> MagField::AtlasFieldCacheCondAlg::m_lockMapCurrents

private

Initial value:

{
    this,
    "LockMapCurrents",
    false,
    "Skip current rescale and use map currents as they are"
  }

Definition at line 78 of file AtlasFieldCacheCondAlg.h.

◆ m_mapCondObjInputKey

SG::ReadCondHandleKey<AtlasFieldMapCondObj> MagField::AtlasFieldCacheCondAlg::m_mapCondObjInputKey

private

Initial value:

{
    this,
    "AtlasFieldMapCondObj",
    "fieldMapCondObj",
    "Name of key for the Magnetic Field conditions object with the map file "
    "names"
  }

Definition at line 96 of file AtlasFieldCacheCondAlg.h.

◆ m_soleMinCurrent

Gaudi::Property<double> MagField::AtlasFieldCacheCondAlg::m_soleMinCurrent

private

Initial value:

{
    this,
    "SoleMinCurrent",
    1.0,
    "Minimum solenoid current (A) for which solenoid is considered ON"
  }

Definition at line 56 of file AtlasFieldCacheCondAlg.h.

◆ m_toroMinCurrent

Gaudi::Property<double> MagField::AtlasFieldCacheCondAlg::m_toroMinCurrent

private

Initial value:

{
    this,
    "ToroMinCurrent",
    1.0,
    "Minimum toroid current (A) for which toroid is considered ON"
  }

Definition at line 62 of file AtlasFieldCacheCondAlg.h.

◆ m_useDCS

Gaudi::Property<bool> MagField::AtlasFieldCacheCondAlg::m_useDCS

private

Initial value:

{
    this,
    "UseDCS",
    false,
    "Get magnet currents from DCS through ConditionsSvc"
  }

Definition at line 70 of file AtlasFieldCacheCondAlg.h.

◆ m_useSoleCurrent

Gaudi::Property<double> MagField::AtlasFieldCacheCondAlg::m_useSoleCurrent

private

Initial value:

{ this,
                                            "UseSoleCurrent",
                                            7730.,
                                            "Set actual solenoid current (A)" }

Definition at line 115 of file AtlasFieldCacheCondAlg.h.

◆ m_useToroCurrent

Gaudi::Property<double> MagField::AtlasFieldCacheCondAlg::m_useToroCurrent

private

Initial value:

{ this,
                                            "UseToroCurrent",
                                            20400.,
                                            "Set actual toroid current (A)" }

Definition at line 119 of file AtlasFieldCacheCondAlg.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Classes

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ AtlasFieldCacheCondAlg()

◆ ~AtlasFieldCacheCondAlg()

Member Function Documentation

◆ cardinality()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ isReEntrant()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ scaleField()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateCurrentFromConditions()

◆ updateCurrentFromParameters()

◆ updateVHKA()

Member Data Documentation

◆ m_condObjOutputKey

◆ m_currInputKey

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_lockMapCurrents

◆ m_mapCondObjInputKey

◆ m_soleMinCurrent

◆ m_toroMinCurrent

◆ m_useDCS

◆ m_useSoleCurrent

◆ m_useToroCurrent

◆ m_varHandleArraysDeclared

◆ m_vhka