Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
ROOT::Experimental::RColumnDescriptor Class Reference

Meta-data stored for every column of an ntuple.

Definition at line 123 of file RNTupleDescriptor.hxx.

Public Member Functions

 RColumnDescriptor ()=default
 
 RColumnDescriptor (const RColumnDescriptor &other)=delete
 
 RColumnDescriptor (RColumnDescriptor &&other)=default
 
RColumnDescriptor Clone () const
 Get a copy of the descriptor.
 
DescriptorId_t GetFieldId () const
 
std::uint64_t GetFirstElementIndex () const
 
std::uint32_t GetIndex () const
 
DescriptorId_t GetLogicalId () const
 
RColumnModel GetModel () const
 
DescriptorId_t GetPhysicalId () const
 
bool IsAliasColumn () const
 
bool IsDeferredColumn () const
 
RColumnDescriptoroperator= (const RColumnDescriptor &other)=delete
 
RColumnDescriptoroperator= (RColumnDescriptor &&other)=default
 
bool operator== (const RColumnDescriptor &other) const
 

Private Attributes

DescriptorId_t fFieldId = kInvalidDescriptorId
 Every column belongs to one and only one field.
 
std::uint64_t fFirstElementIndex = 0U
 Specifies the index for the first stored element for this column.
 
std::uint32_t fIndex
 A field can be serialized into several columns, which are numbered from zero to $n$.
 
DescriptorId_t fLogicalColumnId = kInvalidDescriptorId
 The actual column identifier, which is the link to the corresponding field.
 
RColumnModel fModel
 Contains the column type and whether it is sorted.
 
DescriptorId_t fPhysicalColumnId = kInvalidDescriptorId
 Usually identical to the logical column ID, except for alias columns where it references the shadowed column.
 

Friends

class RColumnDescriptorBuilder
 
class RNTupleDescriptorBuilder
 

#include <ROOT/RNTupleDescriptor.hxx>

Constructor & Destructor Documentation

◆ RColumnDescriptor() [1/3]

ROOT::Experimental::RColumnDescriptor::RColumnDescriptor ( )
default

◆ RColumnDescriptor() [2/3]

ROOT::Experimental::RColumnDescriptor::RColumnDescriptor ( const RColumnDescriptor other)
delete

◆ RColumnDescriptor() [3/3]

ROOT::Experimental::RColumnDescriptor::RColumnDescriptor ( RColumnDescriptor &&  other)
default

Member Function Documentation

◆ Clone()

ROOT::Experimental::RColumnDescriptor ROOT::Experimental::RColumnDescriptor::Clone ( ) const

Get a copy of the descriptor.

Definition at line 99 of file RNTupleDescriptor.cxx.

◆ GetFieldId()

DescriptorId_t ROOT::Experimental::RColumnDescriptor::GetFieldId ( ) const
inline

Definition at line 157 of file RNTupleDescriptor.hxx.

◆ GetFirstElementIndex()

std::uint64_t ROOT::Experimental::RColumnDescriptor::GetFirstElementIndex ( ) const
inline

Definition at line 159 of file RNTupleDescriptor.hxx.

◆ GetIndex()

std::uint32_t ROOT::Experimental::RColumnDescriptor::GetIndex ( ) const
inline

Definition at line 156 of file RNTupleDescriptor.hxx.

◆ GetLogicalId()

DescriptorId_t ROOT::Experimental::RColumnDescriptor::GetLogicalId ( ) const
inline

Definition at line 153 of file RNTupleDescriptor.hxx.

◆ GetModel()

RColumnModel ROOT::Experimental::RColumnDescriptor::GetModel ( ) const
inline

Definition at line 155 of file RNTupleDescriptor.hxx.

◆ GetPhysicalId()

DescriptorId_t ROOT::Experimental::RColumnDescriptor::GetPhysicalId ( ) const
inline

Definition at line 154 of file RNTupleDescriptor.hxx.

◆ IsAliasColumn()

bool ROOT::Experimental::RColumnDescriptor::IsAliasColumn ( ) const
inline

Definition at line 158 of file RNTupleDescriptor.hxx.

◆ IsDeferredColumn()

bool ROOT::Experimental::RColumnDescriptor::IsDeferredColumn ( ) const
inline

Definition at line 160 of file RNTupleDescriptor.hxx.

◆ operator=() [1/2]

RColumnDescriptor & ROOT::Experimental::RColumnDescriptor::operator= ( const RColumnDescriptor other)
delete

◆ operator=() [2/2]

RColumnDescriptor & ROOT::Experimental::RColumnDescriptor::operator= ( RColumnDescriptor &&  other)
default

◆ operator==()

bool ROOT::Experimental::RColumnDescriptor::operator== ( const RColumnDescriptor other) const

Definition at line 91 of file RNTupleDescriptor.cxx.

Friends And Related Symbol Documentation

◆ RColumnDescriptorBuilder

friend class RColumnDescriptorBuilder
friend

Definition at line 124 of file RNTupleDescriptor.hxx.

◆ RNTupleDescriptorBuilder

friend class RNTupleDescriptorBuilder
friend

Definition at line 125 of file RNTupleDescriptor.hxx.

Member Data Documentation

◆ fFieldId

DescriptorId_t ROOT::Experimental::RColumnDescriptor::fFieldId = kInvalidDescriptorId
private

Every column belongs to one and only one field.

Definition at line 135 of file RNTupleDescriptor.hxx.

◆ fFirstElementIndex

std::uint64_t ROOT::Experimental::RColumnDescriptor::fFirstElementIndex = 0U
private

Specifies the index for the first stored element for this column.

For deferred columns the value is greater than 0

Definition at line 140 of file RNTupleDescriptor.hxx.

◆ fIndex

std::uint32_t ROOT::Experimental::RColumnDescriptor::fIndex
private

A field can be serialized into several columns, which are numbered from zero to $n$.

Definition at line 137 of file RNTupleDescriptor.hxx.

◆ fLogicalColumnId

DescriptorId_t ROOT::Experimental::RColumnDescriptor::fLogicalColumnId = kInvalidDescriptorId
private

The actual column identifier, which is the link to the corresponding field.

Definition at line 129 of file RNTupleDescriptor.hxx.

◆ fModel

RColumnModel ROOT::Experimental::RColumnDescriptor::fModel
private

Contains the column type and whether it is sorted.

Definition at line 133 of file RNTupleDescriptor.hxx.

◆ fPhysicalColumnId

DescriptorId_t ROOT::Experimental::RColumnDescriptor::fPhysicalColumnId = kInvalidDescriptorId
private

Usually identical to the logical column ID, except for alias columns where it references the shadowed column.

Definition at line 131 of file RNTupleDescriptor.hxx.

Libraries for ROOT::Experimental::RColumnDescriptor:

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