podio::SIOFrameData Class Reference

#include <SIOFrameData.h>

Public Member Functions
	SIOFrameData ()=delete
	~SIOFrameData ()=default
	SIOFrameData (const SIOFrameData &)=delete
SIOFrameData &	operator= (const SIOFrameData &)=delete
	SIOFrameData (SIOFrameData &&)=default
SIOFrameData &	operator= (SIOFrameData &&)=default
	SIOFrameData (sio::buffer &&collBuffers, std::size_t dataSize, sio::buffer &&tableBuffer, std::size_t tableSize)
std::optional< podio::CollectionReadBuffers >	getCollectionBuffers (const std::string &name)
podio::CollectionIDTable	getIDTable ()
std::unique_ptr< podio::GenericParameters >	getParameters ()
std::vector< std::string >	getAvailableCollections ()

Detailed Description

The Frame data container for the SIO backend. It is constructed from the compressed sio::buffers that is read from file and does all the necessary unpacking and decompressing internally after construction.

Definition at line 24 of file SIOFrameData.h.

Constructor & Destructor Documentation

SIOFrameData() [1/4]

podio::SIOFrameData::SIOFrameData ( )

delete

~SIOFrameData()

podio::SIOFrameData::~SIOFrameData ( )

default

SIOFrameData() [2/4]

podio::SIOFrameData::SIOFrameData ( const SIOFrameData &  )

delete

SIOFrameData() [3/4]

podio::SIOFrameData::SIOFrameData ( SIOFrameData &&  )

default

SIOFrameData() [4/4]

podio::SIOFrameData::SIOFrameData ( sio::buffer &&  collBuffers, std::size_t  dataSize, sio::buffer &&  tableBuffer, std::size_t  tableSize  )

inline

Constructor from the collBuffers containing the collection data and a tableBuffer containing the necessary information for unpacking the collections. The two size parameters denote the uncompressed size of the respective buffers.

Definition at line 42 of file SIOFrameData.h.

                                                                                                          :
      m_recBuffer(std::move(collBuffers)),
      m_tableBuffer(std::move(tableBuffer)),
      m_dataSize(dataSize),
      m_tableSize(tableSize) {
  }

Member Function Documentation

getAvailableCollections()

std::vector< std::string > podio::SIOFrameData::getAvailableCollections

(

)

Definition at line 35 of file SIOFrameData.cc.

                                                           {
  unpackBuffers();
  std::vector<std::string> collections;
  for (size_t i = 0; i < m_blocks.size(); ++i) {
    if (m_availableBlocks[i]) {
      collections.push_back(m_idTable.name(i));
    }
  }
 
  return collections;
}

getCollectionBuffers()

std::optional< podio::CollectionReadBuffers > podio::SIOFrameData::getCollectionBuffers

(

const std::string &

name

)

Definition at line 10 of file SIOFrameData.cc.

                                                                                                {
  unpackBuffers();
 
  if (m_idTable.present(name)) {
    // The collections that we read are not necessarily in the same order as
    // they are in the collection id table. Hence, we cannot simply use the
    // collection ID to index into the blocks
    const auto& names = m_idTable.names();
    const auto nameIt = std::find(std::begin(names), std::end(names), name);
    // collection indices start at 1!
    const auto index = std::distance(std::begin(names), nameIt) + 1;
 
    m_availableBlocks[index] = 1;
    return {dynamic_cast<podio::SIOBlock*>(m_blocks[index].get())->getBuffers()};
  }
 
  return std::nullopt;
}

getIDTable()

podio::CollectionIDTable podio::SIOFrameData::getIDTable ( )

inline

Definition at line 51 of file SIOFrameData.h.

                                      {
    if (m_idTable.empty()) {
      readIdTable();
    }
    return {m_idTable.ids(), m_idTable.names()};
  }

getParameters()

std::unique_ptr< podio::GenericParameters > podio::SIOFrameData::getParameters

(

)

Definition at line 29 of file SIOFrameData.cc.

                                                                  {
  unpackBuffers();
  m_availableBlocks[0] = 0;
  return std::make_unique<podio::GenericParameters>(std::move(m_parameters));
}

operator=() [1/2]

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

delete

operator=() [2/2]

SIOFrameData & podio::SIOFrameData::operator= ( SIOFrameData &&  )

default

---

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

• SIOFrameData.h
• SIOFrameData.cc