ROBDataMonitor.h

Go to the documentation of this file.

//Dear emacs, this is -*- c++ -*-
 
/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
 
#ifndef ROBDATAMONITOR_H
#define ROBDATAMONITOR_H
 
#include "eformat/SourceIdentifier.h"
#include <iostream>
#include <string>
#include <map>
 
#include "AthContainers/DataVector.h"
#include "AthenaKernel/CLASS_DEF.h"
 
namespace robmonitor {

  enum ROBHistory { 
    UNCLASSIFIED      = 0,  // ROB was requested but never arrived at processor. History unknown. 
    RETRIEVED         = 1,  // ROB was retrieved from ROS by DataCollector
    HLT_CACHED        = 2,  // ROB was found already in the internal cache of the ROBDataProviderSvc
    DCM_CACHED        = 4,  // ROB was found already in the internal cache of the DCM
    IGNORED           = 8,  // ROB was on the "ignore" list and therefore not retrieved 
    UNDEFINED         = 16, // ROB was not on the "enabled" list, should not happen
    NUM_ROBHIST_CODES = 6   // number of different history codes
  };

  class ROBDataStruct {
  public:

    ROBDataStruct() = default;
                                   
    ROBDataStruct(const uint32_t);
 
    // data variables
    uint32_t rob_id{0};                           // rob source id
    uint32_t rob_size{0};                         // size of rob in words
    robmonitor::ROBHistory rob_history{robmonitor::UNCLASSIFIED};        // History of ROB retrieval
    uint32_t rob_status_word{0};                  // last status word in the ROB header
 
 
    // Accessor functions
    bool isUnclassified() const;
    bool isHLTCached() const;
    bool isDCMCached() const;
    bool isRetrieved() const;
    bool isIgnored() const;
    bool isUndefined() const;
    bool isStatusOk() const;
 
    // Extraction operator
    friend std::ostream& operator<<(std::ostream& os, const ROBDataStruct& rhs);
  };

  class ROBDataMonitorStruct {
  public:

    ROBDataMonitorStruct() = default;
                                   
    ROBDataMonitorStruct(const uint32_t, const std::string&);             
                                   
    ROBDataMonitorStruct(const uint32_t, const std::vector<uint32_t>&, const std::string&);
 
    ROBDataMonitorStruct(const ROBDataMonitorStruct&) = default;
 
    ROBDataMonitorStruct(ROBDataMonitorStruct&&) noexcept = default;
 
    ROBDataMonitorStruct& operator=(const ROBDataMonitorStruct&) = default;
 
    ROBDataMonitorStruct& operator=(ROBDataMonitorStruct&&) noexcept = default;
 
    // data variables
    uint32_t lvl1ID{0};                                                 
    std::string requestor_name{"UNKNOWN"};                              
    std::map<const uint32_t,robmonitor::ROBDataStruct> requested_ROBs;  
 
    // Run3 TrigTimeStamp
    uint64_t start_time{};         
    uint64_t end_time{};           
 
    // Accessor functions to ROB history summaries
    unsigned allROBs() const;
    unsigned unclassifiedROBs() const;
    unsigned HLTcachedROBs() const;
    unsigned DCMcachedROBs() const;
    unsigned retrievedROBs() const;
    unsigned ignoredROBs() const;
    unsigned undefinedROBs() const;
    unsigned statusOkROBs() const;

    float elapsedTime() const;
 
    // Extraction operator
    friend std::ostream& operator<<(std::ostream& os, const ROBDataMonitorStruct& rhs);
  };
 
  // Extraction operators
  std::ostream& operator<<(std::ostream& os, const ROBDataStruct& rhs);
  std::ostream& operator<<(std::ostream& os, const ROBDataMonitorStruct& rhs);
 
} // end namespace robmonitor
 
typedef DataVector<robmonitor::ROBDataMonitorStruct> ROBDataMonitorCollection;
 
CLASS_DEF( ROBDataMonitorCollection , 1303465505 , 1 )
 
 
#endif /* ROBDATAMONITOR_H */