Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
ROOT::Internal::RReadColumn Class Reference

Definition at line 96 of file RColumn.hxx.

Classes

struct  RTeam
 The column team is a set of columns that serve the same column index for different representation IDs. More...
 

Public Types

enum class  EColumnType { kRead , kWrite }
 

Public Member Functions

 ~RReadColumn ()
 
void ConnectPageSource (ROOT::DescriptorId_t fieldId, ROOT::Internal::RPageSource &pageSource)
 Connect the column to a page source.
 
RReadColumn * ForReading ()
 
const RReadColumn * ForReading () const
 
RWriteColumn * ForWriting ()
 
const RWriteColumn * ForWriting () const
 
std::uint16_t GetBitsOnStorage () const
 
RNTupleLocalIndex GetClusterIndex (ROOT::NTupleSize_t globalIndex)
 
void GetCollectionInfo (const ROOT::NTupleSize_t globalIndex, RNTupleLocalIndex *collectionStart, ROOT::NTupleSize_t *collectionSize)
 For offset columns only, look at the two adjacent values that define a collection's coordinates.
 
void GetCollectionInfo (RNTupleLocalIndex localIndex, RNTupleLocalIndex *collectionStart, ROOT::NTupleSize_t *collectionSize)
 
ROOT::Internal::RColumnElementBase * GetElement () const
 
ROOT::NTupleSize_t GetGlobalIndex (RNTupleLocalIndex clusterIndex)
 
std::uint32_t GetIndex () const
 
ROOT::DescriptorId_t GetOnDiskId () const
 
const RPageSource * GetPageSource () const
 
std::uint16_t GetRepresentationIndex () const
 
void GetSwitchInfo (ROOT::NTupleSize_t globalIndex, RNTupleLocalIndex *varIndex, std::uint32_t *tag)
 Get the currently active cluster id.
 
ROOT::ENTupleColumnType GetType () const
 
std::optional< std::pair< double, double > > GetValueRange () const
 
template<typename CppT >
CppT * Map (const ROOT::NTupleSize_t globalIndex)
 
template<typename CppT >
CppT * Map (RNTupleLocalIndex localIndex)
 
void MapPage (RNTupleLocalIndex localIndex)
 
void MapPage (ROOT::NTupleSize_t globalIndex)
 
template<typename CppT >
CppT * MapV (const ROOT::NTupleSize_t globalIndex, ROOT::NTupleSize_t &nItems)
 
template<typename CppT >
CppT * MapV (RNTupleLocalIndex localIndex, ROOT::NTupleSize_t &nItems)
 
void MergeTeams (RReadColumn &other)
 
void Read (const ROOT::NTupleSize_t globalIndex, void *to)
 
void Read (RNTupleLocalIndex localIndex, void *to)
 
void ReadV (RNTupleLocalIndex localIndex, ROOT::NTupleSize_t count, void *to)
 
void ReadV (ROOT::NTupleSize_t globalIndex, ROOT::NTupleSize_t count, void *to)
 
void SetBitsOnStorage (std::size_t bits)
 
void SetValueRange (double min, double max)
 
bool TryMapPage (RNTupleLocalIndex localIndex)
 
bool TryMapPage (ROOT::NTupleSize_t globalIndex)
 

Static Public Member Functions

template<typename CppT >
static std::unique_ptr< RReadColumn > Create (ROOT::ENTupleColumnType type, std::uint32_t columnIdx, std::uint16_t representationIdx)
 

Protected Member Functions

ROOT::Internal::RPageStorage::ColumnHandle_t MakeHandle ()
 

Protected Attributes

std::unique_ptr< ROOT::Internal::RColumnElementBase > fElement
 Used to pack and unpack pages on writing/reading.
 
std::uint32_t fIndex
 Columns belonging to the same field are distinguished by their order.
 
ROOT::DescriptorId_t fOnDiskId = ROOT::kInvalidDescriptorId
 The column id in the column descriptor, once connected to a sink or source.
 
std::uint16_t fRepresentationIndex
 Fields can have multiple column representations, distinguished by representation index.
 
ROOT::ENTupleColumnType fType
 

Private Member Functions

 RReadColumn (ROOT::ENTupleColumnType type, std::uint32_t columnIndex, std::uint16_t representationIndex)
 

Private Attributes

ROOT::Internal::RPageSource * fPageSource = nullptr
 
ROOT::Internal::RPageRef fReadPageRef
 The currently mapped page for reading.
 
std::unique_ptr< RTeam > fTeam
 As an optimization, if unset the team contains consists of this column only.
 

#include <ROOT/RColumn.hxx>

Inheritance diagram for ROOT::Internal::RReadColumn:
[legend]

Member Enumeration Documentation

◆ EColumnType

enum class ROOT::Internal::RColumn::EColumnType
stronginherited
Enumerator
kRead 
kWrite 

Definition at line 61 of file RColumn.hxx.

Constructor & Destructor Documentation

◆ RReadColumn()

ROOT::Internal::RReadColumn::RReadColumn ( ROOT::ENTupleColumnType type,
std::uint32_t columnIndex,
std::uint16_t representationIndex )
inlineprivate

Definition at line 113 of file RColumn.hxx.

◆ ~RReadColumn()

ROOT::Internal::RReadColumn::~RReadColumn ( )

Definition at line 67 of file RColumn.cxx.

Member Function Documentation

◆ ConnectPageSource()

void ROOT::Internal::RReadColumn::ConnectPageSource ( ROOT::DescriptorId_t fieldId,
ROOT::Internal::RPageSource & pageSource )

Connect the column to a page source.

Definition at line 61 of file RColumn.cxx.

◆ Create()

template<typename CppT >
static std::unique_ptr< RReadColumn > ROOT::Internal::RReadColumn::Create ( ROOT::ENTupleColumnType type,
std::uint32_t columnIdx,
std::uint16_t representationIdx )
inlinestatic

Definition at line 121 of file RColumn.hxx.

◆ ForReading() [1/2]

RReadColumn * ROOT::Internal::RColumn::ForReading ( )
inlineinherited

Definition at line 413 of file RColumn.hxx.

◆ ForReading() [2/2]

const RReadColumn * ROOT::Internal::RColumn::ForReading ( ) const
inlineinherited

Definition at line 417 of file RColumn.hxx.

◆ ForWriting() [1/2]

RWriteColumn * ROOT::Internal::RColumn::ForWriting ( )
inlineinherited

Definition at line 421 of file RColumn.hxx.

◆ ForWriting() [2/2]

const RWriteColumn * ROOT::Internal::RColumn::ForWriting ( ) const
inlineinherited

Definition at line 425 of file RColumn.hxx.

◆ GetBitsOnStorage()

std::uint16_t ROOT::Internal::RColumn::GetBitsOnStorage ( ) const
inlineinherited

Definition at line 78 of file RColumn.hxx.

◆ GetClusterIndex()

RNTupleLocalIndex ROOT::Internal::RReadColumn::GetClusterIndex ( ROOT::NTupleSize_t globalIndex)
inline

Definition at line 246 of file RColumn.hxx.

◆ GetCollectionInfo() [1/2]

void ROOT::Internal::RReadColumn::GetCollectionInfo ( const ROOT::NTupleSize_t globalIndex,
RNTupleLocalIndex * collectionStart,
ROOT::NTupleSize_t * collectionSize )
inline

For offset columns only, look at the two adjacent values that define a collection's coordinates.

Definition at line 256 of file RColumn.hxx.

◆ GetCollectionInfo() [2/2]

void ROOT::Internal::RReadColumn::GetCollectionInfo ( RNTupleLocalIndex localIndex,
RNTupleLocalIndex * collectionStart,
ROOT::NTupleSize_t * collectionSize )
inline

Definition at line 280 of file RColumn.hxx.

◆ GetElement()

ROOT::Internal::RColumnElementBase * ROOT::Internal::RColumn::GetElement ( ) const
inlineinherited

Definition at line 76 of file RColumn.hxx.

◆ GetGlobalIndex()

ROOT::NTupleSize_t ROOT::Internal::RReadColumn::GetGlobalIndex ( RNTupleLocalIndex clusterIndex)
inline

Definition at line 238 of file RColumn.hxx.

◆ GetIndex()

std::uint32_t ROOT::Internal::RColumn::GetIndex ( ) const
inlineinherited

Definition at line 88 of file RColumn.hxx.

◆ GetOnDiskId()

ROOT::DescriptorId_t ROOT::Internal::RColumn::GetOnDiskId ( ) const
inlineinherited

Definition at line 90 of file RColumn.hxx.

◆ GetPageSource()

const RPageSource * ROOT::Internal::RReadColumn::GetPageSource ( ) const
inline

Definition at line 306 of file RColumn.hxx.

◆ GetRepresentationIndex()

std::uint16_t ROOT::Internal::RColumn::GetRepresentationIndex ( ) const
inlineinherited

Definition at line 89 of file RColumn.hxx.

◆ GetSwitchInfo()

void ROOT::Internal::RReadColumn::GetSwitchInfo ( ROOT::NTupleSize_t globalIndex,
RNTupleLocalIndex * varIndex,
std::uint32_t * tag )
inline

Get the currently active cluster id.

Definition at line 291 of file RColumn.hxx.

◆ GetType()

ROOT::ENTupleColumnType ROOT::Internal::RColumn::GetType ( ) const
inlineinherited

Definition at line 77 of file RColumn.hxx.

◆ GetValueRange()

std::optional< std::pair< double, double > > ROOT::Internal::RColumn::GetValueRange ( ) const
inlineinherited

Definition at line 83 of file RColumn.hxx.

◆ MakeHandle()

ROOT::Internal::RPageStorage::ColumnHandle_t ROOT::Internal::RColumn::MakeHandle ( )
inlineprotectedinherited

Definition at line 58 of file RColumn.hxx.

◆ Map() [1/2]

template<typename CppT >
CppT * ROOT::Internal::RReadColumn::Map ( const ROOT::NTupleSize_t globalIndex)
inline

Definition at line 200 of file RColumn.hxx.

◆ Map() [2/2]

template<typename CppT >
CppT * ROOT::Internal::RReadColumn::Map ( RNTupleLocalIndex localIndex)
inline

Definition at line 207 of file RColumn.hxx.

◆ MapPage() [1/2]

void ROOT::Internal::RReadColumn::MapPage ( RNTupleLocalIndex localIndex)
inline

Definition at line 299 of file RColumn.hxx.

◆ MapPage() [2/2]

void ROOT::Internal::RReadColumn::MapPage ( ROOT::NTupleSize_t globalIndex)
inline

Definition at line 298 of file RColumn.hxx.

◆ MapV() [1/2]

template<typename CppT >
CppT * ROOT::Internal::RReadColumn::MapV ( const ROOT::NTupleSize_t globalIndex,
ROOT::NTupleSize_t & nItems )
inline

Definition at line 214 of file RColumn.hxx.

◆ MapV() [2/2]

template<typename CppT >
CppT * ROOT::Internal::RReadColumn::MapV ( RNTupleLocalIndex localIndex,
ROOT::NTupleSize_t & nItems )
inline

Definition at line 226 of file RColumn.hxx.

◆ MergeTeams()

void ROOT::Internal::RReadColumn::MergeTeams ( RReadColumn & other)

Definition at line 113 of file RColumn.cxx.

◆ Read() [1/2]

void ROOT::Internal::RReadColumn::Read ( const ROOT::NTupleSize_t globalIndex,
void * to )
inline

Definition at line 133 of file RColumn.hxx.

◆ Read() [2/2]

void ROOT::Internal::RReadColumn::Read ( RNTupleLocalIndex localIndex,
void * to )
inline

Definition at line 144 of file RColumn.hxx.

◆ ReadV() [1/2]

void ROOT::Internal::RReadColumn::ReadV ( RNTupleLocalIndex localIndex,
ROOT::NTupleSize_t count,
void * to )
inline

Definition at line 177 of file RColumn.hxx.

◆ ReadV() [2/2]

void ROOT::Internal::RReadColumn::ReadV ( ROOT::NTupleSize_t globalIndex,
ROOT::NTupleSize_t count,
void * to )
inline

Definition at line 155 of file RColumn.hxx.

◆ SetBitsOnStorage()

void ROOT::Internal::RColumn::SetBitsOnStorage ( std::size_t bits)
inlineinherited

Definition at line 92 of file RColumn.hxx.

◆ SetValueRange()

void ROOT::Internal::RColumn::SetValueRange ( double min,
double max )
inlineinherited

Definition at line 93 of file RColumn.hxx.

◆ TryMapPage() [1/2]

bool ROOT::Internal::RReadColumn::TryMapPage ( RNTupleLocalIndex localIndex)

Definition at line 93 of file RColumn.cxx.

◆ TryMapPage() [2/2]

bool ROOT::Internal::RReadColumn::TryMapPage ( ROOT::NTupleSize_t globalIndex)

Definition at line 73 of file RColumn.cxx.

Member Data Documentation

◆ fElement

std::unique_ptr<ROOT::Internal::RColumnElementBase> ROOT::Internal::RColumn::fElement
protectedinherited

Used to pack and unpack pages on writing/reading.

Definition at line 45 of file RColumn.hxx.

◆ fIndex

std::uint32_t ROOT::Internal::RColumn::fIndex
protectedinherited

Columns belonging to the same field are distinguished by their order.

E.g. for an std::string field, there is the offset column with index 0 and the character value column with index 1.

Definition at line 48 of file RColumn.hxx.

◆ fOnDiskId

ROOT::DescriptorId_t ROOT::Internal::RColumn::fOnDiskId = ROOT::kInvalidDescriptorId
protectedinherited

The column id in the column descriptor, once connected to a sink or source.

Definition at line 43 of file RColumn.hxx.

◆ fPageSource

ROOT::Internal::RPageSource* ROOT::Internal::RReadColumn::fPageSource = nullptr
private

Definition at line 107 of file RColumn.hxx.

◆ fReadPageRef

ROOT::Internal::RPageRef ROOT::Internal::RReadColumn::fReadPageRef
private

The currently mapped page for reading.

Definition at line 109 of file RColumn.hxx.

◆ fRepresentationIndex

std::uint16_t ROOT::Internal::RColumn::fRepresentationIndex
protectedinherited

Fields can have multiple column representations, distinguished by representation index.

Definition at line 50 of file RColumn.hxx.

◆ fTeam

std::unique_ptr<RTeam> ROOT::Internal::RReadColumn::fTeam
private

As an optimization, if unset the team contains consists of this column only.

Definition at line 111 of file RColumn.hxx.

◆ fType

ROOT::ENTupleColumnType ROOT::Internal::RColumn::fType
protectedinherited

Definition at line 51 of file RColumn.hxx.

Libraries for ROOT::Internal::RReadColumn:

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