pool::CollectionCursor Class Reference

Reader object for Collections. More...

#include <CollectionCursor.h>

Collaboration diagram for pool::CollectionCursor:

Public Member Functions
	CollectionCursor (const CollectionRowBuffer &collectionRowBuffer, ContainerMap &attrContainers)
bool	next ()
	Advances the cursor to the next row of the result set.
const CollectionRowBuffer &	currentRow () const
	Returns the selected Tokens and Attributes for the current row of the result set.
std::size_t	size ()
	Return the size of the collection.
bool	seek (std::size_t position)
	Seeks the cursor to a given position in the collection.
const Token &	eventRef () const
	Returns the event reference Token for the current row.

Private Attributes
CollectionRowBuffer	m_collectionRowBuffer
	Row buffer containing the Token and Attributes.
ContainerMap &	m_attrContainers
DbContainer &	m_tokenContainer
	Container for the event reference.
std::string	m_tokenStr
	Temporary storage for Event Reference in string format as it is in RNTuple.
std::size_t	m_idx

Detailed Description

Reader object for Collections.

Definition at line 27 of file CollectionCursor.h.

Constructor & Destructor Documentation

CollectionCursor()

CollectionCursor::CollectionCursor	(	const CollectionRowBuffer &	collectionRowBuffer,
		ContainerMap &	attrContainers )

Definition at line 15 of file CollectionCursor.cxx.

   : m_collectionRowBuffer( collectionRowBuffer ),
      m_attrContainers( containers ),
      m_tokenContainer( containers[CollectionColumn::tokenColumn().name()] ),
      m_idx( -1 )
{
}

Member Function Documentation

currentRow()

const pool::CollectionRowBuffer & CollectionCursor::currentRow

(

)

const

Returns the selected Tokens and Attributes for the current row of the result set.

Definition at line 62 of file CollectionCursor.cxx.

{
  return m_collectionRowBuffer;
}

eventRef()

const Token & CollectionCursor::eventRef

(

)

const

Returns the event reference Token for the current row.

Definition at line 84 of file CollectionCursor.cxx.

{
   return m_collectionRowBuffer.token();
}

next()

bool CollectionCursor::next

(

)

Advances the cursor to the next row of the result set.

Definition at line 27 of file CollectionCursor.cxx.

{
   if( ++m_idx >= size() ) {
      return false;
   }
   // read the row
   Token cnt_token(m_tokenContainer.token());
   Token::OID_t oid { cnt_token.oid().first, (std::int64_t)m_idx };
   for( auto& attr : m_collectionRowBuffer.attributeList() ) {
      const std::string& attr_name = attr.specification().name();
      DbContainer &container = m_attrContainers.at( attr_name );
      void *obj = attr.addressOfData();
      if( !container.load( &obj, nullptr, oid ).isSuccess() ) {
         return false;
      }
   }
 
   const std::string& newDHContName = std::format("{}(DataHeader)", APRDefaults::ReadConfig::getDataHeaderName( cnt_token.dbID().toString() ));
   const std::string& oldDHContName = std::format("{}_DataHeader",  APRDefaults::ReadConfig::getDataHeaderName( cnt_token.dbID().toString() ));
   if( cnt_token.contID() == newDHContName || cnt_token.contID() == oldDHContName ) {
      cnt_token.setOid(oid);
      m_tokenStr = cnt_token.toString();
   } else {
      // read the Token
      void *token_addr = &m_tokenStr;
      if( !m_tokenContainer.load( &token_addr, nullptr, oid ).isSuccess() ) {
         return false;
      }
   }
   m_collectionRowBuffer.token().fromString( m_tokenStr );
   return true;
}

seek()

bool CollectionCursor::seek

(

std::size_t

position

)

Seeks the cursor to a given position in the collection.

Definition at line 74 of file CollectionCursor.cxx.

{
   if( position >= size() ) {
      return false;
   }
   m_idx = position-1;
   return true;
}

size()

std::size_t CollectionCursor::size

(

)

Return the size of the collection.

Definition at line 68 of file CollectionCursor.cxx.

{
  return m_tokenContainer.size();
}

Member Data Documentation

m_attrContainers

ContainerMap& pool::CollectionCursor::m_attrContainers

private

Definition at line 54 of file CollectionCursor.h.

m_collectionRowBuffer

CollectionRowBuffer pool::CollectionCursor::m_collectionRowBuffer

private

Row buffer containing the Token and Attributes.

Definition at line 52 of file CollectionCursor.h.

m_idx

std::size_t pool::CollectionCursor::m_idx

private

Definition at line 62 of file CollectionCursor.h.

m_tokenContainer

DbContainer& pool::CollectionCursor::m_tokenContainer

private

Container for the event reference.

Definition at line 57 of file CollectionCursor.h.

m_tokenStr

std::string pool::CollectionCursor::m_tokenStr

private

Temporary storage for Event Reference in string format as it is in RNTuple.

Definition at line 60 of file CollectionCursor.h.

---

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

• CollectionCursor.h
• CollectionCursor.cxx