A container class for data required to build online output from HLT. More...

#include <HLTResultMT.h>

Collaboration diagram for HLT::HLTResultMT:

Public Types
using	RODMinorVersion = std::pair< uint8_t, uint8_t >
	Type to store decoded ROD minor version (16-bit version split into two 8-bit numbers) More...

Public Member Functions
	HLTResultMT (std::vector< eformat::helper::StreamTag > streamTags={}, boost::dynamic_bitset< uint32_t > hltPassRawBits=boost::dynamic_bitset< uint32_t >(), boost::dynamic_bitset< uint32_t > hltPrescaledBits=boost::dynamic_bitset< uint32_t >(), std::unordered_map< uint16_t, std::vector< uint32_t > > data={})
	Standard constructor. More...

const std::vector< eformat::helper::StreamTag > &	getStreamTags () const
	Const-getter for stream tags. More...

std::vector< eformat::helper::StreamTag > &	getStreamTagsNonConst ()
	Non-const-getter for stream tags needed by the result maker to remove disabled ROBs/SubDets. More...

StatusCode	setStreamTags (const std::vector< eformat::helper::StreamTag > &streamTags)
	Replace the stored list of stream tags with the given one. More...

StatusCode	addStreamTag (const eformat::helper::StreamTag &streamTag)
	Append one stream tag to the stored list. More...

const boost::dynamic_bitset< uint32_t > &	getHltPassRawBits () const
	Const-getter for HLT pass raw bits. More...

const boost::dynamic_bitset< uint32_t > &	getHltPrescaledBits () const
	Const-getter for HLT prescaled bits. More...

const std::vector< uint32_t > &	getHltBitsAsWords () const
	Const-getter for HLT bits as uint32_t array. Ordering: PassRaw, Prescaled. More...

void	setHltPassRawBits (const boost::dynamic_bitset< uint32_t > &bitset)
	Replace HLT pass raw bits with the given bitset. More...

void	setHltPrescaledBits (const boost::dynamic_bitset< uint32_t > &bitset)
	Replace HLT prescaled bits with the given bitset. More...

void	setHltBits (const boost::dynamic_bitset< uint32_t > &passRawBitset, const boost::dynamic_bitset< uint32_t > &prescaledBitset)
	Replace both HLT pass raw and prescaled bits with the given bitsets. More...

const std::unordered_map< uint16_t, std::vector< uint32_t > > &	getSerialisedData () const
	Serialised data getter. More...

StatusCode	getSerialisedData (const uint16_t moduleId, const std::vector< uint32_t > *&data) const
	Serialised data getter for a given moduleId @in moduleId @out data - const pointer to the stored data, nullptr on failure. More...

void	setSerialisedData (std::unordered_map< uint16_t, std::vector< uint32_t > > data)
	Replaces serialised data with a copy of the given data. More...

void	addSerialisedData (const uint16_t moduleId, const std::vector< uint32_t > &data)
	Append serialised data (copy of input) for a given moduleId, doesn't remove existing data. More...

StatusCode	addSerialisedDataWithCheck (const uint16_t moduleId, std::vector< uint32_t > data)
	Add serialised data for a given moduleId. More...

const std::vector< uint32_t > &	getStatus () const
	Full event status reference getter (1 bit-mask status word + error code words) More...

const std::vector< HLT::OnlineErrorCode >	getErrorCodes () const
	Error codes getter (by value) - strips off the first bit-mask status word. More...

void	setStatus (std::vector< uint32_t > status)
	Replace the full status words with the given data. More...

void	addErrorCode (const HLT::OnlineErrorCode &errorCode, const eformat::helper::Status &firstStatusWord={ eformat::GenericStatus::DATA_CORRUPTION, eformat::FullEventStatus::PSC_PROBLEM })
	Append an error code. More...

const std::vector< uint32_t > &	getRobStatus (uint16_t moduleId) const
	Status words for ROB with given moduleId. More...

RODMinorVersion	getVersion () const
	ROD minor version getter. More...

void	setVersion (RODMinorVersion version)
	ROD minor version setter. More...

const std::set< uint16_t > &	getTruncatedModuleIds () const
	Getter for the truncation information. More...

void	addTruncatedModuleId (const uint16_t moduleId, bool severeTruncation=true)
	Add module ID to the list of truncated results. More...

bool	severeTruncation () const
	Truncation in at least one collection that is not allowed to be truncated. More...

bool	isAccepted () const
	If there is at least one stream tag set, it means the event is accepted. More...

Private Member Functions
void	updateHltBitWords ()
	Update m_hltBitWords with the contents of m_hltPassRawBits and m_hltPrescaledBits. More...

Private Attributes
std::vector< eformat::helper::StreamTag >	m_streamTags
	Stream tags of the event. More...

boost::dynamic_bitset< uint32_t >	m_hltPassRawBits
	HLT bits (flagging which chains passed) More...

boost::dynamic_bitset< uint32_t >	m_hltPrescaledBits

std::vector< uint32_t >	m_hltBitWords
	Vector storing m_hltBits converted to 4-byte words. More...

std::unordered_map< uint16_t, std::vector< uint32_t > >	m_data
	Serialised result (ROBFragment payload) for each moduleId (0 for full result, >0 for data scouting) More...

std::vector< uint32_t >	m_status
	FullEvent status words (first word is eformat::helper::Status, next words are optional error codes) More...

std::unordered_map< uint16_t, std::vector< uint32_t > >	m_robStatus
	ROBFragment status words for each moduleId. More...

RODMinorVersion	m_version
	Stores the ROD minor version of the HLT ROBFragments. More...

std::set< uint16_t >	m_truncatedModuleIds
	List of module IDs with truncation. More...

bool	m_severeTruncation {false}
	Should the event be sent to the debug stream due to severe truncation? More...

Detailed Description

A container class for data required to build online output from HLT.

This is not an EDM class and it is not meant to be serialised and persistified. It is a transient container for collecting serialised EDM objects and other event data before saving to ByteStream or after reading from ByteStream. It provides only getter and setter methods for the stored data. It does not serialise/deserialise the data on its own.

Definition at line 38 of file HLTResultMT.h.

Member Typedef Documentation

◆ RODMinorVersion

using HLT::HLTResultMT::RODMinorVersion = std::pair<uint8_t,uint8_t>

Type to store decoded ROD minor version (16-bit version split into two 8-bit numbers)

Definition at line 50 of file HLTResultMT.h.

Constructor & Destructor Documentation

◆ HLTResultMT()

HLT::HLTResultMT::HLTResultMT	(	std::vector< eformat::helper::StreamTag >	streamTags = `{}`,
		boost::dynamic_bitset< uint32_t >	hltPassRawBits = `boost::dynamic_bitset<uint32_t>()`,
		boost::dynamic_bitset< uint32_t >	hltPrescaledBits = `boost::dynamic_bitset<uint32_t>()`,
		std::unordered_map< uint16_t, std::vector< uint32_t > >	data = `{}`
	)

Standard constructor.

Definition at line 30 of file HLTResultMT.cxx.

 : m_streamTags(std::move(streamTags)),
   m_hltPassRawBits(std::move(hltPassRawBits)),
   m_hltPrescaledBits(std::move(hltPrescaledBits)),
   m_data(std::move(data)),
   m_version(s_currentHltRodMinorVersion) {}

Member Function Documentation

◆ addErrorCode()

void HLT::HLTResultMT::addErrorCode	(	const HLT::OnlineErrorCode &	errorCode,
		const eformat::helper::Status &	firstStatusWord = `{ eformat::GenericStatus::DATA_CORRUPTION, eformat::FullEventStatus::PSC_PROBLEM }`
	)

Append an error code.

Makes the current first word |= new first word and appends errorCode to the vector of optional error codes

Definition at line 218 of file HLTResultMT.cxx.

                                                                                 {
   if (m_status.empty()) m_status.push_back(firstStatusWord.code());
   else m_status[0] |= firstStatusWord.code();
   m_status.push_back(static_cast<uint32_t>(errorCode));
 }

◆ addSerialisedData()

void HLT::HLTResultMT::addSerialisedData	(	const uint16_t	moduleId,
		const std::vector< uint32_t > &	data
	)

Append serialised data (copy of input) for a given moduleId, doesn't remove existing data.

Definition at line 173 of file HLTResultMT.cxx.

                                                                                                {
     std::vector<uint32_t>& v = m_data[moduleId]; // creates new empty vector if the key doesn't exist
     // WARNING, copying data which may be large
     v.insert(v.end(),data.begin(),data.end());
 }

◆ addSerialisedDataWithCheck()

StatusCode HLT::HLTResultMT::addSerialisedDataWithCheck	(	const uint16_t	moduleId,
		std::vector< uint32_t >	data
	)

Add serialised data for a given moduleId.

Fails if any data for the given module already exist

Returns: FAILURE if moduleId is already present in the stored map

Definition at line 180 of file HLTResultMT.cxx.

                                                                                                        {
   if (m_data.find(moduleId)!=m_data.cend()) {
     ATH_REPORT_ERROR_WITH_CONTEXT(StatusCode::FAILURE, s_contextName.data())
       << "Trying to add data for a module which already exists in the stored map, moduleId=" << moduleId;
     return StatusCode::FAILURE;
   }
   else {
     // moving data
     m_data[moduleId] = std::move(data);
   }
   return StatusCode::SUCCESS;
 }

◆ addStreamTag()

StatusCode HLT::HLTResultMT::addStreamTag ( const eformat::helper::StreamTag & streamTag )

Append one stream tag to the stored list.

Removes duplicates by merging robs and dets lists of stream tags with equal name and type.

Returns: FAILURE only if two stream tags with equal name nad type have inconsistent obeys_lumiblock flags.

Definition at line 62 of file HLTResultMT.cxx.

                                                                                {
   // Check if a stream tag with the same type and name is already in the result
   auto compareTypeName = [&streamTag](const eformat::helper::StreamTag& existingStreamTag) {
     return streamTag.type == existingStreamTag.type && streamTag.name == existingStreamTag.name;
   };
   auto p = std::find_if(m_streamTags.begin(), m_streamTags.end(), compareTypeName);
  
   // In case of duplicate, merge ROBs and SubDets, otherwise just append the tag to the result
   if (p != m_streamTags.end()) {
     if (streamTag.obeys_lumiblock != p->obeys_lumiblock) {
       ATH_REPORT_ERROR_WITH_CONTEXT(StatusCode::FAILURE, s_contextName.data())
         << "Stream tags have equal type and name (" << streamTag.type << "/" << streamTag.name
         << "), but inconsistent obeys_lumiblock flag";
       return StatusCode::FAILURE;
     }
     p->robs.insert(streamTag.robs.begin(), streamTag.robs.end());
     p->dets.insert(streamTag.dets.begin(), streamTag.dets.end());
   }
   else {
     m_streamTags.push_back(streamTag);
   }
  
   return StatusCode::SUCCESS;
 }

◆ addTruncatedModuleId()

void HLT::HLTResultMT::addTruncatedModuleId	(	const uint16_t	moduleId,
		bool	severeTruncation = `true`
	)

Add module ID to the list of truncated results.

Parameters

moduleId	ROB module ID
severeTruncation	is the result severely truncated (debug stream)

Definition at line 256 of file HLTResultMT.cxx.

                                                                                         {
   // decide if event should go to the debug stream
   m_severeTruncation |= severeTruncation;
  
   auto [itr, inserted] = m_truncatedModuleIds.insert(moduleId);
   // Also update ROB status words
   if (inserted) {
     // Note that the per-ROB status requires the specific status bits to be zero
     // if a problem is detected by the HLT framework. This is different from the
     // event status where we set PSC_PROBLEM.
     // See eformat v5.0.2, section 5.8.2 (https://cds.cern.ch/record/683741)
     eformat::helper::Status firstStatusWord(eformat::GenericStatus::DATA_CORRUPTION);
     m_robStatus[moduleId] = {firstStatusWord.code(),
                              static_cast<uint32_t>(HLT::OnlineErrorCode::RESULT_TRUNCATION)};
   }
 }

◆ getErrorCodes()

const std::vector< HLT::OnlineErrorCode > HLT::HLTResultMT::getErrorCodes ( ) const

Error codes getter (by value) - strips off the first bit-mask status word.

Definition at line 201 of file HLTResultMT.cxx.

                                                                         {
   std::vector<HLT::OnlineErrorCode> errorCodes;
   if (m_status.size()<2)
     return errorCodes;
   for (auto it=m_status.cbegin()+1; it!=m_status.cend(); ++it) {
     errorCodes.push_back(static_cast<HLT::OnlineErrorCode>(*it));
   }
   return errorCodes;
 }

◆ getHltBitsAsWords()

const std::vector< uint32_t > & HLT::HLTResultMT::getHltBitsAsWords ( ) const

Const-getter for HLT bits as uint32_t array. Ordering: PassRaw, Prescaled.

Definition at line 100 of file HLTResultMT.cxx.

                                                                    {
   if (m_hltPassRawBits.num_blocks() != m_hltPrescaledBits.num_blocks()) {
     throw std::runtime_error("Must have the same number of bits in m_hltPassRawBits and m_hltPrescaledBits");
   }
   if (m_hltBitWords.size() != m_hltPassRawBits.num_blocks() + m_hltPrescaledBits.num_blocks()) {
     throw std::runtime_error("m_hltBitWords size differs from the sum of m_hltPassRawBits and m_hltPrescaledBits");
   }
   return m_hltBitWords;
 }

◆ getHltPassRawBits()

const boost::dynamic_bitset< uint32_t > & HLT::HLTResultMT::getHltPassRawBits ( ) const

Const-getter for HLT pass raw bits.

Definition at line 90 of file HLTResultMT.cxx.

                                                                              {
   return m_hltPassRawBits;
 }

◆ getHltPrescaledBits()

const boost::dynamic_bitset< uint32_t > & HLT::HLTResultMT::getHltPrescaledBits ( ) const

Const-getter for HLT prescaled bits.

Definition at line 95 of file HLTResultMT.cxx.

                                                                                {
   return m_hltPrescaledBits;
 }

◆ getRobStatus()

const std::vector< uint32_t > & HLT::HLTResultMT::getRobStatus ( uint16_t moduleId ) const

Status words for ROB with given moduleId.

Definition at line 226 of file HLTResultMT.cxx.

                                                                                {
   const auto it = m_robStatus.find(moduleId);
   if (it==m_robStatus.end()) {
     static const std::vector<uint32_t> empty;
     return empty;
   }
   else return it->second;
 }

◆ getSerialisedData() [1/2]

const std::unordered_map< uint16_t, std::vector< uint32_t > > & HLT::HLTResultMT::getSerialisedData ( ) const

Serialised data getter.

The only way to retrieve the data by reference with no exception throwing.

Definition at line 147 of file HLTResultMT.cxx.

                                                                                                 {
   return m_data;
 }

◆ getSerialisedData() [2/2]

StatusCode HLT::HLTResultMT::getSerialisedData	(	const uint16_t	moduleId,
		const std::vector< uint32_t > *&	data
	)		const

Serialised data getter for a given moduleId @in moduleId @out data - const pointer to the stored data, nullptr on failure.

Returns: FAILURE if moduleId is not found in the stored map

Definition at line 152 of file HLTResultMT.cxx.

                                                                                                             {
   data = nullptr;
   const auto it = m_data.find(moduleId);
   if (it==m_data.cend()) {
     REPORT_MESSAGE_WITH_CONTEXT(MSG::DEBUG, s_contextName.data())
       << "No data available in the stored map for the requested moduleId=" << moduleId;
     return StatusCode::FAILURE;
   }
   else {
     data = &(it->second);
   }
   return StatusCode::SUCCESS;
 }

◆ getStatus()

const std::vector< uint32_t > & HLT::HLTResultMT::getStatus ( ) const

Full event status reference getter (1 bit-mask status word + error code words)

Definition at line 196 of file HLTResultMT.cxx.

                                                            {
   return m_status;
 }

◆ getStreamTags()

const std::vector< eformat::helper::StreamTag > & HLT::HLTResultMT::getStreamTags ( ) const

Const-getter for stream tags.

Definition at line 43 of file HLTResultMT.cxx.

                                                                              {
   return m_streamTags;
 }

◆ getStreamTagsNonConst()

std::vector< eformat::helper::StreamTag > & HLT::HLTResultMT::getStreamTagsNonConst ( )

Non-const-getter for stream tags needed by the result maker to remove disabled ROBs/SubDets.

Definition at line 48 of file HLTResultMT.cxx.

                                                                          {
   return m_streamTags;
 }

◆ getTruncatedModuleIds()

const std::set< uint16_t > & HLT::HLTResultMT::getTruncatedModuleIds ( ) const

Getter for the truncation information.

Definition at line 251 of file HLTResultMT.cxx.

                                                                     {
   return m_truncatedModuleIds;
 }

◆ getVersion()

HLT::HLTResultMT::RODMinorVersion HLT::HLTResultMT::getVersion ( ) const

ROD minor version getter.

Definition at line 239 of file HLTResultMT.cxx.

                                                                {
   return m_version;
 }

◆ isAccepted()

bool HLT::HLTResultMT::isAccepted ( ) const

inline

If there is at least one stream tag set, it means the event is accepted.

Definition at line 178 of file HLTResultMT.h.

178 {return !m_streamTags.empty();}

◆ setHltBits()

void HLT::HLTResultMT::setHltBits	(	const boost::dynamic_bitset< uint32_t > &	passRawBitset,
		const boost::dynamic_bitset< uint32_t > &	prescaledBitset
	)

Replace both HLT pass raw and prescaled bits with the given bitsets.

Definition at line 125 of file HLTResultMT.cxx.

                                                                                         {
   if (passRawBitset.num_blocks() != prescaledBitset.num_blocks()) {
     throw std::runtime_error("Must have the same number of bits in passRawBitset and prescaledBitset");
   }
   // copy assignments
   m_hltPassRawBits = passRawBitset;
   m_hltPrescaledBits = prescaledBitset;
   updateHltBitWords();
 }

◆ setHltPassRawBits()

void HLT::HLTResultMT::setHltPassRawBits ( const boost::dynamic_bitset< uint32_t > & bitset )

Replace HLT pass raw bits with the given bitset.

Definition at line 111 of file HLTResultMT.cxx.

                                                                                   {
   // copy assignment
   m_hltPassRawBits = bitset;
   updateHltBitWords();
 }

◆ setHltPrescaledBits()

void HLT::HLTResultMT::setHltPrescaledBits ( const boost::dynamic_bitset< uint32_t > & bitset )

Replace HLT prescaled bits with the given bitset.

Definition at line 118 of file HLTResultMT.cxx.

                                                                                     {
   // copy assignment
   m_hltPrescaledBits = bitset;
   updateHltBitWords();
 }

◆ setSerialisedData()

void HLT::HLTResultMT::setSerialisedData ( std::unordered_map< uint16_t, std::vector< uint32_t > > data )

Replaces serialised data with a copy of the given data.

Definition at line 167 of file HLTResultMT.cxx.

                                                                                             {
   // WARNING, copying data which may be large - recommend calling this with std::move if appropriate
   m_data = std::move(data);
 }

◆ setStatus()

void HLT::HLTResultMT::setStatus ( std::vector< uint32_t > status )

Replace the full status words with the given data.

Definition at line 212 of file HLTResultMT.cxx.

                                                          {
   // move assignment
   m_status = std::move(status);
 }

◆ setStreamTags()

StatusCode HLT::HLTResultMT::setStreamTags ( const std::vector< eformat::helper::StreamTag > & streamTags )

Replace the stored list of stream tags with the given one.

Removes duplicates from the input list by merging robs and dets lists of stream tags with equal name and type.

Returns: FAILURE only if two stream tags with equal name nad type have inconsistent obeys_lumiblock flags.

Definition at line 53 of file HLTResultMT.cxx.

                                                                                             {
   m_streamTags.clear();
   for (const auto& st : streamTags) {
     ATH_CHECK(addStreamTag(st));
   }
   return StatusCode::SUCCESS;
 }

◆ setVersion()

void HLT::HLTResultMT::setVersion ( RODMinorVersion version )

ROD minor version setter.

Definition at line 244 of file HLTResultMT.cxx.

                                                        {
   m_version = version;
 }

◆ severeTruncation()

bool HLT::HLTResultMT::severeTruncation ( ) const

inline

Truncation in at least one collection that is not allowed to be truncated.

Definition at line 174 of file HLTResultMT.h.

174 { return m_severeTruncation; }

◆ updateHltBitWords()

void HLT::HLTResultMT::updateHltBitWords ( )

private

Update m_hltBitWords with the contents of m_hltPassRawBits and m_hltPrescaledBits.

Definition at line 137 of file HLTResultMT.cxx.

                                        {
   m_hltBitWords.clear();
   m_hltBitWords.resize(m_hltPassRawBits.num_blocks() + m_hltPrescaledBits.num_blocks(), 0);
   boost::to_block_range(m_hltPassRawBits, m_hltBitWords.begin());
   boost::to_block_range(m_hltPrescaledBits, m_hltBitWords.begin() + m_hltPassRawBits.num_blocks());
 }

Member Data Documentation

◆ m_data

std::unordered_map<uint16_t, std::vector<uint32_t> > HLT::HLTResultMT::m_data

private

Serialised result (ROBFragment payload) for each moduleId (0 for full result, >0 for data scouting)

Definition at line 198 of file HLTResultMT.h.

◆ m_hltBitWords

std::vector<uint32_t> HLT::HLTResultMT::m_hltBitWords

private

Vector storing m_hltBits converted to 4-byte words.

HLTResultMT needs to own this vector because its lifetime has to be ensured until the serialisation is finished. This vector is updated internally from m_hltPassRawBits and m_hltPrescaledBits and does not have a setter method.

Definition at line 195 of file HLTResultMT.h.

◆ m_hltPassRawBits

boost::dynamic_bitset<uint32_t> HLT::HLTResultMT::m_hltPassRawBits

private

HLT bits (flagging which chains passed)

Definition at line 187 of file HLTResultMT.h.

◆ m_hltPrescaledBits

boost::dynamic_bitset<uint32_t> HLT::HLTResultMT::m_hltPrescaledBits

private

Definition at line 188 of file HLTResultMT.h.

◆ m_robStatus

std::unordered_map<uint16_t, std::vector<uint32_t> > HLT::HLTResultMT::m_robStatus

private

ROBFragment status words for each moduleId.

Definition at line 204 of file HLTResultMT.h.

◆ m_severeTruncation

bool HLT::HLTResultMT::m_severeTruncation {false}

private

Should the event be sent to the debug stream due to severe truncation?

Definition at line 214 of file HLTResultMT.h.

◆ m_status

std::vector<uint32_t> HLT::HLTResultMT::m_status

private

FullEvent status words (first word is eformat::helper::Status, next words are optional error codes)

Definition at line 201 of file HLTResultMT.h.

◆ m_streamTags

std::vector<eformat::helper::StreamTag> HLT::HLTResultMT::m_streamTags

private

Stream tags of the event.

Definition at line 184 of file HLTResultMT.h.

◆ m_truncatedModuleIds

std::set<uint16_t> HLT::HLTResultMT::m_truncatedModuleIds

private

List of module IDs with truncation.

Used only by the framework while creating the result. It is not stored in ByteStream files.

Definition at line 211 of file HLTResultMT.h.

◆ m_version

RODMinorVersion HLT::HLTResultMT::m_version

private

Stores the ROD minor version of the HLT ROBFragments.

Definition at line 207 of file HLTResultMT.h.

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ RODMinorVersion

Constructor & Destructor Documentation

◆ HLTResultMT()

Member Function Documentation

◆ addErrorCode()

◆ addSerialisedData()

◆ addSerialisedDataWithCheck()

◆ addStreamTag()

◆ addTruncatedModuleId()

◆ getErrorCodes()

◆ getHltBitsAsWords()

◆ getHltPassRawBits()

◆ getHltPrescaledBits()

◆ getRobStatus()

◆ getSerialisedData() [1/2]

◆ getSerialisedData() [2/2]

◆ getStatus()

◆ getStreamTags()

◆ getStreamTagsNonConst()

◆ getTruncatedModuleIds()

◆ getVersion()

◆ isAccepted()

◆ setHltBits()

◆ setHltPassRawBits()

◆ setHltPrescaledBits()

◆ setSerialisedData()

◆ setStatus()

◆ setStreamTags()

◆ setVersion()

◆ severeTruncation()

◆ updateHltBitWords()

Member Data Documentation

◆ m_data

◆ m_hltBitWords

◆ m_hltPassRawBits

◆ m_hltPrescaledBits

◆ m_robStatus

◆ m_severeTruncation

◆ m_status

◆ m_streamTags

◆ m_truncatedModuleIds

◆ m_version