Logo ROOT  

Reference Guide
 
Loading...
Searching...
No Matches
List of all members | Public Member Functions | Static Public Attributes | Private Attributes | Friends | List of all members
ROOT::Experimental::RColumnDescriptor Class Reference

Meta-data stored for every column of an ntuple.

Definition at line 122 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
 
DescriptorId_t GetId () const
 
std::uint32_t GetIndex () const
 
RColumnModel GetModel () const
 
RNTupleVersion GetVersion () const
 
RColumnDescriptor & operator= (const RColumnDescriptor &other)=delete
 
RColumnDescriptor & operator= (RColumnDescriptor &&other)=default
 
bool operator== (const RColumnDescriptor &other) const
 

Static Public Attributes

static constexpr std::uint16_t kFrameVersionCurrent = 0
 In order to handle changes to the serialization routine in future ntuple versions.
 
static constexpr std::uint16_t kFrameVersionMin = 0
 

Private Attributes

DescriptorId_t fColumnId = kInvalidDescriptorId
 
DescriptorId_t fFieldId = kInvalidDescriptorId
 Every column belongs to one and only one field.
 
std::uint32_t fIndex
 A field can be serialized into several columns, which are numbered from zero to $n$.
 
RColumnModel fModel
 Contains the column type and whether it is sorted.
 
RNTupleVersion fVersion
 Versions can change, e.g., when new column types are added.
 

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 436 of file RNTupleDescriptor.cxx.

◆ GetFieldId()

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

Definition at line 156 of file RNTupleDescriptor.hxx.

◆ GetId()

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

Definition at line 152 of file RNTupleDescriptor.hxx.

◆ GetIndex()

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

Definition at line 155 of file RNTupleDescriptor.hxx.

◆ GetModel()

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

Definition at line 154 of file RNTupleDescriptor.hxx.

◆ GetVersion()

RNTupleVersion ROOT::Experimental::RColumnDescriptor::GetVersion ( ) const
inline

Definition at line 153 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 425 of file RNTupleDescriptor.cxx.

Friends And Related Symbol Documentation

◆ RColumnDescriptorBuilder

friend class RColumnDescriptorBuilder
friend

Definition at line 123 of file RNTupleDescriptor.hxx.

◆ RNTupleDescriptorBuilder

friend class RNTupleDescriptorBuilder
friend

Definition at line 124 of file RNTupleDescriptor.hxx.

Member Data Documentation

◆ fColumnId

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

Definition at line 127 of file RNTupleDescriptor.hxx.

◆ fFieldId

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

Every column belongs to one and only one field.

Definition at line 133 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 135 of file RNTupleDescriptor.hxx.

◆ fModel

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

Contains the column type and whether it is sorted.

Definition at line 131 of file RNTupleDescriptor.hxx.

◆ fVersion

RNTupleVersion ROOT::Experimental::RColumnDescriptor::fVersion
private

Versions can change, e.g., when new column types are added.

Definition at line 129 of file RNTupleDescriptor.hxx.

◆ kFrameVersionCurrent

constexpr std::uint16_t ROOT::Experimental::RColumnDescriptor::kFrameVersionCurrent = 0
staticconstexpr

In order to handle changes to the serialization routine in future ntuple versions.

Definition at line 139 of file RNTupleDescriptor.hxx.

◆ kFrameVersionMin

constexpr std::uint16_t ROOT::Experimental::RColumnDescriptor::kFrameVersionMin = 0
staticconstexpr

Definition at line 140 of file RNTupleDescriptor.hxx.

Libraries for ROOT::Experimental::RColumnDescriptor:
[legend]
The documentation for this class was generated from the following files: