Logo ROOT  
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 elementSize, ClusterSize_t::ValueType maxElements)
 
 ~RPage ()=default
 
void ChangeIds (DescriptorId_t columnId, DescriptorId_t clusterId)
 Used by virtual page sources to map the physical column and cluster IDs to ther virtual counterparts. More...
 
bool Contains (const RClusterIndex &clusterIndex) const
 
bool Contains (NTupleSize_t globalIndex) const
 
voidGetBuffer () const
 
const RClusterInfoGetClusterInfo () const
 
ClusterSize_t::ValueType GetClusterRangeFirst () const
 
ClusterSize_t::ValueType GetClusterRangeLast () const
 
ColumnId_t GetColumnId () const
 
ClusterSize_t::ValueType GetElementSize () const
 
NTupleSize_t GetGlobalRangeFirst () const
 
NTupleSize_t GetGlobalRangeLast () const
 
ClusterSize_t::ValueType GetMaxElements () const
 
ClusterSize_t::ValueType GetNBytes () const
 The space taken by column elements in the buffer. More...
 
ClusterSize_t::ValueType GetNElements () const
 
voidGrowUnchecked (ClusterSize_t::ValueType nElements)
 Called during writing: returns a pointer after the last element and increases the element counter in anticipation of the caller filling nElements in the page. More...
 
bool IsEmpty () const
 
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...
 

Private Attributes

voidfBuffer
 
RClusterInfo fClusterInfo
 
ColumnId_t fColumnId
 
ClusterSize_t::ValueType fElementSize
 
ClusterSize_t::ValueType fMaxElements
 The capacity of the page in number of elements. More...
 
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 70 of file RPage.hxx.

◆ RPage() [2/2]

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

Definition at line 73 of file RPage.hxx.

◆ ~RPage()

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

Member Function Documentation

◆ ChangeIds()

void ROOT::Experimental::Detail::RPage::ChangeIds ( DescriptorId_t  columnId,
DescriptorId_t  clusterId 
)
inline

Used by virtual page sources to map the physical column and cluster IDs to ther virtual counterparts.

Definition at line 124 of file RPage.hxx.

◆ Contains() [1/2]

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

Definition at line 97 of file RPage.hxx.

◆ Contains() [2/2]

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

Definition at line 93 of file RPage.hxx.

◆ GetBuffer()

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

Definition at line 105 of file RPage.hxx.

◆ GetClusterInfo()

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

Definition at line 91 of file RPage.hxx.

◆ GetClusterRangeFirst()

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

Definition at line 87 of file RPage.hxx.

◆ GetClusterRangeLast()

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

Definition at line 88 of file RPage.hxx.

◆ GetColumnId()

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

Definition at line 79 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 85 of file RPage.hxx.

◆ GetGlobalRangeLast()

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

Definition at line 86 of file RPage.hxx.

◆ GetMaxElements()

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

Definition at line 84 of file RPage.hxx.

◆ GetNBytes()

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

The space taken by column elements in the buffer.

Definition at line 81 of file RPage.hxx.

◆ GetNElements()

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

Definition at line 83 of file RPage.hxx.

◆ GrowUnchecked()

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

Called during writing: returns a pointer after the last element and increases the element counter in anticipation of the caller filling nElements in the page.

It is the responsibility of the caller to prevent page overflows, i.e. that fNElements + nElements <= fMaxElements

Definition at line 109 of file RPage.hxx.

◆ IsEmpty()

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

Definition at line 131 of file RPage.hxx.

◆ IsNull()

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

Definition at line 130 of file RPage.hxx.

◆ operator!=()

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

Definition at line 133 of file RPage.hxx.

◆ operator==()

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

Definition at line 132 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 120 of file RPage.hxx.

◆ ResetCluster()

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

Definition at line 121 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 115 of file RPage.hxx.

Member Data Documentation

◆ fBuffer

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

Definition at line 61 of file RPage.hxx.

◆ fClusterInfo

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

Definition at line 67 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 62 of file RPage.hxx.

◆ fMaxElements

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

The capacity of the page in number of elements.

Definition at line 65 of file RPage.hxx.

◆ fNElements

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

Definition at line 63 of file RPage.hxx.

◆ fRangeFirst

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

Definition at line 66 of file RPage.hxx.


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