Logo ROOT   master
Reference Guide
ROOT::Experimental::Detail::RPage Class Reference


A page is a slice of a column that is mapped into memory

The page provides an opaque memory buffer for uncompressed, unpacked data. It does not interpret the contents but it does now about the size (and thus the number) of the elements inside as well as the element number range within the backing column/cluster. The memory buffer is not managed by the page. It is normally registered with the page pool and allocated/freed by the page storage.

Definition at line 41 of file RPage.hxx.

Classes

class  RClusterInfo
 Stores information about the cluster in which this page resides. More...
 

Public Member Functions

 RPage ()
 
 RPage (ColumnId_t columnId, void *buffer, ClusterSize_t::ValueType capacity, ClusterSize_t::ValueType elementSize)
 
 ~RPage ()=default
 
bool Contains (NTupleSize_t globalIndex) const
 
bool Contains (const RClusterIndex &clusterIndex) const
 
voidGetBuffer () const
 
ClusterSize_t::ValueType GetCapacity () const
 The total space available in the page. More...
 
const RClusterInfoGetClusterInfo () const
 
ClusterSize_t::ValueType GetClusterRangeFirst () const
 
ClusterSize_t::ValueType GetClusterRangeLast () const
 
ColumnId_t GetColumnId ()
 
ClusterSize_t::ValueType GetElementSize () const
 
NTupleSize_t GetGlobalRangeFirst () const
 
NTupleSize_t GetGlobalRangeLast () const
 
ClusterSize_t::ValueType GetNElements () const
 
ClusterSize_t::ValueType GetSize () const
 The space taken by column elements in the buffer. More...
 
bool IsNull () const
 
bool operator!= (const RPage &other) const
 
bool operator== (const RPage &other) const
 
void Reset (NTupleSize_t rangeFirst)
 Forget all currently stored elements (size == 0) and set a new starting index. More...
 
void ResetCluster (const RClusterInfo &clusterInfo)
 
void SetWindow (const NTupleSize_t rangeFirst, const RClusterInfo &clusterInfo)
 Seek the page to a certain position of the column. More...
 
voidTryGrow (ClusterSize_t::ValueType nElements)
 Return a pointer after the last element that has space for nElements new elements. More...
 

Private Attributes

voidfBuffer
 
ClusterSize_t::ValueType fCapacity
 
RClusterInfo fClusterInfo
 
ColumnId_t fColumnId
 
ClusterSize_t::ValueType fElementSize
 
ClusterSize_t::ValueType fNElements
 
NTupleSize_t fRangeFirst
 

#include <ROOT/RPage.hxx>

Constructor & Destructor Documentation

◆ RPage() [1/2]

ROOT::Experimental::Detail::RPage::RPage ( )
inline

Definition at line 69 of file RPage.hxx.

◆ RPage() [2/2]

ROOT::Experimental::Detail::RPage::RPage ( ColumnId_t  columnId,
void buffer,
ClusterSize_t::ValueType  capacity,
ClusterSize_t::ValueType  elementSize 
)
inline

Definition at line 71 of file RPage.hxx.

◆ ~RPage()

ROOT::Experimental::Detail::RPage::~RPage ( )
default

Member Function Documentation

◆ Contains() [1/2]

bool ROOT::Experimental::Detail::RPage::Contains ( NTupleSize_t  globalIndex) const
inline

Definition at line 92 of file RPage.hxx.

◆ Contains() [2/2]

bool ROOT::Experimental::Detail::RPage::Contains ( const RClusterIndex clusterIndex) const
inline

Definition at line 96 of file RPage.hxx.

◆ GetBuffer()

void* ROOT::Experimental::Detail::RPage::GetBuffer ( ) const
inline

Definition at line 104 of file RPage.hxx.

◆ GetCapacity()

ClusterSize_t::ValueType ROOT::Experimental::Detail::RPage::GetCapacity ( ) const
inline

The total space available in the page.

Definition at line 79 of file RPage.hxx.

◆ GetClusterInfo()

const RClusterInfo& ROOT::Experimental::Detail::RPage::GetClusterInfo ( ) const
inline

Definition at line 90 of file RPage.hxx.

◆ GetClusterRangeFirst()

ClusterSize_t::ValueType ROOT::Experimental::Detail::RPage::GetClusterRangeFirst ( ) const
inline

Definition at line 86 of file RPage.hxx.

◆ GetClusterRangeLast()

ClusterSize_t::ValueType ROOT::Experimental::Detail::RPage::GetClusterRangeLast ( ) const
inline

Definition at line 87 of file RPage.hxx.

◆ GetColumnId()

ColumnId_t ROOT::Experimental::Detail::RPage::GetColumnId ( )
inline

Definition at line 77 of file RPage.hxx.

◆ GetElementSize()

ClusterSize_t::ValueType ROOT::Experimental::Detail::RPage::GetElementSize ( ) const
inline

Definition at line 82 of file RPage.hxx.

◆ GetGlobalRangeFirst()

NTupleSize_t ROOT::Experimental::Detail::RPage::GetGlobalRangeFirst ( ) const
inline

Definition at line 84 of file RPage.hxx.

◆ GetGlobalRangeLast()

NTupleSize_t ROOT::Experimental::Detail::RPage::GetGlobalRangeLast ( ) const
inline

Definition at line 85 of file RPage.hxx.

◆ GetNElements()

ClusterSize_t::ValueType ROOT::Experimental::Detail::RPage::GetNElements ( ) const
inline

Definition at line 83 of file RPage.hxx.

◆ GetSize()

ClusterSize_t::ValueType ROOT::Experimental::Detail::RPage::GetSize ( ) const
inline

The space taken by column elements in the buffer.

Definition at line 81 of file RPage.hxx.

◆ IsNull()

bool ROOT::Experimental::Detail::RPage::IsNull ( ) const
inline

Definition at line 125 of file RPage.hxx.

◆ operator!=()

bool ROOT::Experimental::Detail::RPage::operator!= ( const RPage other) const
inline

Definition at line 127 of file RPage.hxx.

◆ operator==()

bool ROOT::Experimental::Detail::RPage::operator== ( const RPage other) const
inline

Definition at line 126 of file RPage.hxx.

◆ Reset()

void ROOT::Experimental::Detail::RPage::Reset ( NTupleSize_t  rangeFirst)
inline

Forget all currently stored elements (size == 0) and set a new starting index.

Definition at line 122 of file RPage.hxx.

◆ ResetCluster()

void ROOT::Experimental::Detail::RPage::ResetCluster ( const RClusterInfo clusterInfo)
inline

Definition at line 123 of file RPage.hxx.

◆ SetWindow()

void ROOT::Experimental::Detail::RPage::SetWindow ( const NTupleSize_t  rangeFirst,
const RClusterInfo clusterInfo 
)
inline

Seek the page to a certain position of the column.

Definition at line 117 of file RPage.hxx.

◆ TryGrow()

void* ROOT::Experimental::Detail::RPage::TryGrow ( ClusterSize_t::ValueType  nElements)
inline

Return a pointer after the last element that has space for nElements new elements.

If there is not enough capacity, return nullptr

Definition at line 107 of file RPage.hxx.

Member Data Documentation

◆ fBuffer

void* ROOT::Experimental::Detail::RPage::fBuffer
private

Definition at line 61 of file RPage.hxx.

◆ fCapacity

ClusterSize_t::ValueType ROOT::Experimental::Detail::RPage::fCapacity
private

Definition at line 62 of file RPage.hxx.

◆ fClusterInfo

RClusterInfo ROOT::Experimental::Detail::RPage::fClusterInfo
private

Definition at line 66 of file RPage.hxx.

◆ fColumnId

ColumnId_t ROOT::Experimental::Detail::RPage::fColumnId
private

Definition at line 60 of file RPage.hxx.

◆ fElementSize

ClusterSize_t::ValueType ROOT::Experimental::Detail::RPage::fElementSize
private

Definition at line 63 of file RPage.hxx.

◆ fNElements

ClusterSize_t::ValueType ROOT::Experimental::Detail::RPage::fNElements
private

Definition at line 64 of file RPage.hxx.

◆ fRangeFirst

NTupleSize_t ROOT::Experimental::Detail::RPage::fRangeFirst
private

Definition at line 65 of file RPage.hxx.


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