#include <CondWriterAlg.h>

Inheritance diagram for DMTest::CondWriterAlg:

Collaboration diagram for DMTest::CondWriterAlg:

Public Member Functions
	CondWriterAlg (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor.
virtual StatusCode	initialize () override
	Algorithm initialization; called at the beginning of the job.
virtual StatusCode	execute () override
	Algorithm event processing.
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
StatusCode	writeSCond (unsigned int count)
StatusCode	writeRLTest (unsigned int count)
StatusCode	writeTSTest (unsigned int count)
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ServiceHandle< IIOVRegistrationSvc >	m_regSvc
ToolHandle< IAthenaOutputStreamTool >	m_streamer
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfoKey {this, "EvtInfo", "EventInfo", "EventInfo name"}
std::string	m_attrListKey
std::string	m_s2Key
std::string	m_rltestKey
std::string	m_tstestKey
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

Definition at line 32 of file CondWriterAlg.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

◆ CondWriterAlg()

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

Constructor.

Parameters

name	The algorithm name.
pSvcLocator	The service locator.

Definition at line 30 of file CondWriterAlg.cxx.

  : AthAlgorithm (name, pSvcLocator),
    m_regSvc ("IOVRegistrationSvc", name),
    m_streamer ("AthenaOutputStreamTool/CondStream", this)
{
  declareProperty ("Streamer",     m_streamer);
  declareProperty ("AttrListKey",  m_attrListKey = "/DMTest/TestAttrList");
  declareProperty ("S2Key",        m_s2Key       = "/DMTest/S2");
  declareProperty ("RLTestKey",    m_rltestKey   = "/DMTest/RLTest");
  declareProperty ("TSTestKey",    m_tstestKey   = "/DMTest/TSTest");
}

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 DMTest::CondWriterAlg::execute ( )

overridevirtual

Algorithm event processing.

Definition at line 135 of file CondWriterAlg.cxx.

{
  SG::ReadHandle<xAOD::EventInfo> eventInfo (m_eventInfoKey);
  unsigned int count = eventInfo->eventNumber() - 1; // events start with 1
 
  auto attrList = std::make_unique<AthenaAttributeList>();
  attrList->extend ("xint", "int");
  (*attrList)["xint"].setValue(static_cast<int> ((count+1)*10));
 
  ATH_CHECK( detStore()->overwrite (std::move (attrList), m_attrListKey) );
 
  ATH_CHECK( m_regSvc->registerIOV ("AthenaAttributeList",
                                    m_attrListKey,
                                    "AttrList_noTag",
                                    0, IOVTime::MAXRUN,
                                    count, IOVTime::MAXEVENT) );
 
  if (count%2 == 0) {
    ATH_CHECK( writeSCond (count) );
  }
 
  ATH_CHECK( writeRLTest (count) );
  ATH_CHECK( writeTSTest (count) );
 
  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 DMTest::CondWriterAlg::initialize ( )

overridevirtual

Algorithm initialization; called at the beginning of the job.

Definition at line 46 of file CondWriterAlg.cxx.

{
  ATH_CHECK( m_regSvc.retrieve() );
  ATH_CHECK( m_streamer.retrieve() );
  ATH_CHECK( m_eventInfoKey.initialize() );
  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);
      }
    }
  }

◆ writeRLTest()

StatusCode DMTest::CondWriterAlg::writeRLTest ( unsigned int count )

private

Definition at line 77 of file CondWriterAlg.cxx.

{
  // Bound in LBN.
  static const unsigned int bounds[] = { 0, 1, 3, 4, 7, 8, 9 };
 
  unsigned int lbn = count / 3;
  const unsigned int* pos = std::find (std::begin(bounds),
                                       std::end(bounds),
                                       lbn);
  if (pos != std::end(bounds)) {
    unsigned int niov = pos - std::begin(bounds) + 1;
 
    auto attrList = std::make_unique<AthenaAttributeList>();
    attrList->extend ("xint", "int");
    (*attrList)["xint"].setValue(static_cast<int> (niov));
    ATH_CHECK( detStore()->overwrite (std::move (attrList), m_rltestKey) );
 
    ATH_CHECK( m_regSvc->registerIOV ("AthenaAttributeList",
                                      m_rltestKey,
                                      "RL_noTag",
                                      0, 0,
                                      lbn, IOVTime::MAXEVENT) );
  }
 
  return StatusCode::SUCCESS;
}

◆ writeSCond()

StatusCode DMTest::CondWriterAlg::writeSCond ( unsigned int count )

private

Definition at line 55 of file CondWriterAlg.cxx.

{
  auto s2 = std::make_unique<DMTest::S2> (count * 50);
  ATH_CHECK( detStore()->overwrite (std::move (s2), m_s2Key) );
 
  IAthenaOutputStreamTool::TypeKeyPairs typeKeys {{"DMTest::S2", m_s2Key}};
 
  ATH_CHECK( m_streamer->connectOutput() );
  ATH_CHECK( m_streamer->streamObjects (typeKeys) );
  ATH_CHECK( m_streamer->commitOutput() );
 
  // Each IOV for this folder is two LBs long.
  ATH_CHECK( m_regSvc->registerIOV ("DMTest::S2",
                                    m_s2Key,
                                    "S2_noTag",
                                    0, 0,
                                    count, count+2) );
 
  return StatusCode::SUCCESS;
}

◆ writeTSTest()

StatusCode DMTest::CondWriterAlg::writeTSTest ( unsigned int count )

private

Definition at line 105 of file CondWriterAlg.cxx.

{
  // Bound in count.
  static const unsigned int bounds[] = { 0, 3, 6, 7, 10, 17, 19, 22, 26 };
 
  const unsigned int* pos = std::find (std::begin(bounds),
                                       std::end(bounds),
                                       count);
  if (pos != std::end(bounds)) {
    unsigned int niov = pos - std::begin(bounds) + 1;
 
    auto attrList = std::make_unique<AthenaAttributeList>();
    attrList->extend ("xint", "int");
    (*attrList)["xint"].setValue(static_cast<int> (niov * 100));
    ATH_CHECK( detStore()->overwrite (std::move (attrList), m_tstestKey) );
 
    ATH_CHECK( m_regSvc->registerIOV ("AthenaAttributeList",
                                      m_tstestKey,
                                      "TS_noTag",
                                      static_cast<uint64_t>(count) * 1000000000,
                                      IOVTime::MAXTIMESTAMP) );
  }
 
  return StatusCode::SUCCESS;
}

Member Data Documentation

◆ m_attrListKey

std::string DMTest::CondWriterAlg::m_attrListKey

private

Definition at line 64 of file CondWriterAlg.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_eventInfoKey

SG::ReadHandleKey<xAOD::EventInfo> DMTest::CondWriterAlg::m_eventInfoKey {this, "EvtInfo", "EventInfo", "EventInfo name"}

private

Definition at line 63 of file CondWriterAlg.h.

63{this, "EvtInfo", "EventInfo", "EventInfo name"};

◆ 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_regSvc

ServiceHandle<IIOVRegistrationSvc> DMTest::CondWriterAlg::m_regSvc

private

Definition at line 61 of file CondWriterAlg.h.

◆ m_rltestKey

std::string DMTest::CondWriterAlg::m_rltestKey

private

Definition at line 66 of file CondWriterAlg.h.

◆ m_s2Key

std::string DMTest::CondWriterAlg::m_s2Key

private

Definition at line 65 of file CondWriterAlg.h.

◆ m_streamer

ToolHandle<IAthenaOutputStreamTool> DMTest::CondWriterAlg::m_streamer

private

Definition at line 62 of file CondWriterAlg.h.

◆ m_tstestKey

std::string DMTest::CondWriterAlg::m_tstestKey

private

Definition at line 67 of file CondWriterAlg.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

◆ CondWriterAlg()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

◆ writeRLTest()

◆ writeSCond()

◆ writeTSTest()

Member Data Documentation

◆ m_attrListKey

◆ m_detStore

◆ m_eventInfoKey

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_regSvc

◆ m_rltestKey

◆ m_s2Key

◆ m_streamer

◆ m_tstestKey

◆ m_varHandleArraysDeclared

◆ m_vhka