MagField::AtlasFieldCacheCondAlg Class Reference

#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
	Avoid scheduling algorithm multiple times.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
virtual bool	filterPassed (const EventContext &ctx) const
	Get filter decision:
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
	Set filter decision:
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

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, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

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.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
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 376 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

AtlasFieldCacheCondAlg()

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

Definition at line 22 of file AtlasFieldCacheCondAlg.cxx.

  : AthCondAlgorithm(name, pSvcLocator)
{}

~AtlasFieldCacheCondAlg()

AtlasFieldCacheCondAlg::~AtlasFieldCacheCondAlg ( )

virtualdefault

Member Function Documentation

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & 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());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & 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.

{ return m_detStore; }

evtStore()

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.

{ return m_evtStore; }

execute()

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

finaloverride

Definition at line 57 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 & AthCommonAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 89 of file AthCommonAlgorithm.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 AthCommonAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Get filter decision:

Definition at line 93 of file AthCommonAlgorithm.h.

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

initialize()

StatusCode AtlasFieldCacheCondAlg::initialize ( )

finaloverride

Definition at line 31 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()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

inlineoverridevirtualinherited

Specify if the algorithm is clonable.

Only relevant for non-reentrant algorithms. Actual number of clones needs to be set via the "Cardinality" property.

Reimplemented in AFP_DigiTop, AlgB, AlgT, BCM_Digitization, CscDigitBuilder, CscDigitToCscRDO, G4AtlasAlg, G4RunAlg, HGTD_Digitization, HiveAlgBase, InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ISF::SimKernelMT, ITk::StripDigitization, ITkPixelCablingAlg, ITkStripCablingAlg, LArHitEMapMaker, LArTTL1Maker, LUCID_DigiTop, LVL1::L1TopoSimulation, MergeCalibHits, MergeGenericMuonSimHitColl, MergeHijingPars, MergeMcEventCollection, MergeTrackRecordCollection, MergeTruthJets, MergeTruthParticles, MuonDigitizer, PileUpMTAlg, PixelDigitization, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_Digitization, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, SGInputLoader, Simulation::BeamEffectsAlg, TileHitVecToCnt, TileMuonFitter, TilePulseForTileMuonReceiver, TileRawChannelMaker, TRTDigitization, and ZDC_DigiTop.

Definition at line 68 of file AthCommonAlgorithm.h.

                                           {
    return true;
  }

isReEntrant()

virtual bool AthCondAlgorithm::isReEntrant ( ) const

inlineoverridevirtualinherited

Avoid scheduling algorithm multiple times.

With multiple concurrent events, conditions objects often expire simultaneously for all slots. To avoid that the scheduler runs the CondAlg in each slot, we declare it as "non-reentrant". This ensures that the conditions objects are only created once.

In case a particular CondAlg should behave differently, it can override this method again and return true.

See also

ATEAM-836

Definition at line 39 of file AthCondAlgorithm.h.

{ return false; }

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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 368 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 352 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

scaleField()

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

private

Definition at line 282 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 AthCommonAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state, const EventContext & ctx ) const

inlinevirtualinherited

Set filter decision:

Definition at line 99 of file AthCommonAlgorithm.h.

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

sysExecute()

StatusCode AthCommonAlgorithm< 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.

Reimplemented in AthAnalysisAlgorithm.

Definition at line 80 of file AthCommonAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode AthCommonAlgorithm< 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 AthAnalysisAlgorithm, AthHistogramAlgorithm, HypoBase, InputMakerBase, and PyAthena::Alg.

Definition at line 60 of file AthCommonAlgorithm.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 135 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 246 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 298 of file AthCommonDataStore.h.

                                               {
    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 105 of file AtlasFieldCacheCondAlg.h.

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

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 86 of file AtlasFieldCacheCondAlg.h.

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

m_detStore

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

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 381 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 378 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthCommonAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

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

Empty if no symlinks were found.

Definition at line 108 of file AthCommonAlgorithm.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 77 of file AtlasFieldCacheCondAlg.h.

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

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 95 of file AtlasFieldCacheCondAlg.h.

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

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 55 of file AtlasFieldCacheCondAlg.h.

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

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 61 of file AtlasFieldCacheCondAlg.h.

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

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 69 of file AtlasFieldCacheCondAlg.h.

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

m_useSoleCurrent

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

private

Initial value:

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

Definition at line 114 of file AtlasFieldCacheCondAlg.h.

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

m_useToroCurrent

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

private

Initial value:

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

Definition at line 118 of file AtlasFieldCacheCondAlg.h.

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

m_varHandleArraysDeclared

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

privateinherited

Definition at line 387 of file AthCommonDataStore.h.

m_vhka

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

privateinherited

Definition at line 386 of file AthCommonDataStore.h.

---

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

• AtlasFieldCacheCondAlg.h
• AtlasFieldCacheCondAlg.cxx