#include <ZdcByteStreamLucrodData.h>

Inheritance diagram for ZdcByteStreamLucrodData:

Collaboration diagram for ZdcByteStreamLucrodData:

Public Member Functions
	ZdcByteStreamLucrodData (const std::string &name, ISvcLocator *pSvcLocator)
	~ZdcByteStreamLucrodData ()=default
StatusCode	initialize ()
StatusCode	execute ()
StatusCode	finalize ()
StatusCode	fillContainer (std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * >, ZdcLucrodDataContainer *zdcLucrodDataContainer)
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
ServiceHandle< IROBDataProviderSvc >	m_robDataProvider
SG::WriteHandleKey< ZdcLucrodDataContainer >	m_ZdcLucrodDataContainerKey { this, "ZdcLucrodDataContainerLocation", ZdcDefs::ZdcLucrodDataContainerLocation, "" }
ZdcLucrodDecoder	m_ZdcLucrodDecoder
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 25 of file ZdcByteStreamLucrodData.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

◆ ZdcByteStreamLucrodData()

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

Definition at line 13 of file ZdcByteStreamLucrodData.cxx.

                                                                                               :
  AthAlgorithm     (name                , pSvcLocator),
  m_robDataProvider("ROBDataProviderSvc", name),
  m_ZdcLucrodDecoder(eformat::FORWARD_ZDC)
 {
 }

◆ ~ZdcByteStreamLucrodData()

ZdcByteStreamLucrodData::~ZdcByteStreamLucrodData ( )

default

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

Definition at line 34 of file ZdcByteStreamLucrodData.cxx.

                                            {
  
  ATH_MSG_DEBUG(" ZdcByteStreamLucrodData::execute ");
 
  SG::WriteHandle<ZdcLucrodDataContainer> h_write(m_ZdcLucrodDataContainerKey);
  
  std::vector<const ROBFragment*> listOfRobf;
  std::vector<unsigned int> ROBIDs;
  
  // Set up the list of LUCROD ROBIDs 
  //
  //  High word of source ID indicates the ZDC (0x83)
  //  Low word numbers the modules: 0-5 for the 6 LUCRODs in Run 3
  //
  const unsigned int RODSourceIdShifted = eformat::FORWARD_ZDC << 16;
 
  for (unsigned int lucrodModuleNum = 0; lucrodModuleNum < 6; lucrodModuleNum++) {
    ROBIDs.push_back(RODSourceIdShifted + lucrodModuleNum);
  }
 
  ATH_MSG_DEBUG("ZdcByteStreamLucrodData::execute::getROBDATA");
  m_robDataProvider->getROBData(Gaudi::Hive::currentContext(), ROBIDs, listOfRobf);
  
  auto zdcLucrodDataContainer = std::make_unique<ZdcLucrodDataContainer>(); 
  
  ATH_MSG_DEBUG("ZdcByteStreamLucrodData::execute::filleContainer");
  StatusCode sc = fillContainer(std::move(listOfRobf),zdcLucrodDataContainer.get());
  
  if (sc.isFailure()) ATH_MSG_WARNING(" fillContainer failed ");
  else                ATH_MSG_DEBUG  (" fillContainer success ");
 
  ATH_MSG_DEBUG("ZdcByteStreamLucrodData::execute::record m_ZdcLucrodDataContainerKey");
 
  sc = h_write.record(std::move(zdcLucrodDataContainer));
  
  ATH_MSG_DEBUG("ZdcByteStreamLucrodData::execute::record testing...");
 
  if (sc.isFailure()) ATH_MSG_WARNING(" Could not record ZdcLucrodDataContainer in StoreGate ");
  else                ATH_MSG_DEBUG  (" ZdcLucrodDataContainer is recorded in StoreGate ");
  
  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();
}

◆ fillContainer()

StatusCode ZdcByteStreamLucrodData::fillContainer	(	std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * >	listOfRobf,
		ZdcLucrodDataContainer *	zdcLucrodDataContainer )

Definition at line 77 of file ZdcByteStreamLucrodData.cxx.

                                                                                                                                          {
  
  ATH_MSG_DEBUG(" ZdcByteStreamLucrodData::fillContainer ");
 
  size_t nFragments = listOfRobf.size();
    
  ATH_MSG_DEBUG(" Number of ROB fragments: " << nFragments);
  
  if (!nFragments) return StatusCode::SUCCESS;
 
  std::vector<const ROBFragment*>::const_iterator rob_it  = listOfRobf.begin();
  std::vector<const ROBFragment*>::const_iterator rob_end = listOfRobf.end();
  
  for (; rob_it != rob_end; ++rob_it) {
    
    // *** important: we need to use [rod] source id here ***
    //
    uint32_t robid = (*rob_it)->rod_source_id();
    
    ATH_MSG_DEBUG(" ROB Fragment with ID: 0x" << std::hex << robid << std::dec); 
 
    uint32_t lucrodID = robid & 0x7;
 
    ZdcLucrodData* zld = new ZdcLucrodData(lucrodID);
    
    StatusCode sc = m_ZdcLucrodDecoder.decode(&**rob_it, zld);
    
    if (sc.isFailure()){
      ATH_MSG_WARNING(" Conversion from ByteStream to ZdcLucrodData failed ");
      delete zld;
    } 
    else zdcLucrodDataContainer->push_back(zld);
  }
 
  for (auto zld : *zdcLucrodDataContainer) {zld->str();}
 
  if (zdcLucrodDataContainer->size() == nFragments)
    return StatusCode::SUCCESS;
  else
    return StatusCode::FAILURE;
 
}

◆ finalize()

StatusCode ZdcByteStreamLucrodData::finalize ( )

Definition at line 120 of file ZdcByteStreamLucrodData.cxx.

                                             { 
  
  ATH_MSG_DEBUG(" ZdcByteStreamLucrodData::finalize ");
  
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode ZdcByteStreamLucrodData::initialize ( )

Definition at line 20 of file ZdcByteStreamLucrodData.cxx.

                                               {
  
  ATH_MSG_DEBUG("ZdcByteStreamLucrodData::initialize");
 
  StatusCode sc = m_robDataProvider.retrieve();
  
  if (sc.isFailure()) ATH_MSG_WARNING(" Could not retrieve ROBDataProviderSvc ");
  else                ATH_MSG_DEBUG  (" Retrieved service ROBDataProviderSvc ");
 
  ATH_CHECK( m_ZdcLucrodDataContainerKey.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);
      }
    }
  }

Member Data Documentation

◆ 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_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_robDataProvider

ServiceHandle<IROBDataProviderSvc> ZdcByteStreamLucrodData::m_robDataProvider

private

Definition at line 40 of file ZdcByteStreamLucrodData.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.

◆ m_ZdcLucrodDataContainerKey

SG::WriteHandleKey<ZdcLucrodDataContainer> ZdcByteStreamLucrodData::m_ZdcLucrodDataContainerKey { this, "ZdcLucrodDataContainerLocation", ZdcDefs::ZdcLucrodDataContainerLocation, "" }

private

Definition at line 42 of file ZdcByteStreamLucrodData.h.

42{ this, "ZdcLucrodDataContainerLocation", ZdcDefs::ZdcLucrodDataContainerLocation, "" };

ZdcDefs::ZdcLucrodDataContainerLocation

static const std::string ZdcLucrodDataContainerLocation

Definition ZdcDefs.h:22

◆ m_ZdcLucrodDecoder

ZdcLucrodDecoder ZdcByteStreamLucrodData::m_ZdcLucrodDecoder

private

Definition at line 43 of file ZdcByteStreamLucrodData.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

◆ ZdcByteStreamLucrodData()

◆ ~ZdcByteStreamLucrodData()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ fillContainer()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_robDataProvider

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_ZdcLucrodDataContainerKey

◆ m_ZdcLucrodDecoder