df/d76/ICollectionCursor_8h_source.html

/*

  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration

*/


#ifndef COLLECTIONSVC_ICOLLECTIONCURSOR_H

#define COLLECTIONSVC_ICOLLECTIONCURSOR_H


#include <cstddef>


class Token;


namespace pool {


  class CollectionRowBuffer;


  class ICollectionCursor

  {

  public:

    virtual std::size_t size() = 0;


    virtual bool seek(std::size_t position) = 0;


    virtual bool next() = 0;


    virtual const pool::CollectionRowBuffer& currentRow() const = 0;


    virtual const Token& eventRef() const = 0;


    virtual void close() = 0;


//  protected:   // MN: why protected?

    virtual ~ICollectionCursor() {}

  };


}


#endif


Token
This class provides a token that identifies in a unique way objects on the persistent storage.
Definition Token.h:22

pool::CollectionRowBuffer
A class representing a row of a collection.
Definition CollectionRowBuffer.h:25

pool::ICollectionCursor
An interface used to navigate the result of a query on a collection.
Definition ICollectionCursor.h:22

pool::ICollectionCursor::next
virtual bool next()=0
Advances the cursor to the next row of the query result set.

pool::ICollectionCursor::eventRef
virtual const Token & eventRef() const =0
Returns the event reference Token for the current row.

pool::ICollectionCursor::size
virtual std::size_t size()=0
Returns the size of the collection.

pool::ICollectionCursor::currentRow
virtual const pool::CollectionRowBuffer & currentRow() const =0
Returns the selected Tokens and Attributes for the current row of the query result set.

pool::ICollectionCursor::seek
virtual bool seek(std::size_t position)=0
Seek to a given position in the collection.

pool::ICollectionCursor::close
virtual void close()=0
Cleanup.

pool::ICollectionCursor::~ICollectionCursor
virtual ~ICollectionCursor()
Empty destructor.
Definition ICollectionCursor.h:44

pool
Framework include files.
Definition libname.h:15