podio::SIOFrameReader Class Reference

#include <SIOFrameReader.h>

Public Member Functions
	SIOFrameReader ()
	~SIOFrameReader ()=default
	SIOFrameReader (const SIOFrameReader &)=delete
SIOFrameReader &	operator= (const SIOFrameReader &)=delete
std::unique_ptr< podio::SIOFrameData >	readNextEntry (const std::string &name)
std::unique_ptr< podio::SIOFrameData >	readEntry (const std::string &name, const unsigned entry)
unsigned	getEntries (const std::string &name) const
	Returns number of entries for the given name.
void	openFile (const std::string &filename)
podio::version::Version	currentFileVersion () const
	Get the build version of podio that has been used to write the current file.
std::vector< std::string_view >	getAvailableCategories () const
	Get the names of all the availalable Frame categories in the current file(s)
const std::string_view	getDatamodelDefinition (const std::string &name) const
	Get the datamodel definition for the given name.
std::vector< std::string >	getAvailableDatamodels () const
	Get all names of the datamodels that ara available from this reader.

Detailed Description

Definition at line 20 of file SIOFrameReader.h.

Constructor & Destructor Documentation

SIOFrameReader() [1/2]

podio::SIOFrameReader::SIOFrameReader

(

)

Definition at line 14 of file SIOFrameReader.cc.

                               {
  auto& libLoader [[maybe_unused]] = SIOBlockLibraryLoader::instance();
}

~SIOFrameReader()

podio::SIOFrameReader::~SIOFrameReader ( )

default

SIOFrameReader() [2/2]

podio::SIOFrameReader::SIOFrameReader ( const SIOFrameReader &  )

delete

Member Function Documentation

currentFileVersion()

podio::version::Version podio::SIOFrameReader::currentFileVersion ( ) const

inline

Get the build version of podio that has been used to write the current file.

Definition at line 50 of file SIOFrameReader.h.

                                                 {
    return m_fileVersion;
  }

getAvailableCategories()

std::vector< std::string_view > podio::SIOFrameReader::getAvailableCategories

(

)

const

Get the names of all the availalable Frame categories in the current file(s)

Definition at line 58 of file SIOFrameReader.cc.

                                                                       {
  // Filter the availalbe records from the TOC to remove records that are
  // stored, but use reserved record names for podio meta data
  auto recordNames = m_tocRecord.getRecordNames();
  recordNames.erase(std::remove_if(recordNames.begin(), recordNames.end(),
                                   [](const auto& elem) { return elem == sio_helpers::SIOEDMDefinitionName; }),
                    recordNames.end());
  return recordNames;
}

getAvailableDatamodels()

std::vector< std::string > podio::SIOFrameReader::getAvailableDatamodels ( ) const

inline

Get all names of the datamodels that ara available from this reader.

Definition at line 63 of file SIOFrameReader.h.

                                                      {
    return m_datamodelHolder.getAvailableDatamodels();
  }

getDatamodelDefinition()

const std::string_view podio::SIOFrameReader::getDatamodelDefinition ( const std::string &  name ) const

inline

Get the datamodel definition for the given name.

Definition at line 58 of file SIOFrameReader.h.

                                                                           {
    return m_datamodelHolder.getDatamodelDefinition(name);
  }

getEntries()

unsigned podio::SIOFrameReader::getEntries

(

const std::string &

name

)

const

Returns number of entries for the given name.

Definition at line 68 of file SIOFrameReader.cc.

                                                               {
  return m_tocRecord.getNRecords(name);
}

openFile()

void podio::SIOFrameReader::openFile

(

const std::string &

filename

)

Definition at line 18 of file SIOFrameReader.cc.

                                                       {
  m_stream.open(filename, std::ios::binary);
  if (!m_stream.is_open()) {
    throw std::runtime_error("File " + filename + " couldn't be opened");
  }
 
  // NOTE: reading TOC record first because that jumps back to the start of the file!
  readFileTOCRecord();
  readPodioHeader();
  readEDMDefinitions(); // Potentially could do this lazily
}

operator=()

SIOFrameReader & podio::SIOFrameReader::operator= ( const SIOFrameReader &  )

delete

readEntry()

std::unique_ptr< SIOFrameData > podio::SIOFrameReader::readEntry	(	const std::string &	name,
		const unsigned	entry
	)

Read the specified data entry from which a Frame can be constructed for the given name. In case the entry does not exist for this name or in case there is no data for this name, this returns a nullptr.

Definition at line 51 of file SIOFrameReader.cc.

                                                                                                 {
  // NOTE: Will create or overwrite the entry counter
  //       All checks are done in the following function
  m_nameCtr[name] = entry;
  return readNextEntry(name);
}

readNextEntry()

std::unique_ptr< SIOFrameData > podio::SIOFrameReader::readNextEntry

(

const std::string &

name

)

Read the next data entry from which a Frame can be constructed for the given name. In case there are no more entries left for this name or in case there is no data for this name, this returns a nullptr.

Definition at line 30 of file SIOFrameReader.cc.

                                                                               {
  // Skip to where the next record of this name starts in the file, based on
  // how many times we have already read this name
  //
  // NOTE: exploiting the fact that the operator[] of a map will create a
  // default initialized entry for us if not present yet
  const auto recordPos = m_tocRecord.getPosition(name, m_nameCtr[name]);
  if (recordPos == 0) {
    return nullptr;
  }
  m_stream.seekg(recordPos);
 
  auto [tableBuffer, tableInfo] = sio_utils::readRecord(m_stream, false);
  auto [dataBuffer, dataInfo] = sio_utils::readRecord(m_stream, false);
 
  m_nameCtr[name]++;
 
  return std::make_unique<SIOFrameData>(std::move(dataBuffer), dataInfo._uncompressed_length, std::move(tableBuffer),
                                        tableInfo._uncompressed_length);
}

Referenced by readEntry().

---

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

• SIOFrameReader.h
• SIOFrameReader.cc