podio::SIOFileTOCRecord Class Reference

#include <SIOBlock.h>

Public Types
using	PositionType = sio_helpers::position_type

Public Member Functions
void	addRecord (const std::string &name, PositionType startPos)
size_t	getNRecords (const std::string &name) const
PositionType	getPosition (const std::string &name, unsigned iEntry=0) const
std::vector< std::string_view >	getRecordNames () const

Friends
struct	SIOFileTOCRecordBlock

Detailed Description

Definition at line 285 of file SIOBlock.h.

Member Typedef Documentation

PositionType

using podio::SIOFileTOCRecord::PositionType = sio_helpers::position_type

Definition at line 287 of file SIOBlock.h.

Member Function Documentation

addRecord()

void podio::SIOFileTOCRecord::addRecord	(	const std::string &	name,
		PositionType	startPos
	)

Definition at line 184 of file SIOBlock.cc.

                                                                             {
  auto it =
      std::find_if(m_recordMap.begin(), m_recordMap.end(), [&name](const auto& entry) { return entry.first == name; });
 
  if (it == m_recordMap.end()) {
    m_recordMap.push_back({name, {startPos}});
  } else {
    it->second.push_back(startPos);
  }
}

Referenced by podio::SIOFrameWriter::finish(), podio::SIOWriter::finish(), podio::SIOWriter::writeEvent(), and podio::SIOFrameWriter::writeFrame().

getNRecords()

size_t podio::SIOFileTOCRecord::getNRecords

(

const std::string &

name

)

const

Definition at line 195 of file SIOBlock.cc.

                                                                {
  const auto it = std::find_if(m_recordMap.cbegin(), m_recordMap.cend(),
                               [&name](const auto& entry) { return entry.first == name; });
  if (it != m_recordMap.cend()) {
    return it->second.size();
  }
  return 0;
}

Referenced by podio::SIOReader::getEntries(), podio::SIOFrameReader::getEntries(), and podio::SIOLegacyReader::getEntries().

getPosition()

SIOFileTOCRecord::PositionType podio::SIOFileTOCRecord::getPosition	(	const std::string &	name,
		unsigned	iEntry = 0
	)		const

Get the position of the iEntry-th record with the given name. If no entry with the given name is recorded, return 0. Note there is no internal check on whether the given name actually has iEntry records. Use getNRecords to check for that if necessary.

Definition at line 204 of file SIOBlock.cc.

                                                                                                       {
  const auto it = std::find_if(m_recordMap.cbegin(), m_recordMap.cend(),
                               [&name](const auto& keyVal) { return keyVal.first == name; });
  if (it != m_recordMap.end()) {
    if (iEntry < it->second.size()) {
      return it->second[iEntry];
    }
  }
 
  return 0;
}

Referenced by podio::SIOLegacyReader::readEntry(), and podio::SIOFrameReader::readNextEntry().

getRecordNames()

std::vector< std::string_view > podio::SIOFileTOCRecord::getRecordNames

(

)

const

Get all the record names that are stored in this TOC record

Definition at line 216 of file SIOBlock.cc.

                                                                 {
  std::vector<std::string_view> cats;
  cats.reserve(m_recordMap.size());
  for (const auto& [cat, _] : m_recordMap) {
    cats.emplace_back(cat);
  }
 
  return cats;
}

Referenced by podio::SIOFrameReader::getAvailableCategories().

Friends And Related Function Documentation

SIOFileTOCRecordBlock

friend struct SIOFileTOCRecordBlock

friend

Definition at line 304 of file SIOBlock.h.

---

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

• SIOBlock.h
• SIOBlock.cc