Algorithm for writing bunch configuration metadata. More...

#include <BunchConfCnvAlg.h>

Inheritance diagram for xAODMaker::BunchConfCnvAlg:

Collaboration diagram for xAODMaker::BunchConfCnvAlg:

Public Member Functions
	BunchConfCnvAlg (const std::string &name, ISvcLocator *svcLoc)
	Regular algorithm constructor.
virtual StatusCode	initialize ()
	Function initialising the algorithm.
virtual StatusCode	execute ()
	Function executing the algorithm.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::string	m_eventName
	StoreGate key for the event object.
std::string	m_metaName
	StoreGate key for the configuration object.
ToolHandle< Trig::IBunchCrossingConfProvider >	m_bcConf
	Connection to the bunch configuration provider tool.
ServiceHandle< StoreGateSvc >	m_metaStore
	Connection to the metadata store.
xAOD::BunchConfContainer *	m_bcc
	The configuration object that is being written.
std::set< uint32_t >	m_convertedIDs
	Configurations that have already been converted.
DataObjIDColl	m_extendedExtraObjects
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

Algorithm for writing bunch configuration metadata.

   This algorithm can be used to write ROOT-readable bunch
   configuration metadata into an xAOD file.

Author: Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Revision: 583381

Date: 2014-02-14 16:58:20 +0100 (Fri, 14 Feb 2014)

Definition at line 43 of file BunchConfCnvAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ BunchConfCnvAlg()

xAODMaker::BunchConfCnvAlg::BunchConfCnvAlg	(	const std::string &	name,
		ISvcLocator *	svcLoc )

Regular algorithm constructor.

Definition at line 18 of file BunchConfCnvAlg.cxx.

      : AthAlgorithm( name, svcLoc ),
        m_bcConf( "Trig::TrigConfBunchCrossingTool/BunchCrossingTool" ),
        m_metaStore( "StoreGateSvc/MetaDataStore", name ),
        m_bcc( nullptr ) {
 
      declareProperty( "EventName", m_eventName = "BunchConfKey" );
      declareProperty( "MetaName", m_metaName = "BunchConfiguration" );
 
      declareProperty( "BCConfProvider", m_bcConf );
      declareProperty( "MetaDataStore", m_metaStore );
   }

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< 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< 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< 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; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< 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; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode xAODMaker::BunchConfCnvAlg::execute ( )

virtual

Function executing the algorithm.

Definition at line 59 of file BunchConfCnvAlg.cxx.

                                       {
 
      // Create and record the configuration identifier object for the
      // event data:
      xAOD::BunchConfKey* key = new xAOD::BunchConfKey( m_bcConf->configID() );
      CHECK( evtStore()->record( key, m_eventName ) );
 
      // Check if this configuration was saved already:
      if( ! m_convertedIDs.insert( m_bcConf->configID() ).second ) {
         ATH_MSG_VERBOSE( "Configuration with key " << m_bcConf->configID()
                          << " already translated" );
         return StatusCode::SUCCESS;
      }
 
      // Let the user know what's happening:
      ATH_MSG_INFO( "Converting the configuration with key: "
                    << m_bcConf->configID() );
 
      // Create a new configuration object:
      xAOD::BunchConf* conf = new xAOD::BunchConf();
      m_bcc->push_back( conf );
 
      // Set its configuration ID:
      conf->setConfigID( m_bcConf->configID() );
 
      // Set the basic configuration on it:
      conf->setCollidingBCIDs( m_bcConf->configuredBCIDs() );
      conf->setIntensitiesBeam1( m_bcConf->configuredIntensitiesBeam1() );
      conf->setIntensitiesBeam2( m_bcConf->configuredIntensitiesBeam2() );
 
      // Set the detailed configuration on it:
      conf->setUnpairedBCIDsBeam1( m_bcConf->configuredUnpairedBCIDsBeam1() );
      conf->setUnpairedBCIDsBeam2( m_bcConf->configuredUnpairedBCIDsBeam2() );
      conf->setUnpairedIntensitiesBeam1(
               m_bcConf->configuredUnpairedIntensitiesBeam1() );
      conf->setUnpairedIntensitiesBeam2(
               m_bcConf->configuredUnpairedIntensitiesBeam2() );
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< 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 & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 50 of file AthAlgorithm.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 Algorithm::extraOutputDeps();
}

◆ initialize()

StatusCode xAODMaker::BunchConfCnvAlg::initialize ( )

virtual

Function initialising the algorithm.

Definition at line 32 of file BunchConfCnvAlg.cxx.

                                          {
 
      // Greet the user:
      ATH_MSG_INFO( "Initialising" );
      ATH_MSG_DEBUG( "  EventName = " << m_eventName );
      ATH_MSG_DEBUG( "  MetaName  = " << m_metaName );
 
      // Retrieve all the used component(s):
      CHECK( m_bcConf.retrieve() );
      CHECK( m_metaStore.retrieve() );
 
      // Clear the internal cache:
      m_convertedIDs.clear();
 
      // Create an empty bunch configuration container:
      xAOD::BunchConfAuxContainer* aux = new xAOD::BunchConfAuxContainer();
      m_bcc = new xAOD::BunchConfContainer();
      m_bcc->setStore( aux );
 
      // Record it into the metadata store:
      CHECK( m_metaStore->record( m_bcc, m_metaName ) );
      CHECK( m_metaStore->record( aux, m_metaName + "Aux." ) );
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< 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.

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< 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< 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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::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< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::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< 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.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< 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_bcc

xAOD::BunchConfContainer* xAODMaker::BunchConfCnvAlg::m_bcc

private

The configuration object that is being written.

Definition at line 66 of file BunchConfCnvAlg.h.

◆ m_bcConf

ToolHandle< Trig::IBunchCrossingConfProvider > xAODMaker::BunchConfCnvAlg::m_bcConf

private

Connection to the bunch configuration provider tool.

Definition at line 61 of file BunchConfCnvAlg.h.

◆ m_convertedIDs

std::set< uint32_t > xAODMaker::BunchConfCnvAlg::m_convertedIDs

private

Configurations that have already been converted.

Definition at line 69 of file BunchConfCnvAlg.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_eventName

std::string xAODMaker::BunchConfCnvAlg::m_eventName

private

StoreGate key for the event object.

Definition at line 56 of file BunchConfCnvAlg.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_metaName

std::string xAODMaker::BunchConfCnvAlg::m_metaName

private

StoreGate key for the configuration object.

Definition at line 58 of file BunchConfCnvAlg.h.

◆ m_metaStore

ServiceHandle< StoreGateSvc > xAODMaker::BunchConfCnvAlg::m_metaStore

private

Connection to the metadata store.

Definition at line 63 of file BunchConfCnvAlg.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ BunchConfCnvAlg()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_bcc

◆ m_bcConf

◆ m_convertedIDs

◆ m_detStore

◆ m_eventName

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_metaName

◆ m_metaStore

◆ m_varHandleArraysDeclared

◆ m_vhka