TrigCOOLUpdateHelper.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRIGSERVICES_TRIGCOOLUPDATEHELPER_H
#define TRIGSERVICES_TRIGCOOLUPDATEHELPER_H
 
// STL includes
#include <map>
#include <string>
#include <vector>
 
// Framework includes
#include "GaudiKernel/ServiceHandle.h"
#include "GaudiKernel/StatusCode.h"
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "AthenaKernel/IIOVDbSvc.h"
#include "AthenaKernel/IIOVSvc.h"
#include "AthenaMonitoringKernel/Monitored.h"
#include "GaudiKernel/EventIDBase.h"
#include "ByteStreamCnvSvcBase/IROBDataProviderSvc.h"
 
// TDAQ includes
#include "CTPfragment/CTPExtraWordsFormat.h"

struct FolderInfo {
  CLID clid{CLID_NULL};
  std::string key;
};

struct FolderUpdate {
  FolderUpdate() : lumiBlock(0), folderIndex(0), needsUpdate(true) {}
  explicit FolderUpdate(const CTPfragment::FolderEntry& entry) :
    lumiBlock(entry.lumiBlock),
    folderIndex(entry.folderIndex),
    needsUpdate(true) {}
 
  EventIDBase::number_type lumiBlock;
  CTPfragment::FolderIndex folderIndex;
  bool needsUpdate;
};

class TrigCOOLUpdateHelper : public AthAlgTool {
public:
  TrigCOOLUpdateHelper(const std::string& type, const std::string& name, const IInterface* parent);
 
  virtual StatusCode initialize() override;
  virtual StatusCode start() override;
  virtual StatusCode stop() override;

  StatusCode hltCoolUpdate(const EventContext& ctx);

  StatusCode hltCoolUpdate(const std::string& folder);

  StatusCode getFolderName(CTPfragment::FolderIndex idx, std::string& folderName) const;

  StatusCode extractFolderUpdates(const EventContext& ctx);

  StatusCode readFolderInfo();
 
private:
  StatusCode resetFolder(const std::string& folder);

  StatusCode resetFolders(const std::vector<std::string>& folders);

  std::map<std::string, FolderInfo> m_folderInfo;

  std::map<CTPfragment::FolderIndex, FolderUpdate> m_folderUpdates;

  std::map<CTPfragment::FolderIndex, std::string> m_folderNames;
 
  // Services and Tools
  SmartIF<IIOVSvc>                   m_iovSvc;
  SmartIF<IIOVDbSvc>                 m_iovDbSvc;
  ServiceHandle<IROBDataProviderSvc> m_robDataProviderSvc;
 
  // Properties
  ToolHandle<GenericMonitoringTool> m_monTool{this, "MonTool", {}, "Monitoring tool"};
 
  Gaudi::Property<std::string> m_coolFolderName{
    this, "CoolFolderMap", {}, "Name of COOL folder containing folder map"};
 
  Gaudi::Property<std::vector<std::string>> m_folders{
    this, "Folders", {}, "List of folders that can be updated during the run"};
 
  Gaudi::Property<uint32_t> m_ctpRobId{
    this, "CtpRobId", 0x770001, "ROB ID of CTP fragment containing the extra payload"};
};
 
#endif