Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RColumnDescriptorBuilder Class Referencefinal

A helper class for piece-wise construction of an RColumnDescriptor.

Dangling column descriptors can become actual descriptors when added to an RNTupleDescriptorBuilder instance and then linked to their fields.

Definition at line 1413 of file RNTupleDescriptor.hxx.

Public Member Functions

 RColumnDescriptorBuilder ()=default
 Make an empty column descriptor builder.
 
RColumnDescriptorBuilderBitsOnStorage (std::uint16_t bitsOnStorage)
 
RColumnDescriptorBuilderFieldId (ROOT::DescriptorId_t fieldId)
 
RColumnDescriptorBuilderFirstElementIndex (std::uint64_t firstElementIdx)
 
ROOT::DescriptorId_t GetFieldId () const
 
ROOT::DescriptorId_t GetRepresentationIndex () const
 
RColumnDescriptorBuilderIndex (std::uint32_t index)
 
RColumnDescriptorBuilderLogicalColumnId (ROOT::DescriptorId_t logicalColumnId)
 
RResult< RColumnDescriptor > MakeDescriptor () const
 Attempt to make a column descriptor.
 
RColumnDescriptorBuilderPhysicalColumnId (ROOT::DescriptorId_t physicalColumnId)
 
RColumnDescriptorBuilderRepresentationIndex (std::uint16_t representationIndex)
 
RColumnDescriptorBuilderSetSuppressedDeferred ()
 
RColumnDescriptorBuilderType (ROOT::ENTupleColumnType type)
 
RColumnDescriptorBuilderValueRange (double min, double max)
 
RColumnDescriptorBuilderValueRange (std::optional< RColumnDescriptor::RValueRange > valueRange)
 

Private Attributes

RColumnDescriptor fColumn = RColumnDescriptor()
 

#include <ROOT/RNTupleDescriptor.hxx>

Constructor & Destructor Documentation

◆ RColumnDescriptorBuilder()

ROOT::Internal::RColumnDescriptorBuilder::RColumnDescriptorBuilder ( )
default

Make an empty column descriptor builder.

Member Function Documentation

◆ BitsOnStorage()

RColumnDescriptorBuilder & ROOT::Internal::RColumnDescriptorBuilder::BitsOnStorage ( std::uint16_t bitsOnStorage)
inline

Definition at line 1431 of file RNTupleDescriptor.hxx.

◆ FieldId()

RColumnDescriptorBuilder & ROOT::Internal::RColumnDescriptorBuilder::FieldId ( ROOT::DescriptorId_t fieldId)
inline

Definition at line 1441 of file RNTupleDescriptor.hxx.

◆ FirstElementIndex()

RColumnDescriptorBuilder & ROOT::Internal::RColumnDescriptorBuilder::FirstElementIndex ( std::uint64_t firstElementIdx)
inline

Definition at line 1451 of file RNTupleDescriptor.hxx.

◆ GetFieldId()

ROOT::DescriptorId_t ROOT::Internal::RColumnDescriptorBuilder::GetFieldId ( ) const
inline

Definition at line 1478 of file RNTupleDescriptor.hxx.

◆ GetRepresentationIndex()

ROOT::DescriptorId_t ROOT::Internal::RColumnDescriptorBuilder::GetRepresentationIndex ( ) const
inline

Definition at line 1479 of file RNTupleDescriptor.hxx.

◆ Index()

RColumnDescriptorBuilder & ROOT::Internal::RColumnDescriptorBuilder::Index ( std::uint32_t index)
inline

Definition at line 1446 of file RNTupleDescriptor.hxx.

◆ LogicalColumnId()

RColumnDescriptorBuilder & ROOT::Internal::RColumnDescriptorBuilder::LogicalColumnId ( ROOT::DescriptorId_t logicalColumnId)
inline

Definition at line 1421 of file RNTupleDescriptor.hxx.

◆ MakeDescriptor()

ROOT::RResult< ROOT::RColumnDescriptor > ROOT::Internal::RColumnDescriptorBuilder::MakeDescriptor ( ) const

Attempt to make a column descriptor.

This may fail if the column was not given enough information to make a proper descriptor.

Definition at line 1126 of file RNTupleDescriptor.cxx.

◆ PhysicalColumnId()

RColumnDescriptorBuilder & ROOT::Internal::RColumnDescriptorBuilder::PhysicalColumnId ( ROOT::DescriptorId_t physicalColumnId)
inline

Definition at line 1426 of file RNTupleDescriptor.hxx.

◆ RepresentationIndex()

RColumnDescriptorBuilder & ROOT::Internal::RColumnDescriptorBuilder::RepresentationIndex ( std::uint16_t representationIndex)
inline

Definition at line 1463 of file RNTupleDescriptor.hxx.

◆ SetSuppressedDeferred()

RColumnDescriptorBuilder & ROOT::Internal::RColumnDescriptorBuilder::SetSuppressedDeferred ( )
inline

Definition at line 1456 of file RNTupleDescriptor.hxx.

◆ Type()

RColumnDescriptorBuilder & ROOT::Internal::RColumnDescriptorBuilder::Type ( ROOT::ENTupleColumnType type)
inline

Definition at line 1436 of file RNTupleDescriptor.hxx.

◆ ValueRange() [1/2]

RColumnDescriptorBuilder & ROOT::Internal::RColumnDescriptorBuilder::ValueRange ( double min,
double max )
inline

Definition at line 1468 of file RNTupleDescriptor.hxx.

◆ ValueRange() [2/2]

RColumnDescriptorBuilder & ROOT::Internal::RColumnDescriptorBuilder::ValueRange ( std::optional< RColumnDescriptor::RValueRange > valueRange)
inline

Definition at line 1473 of file RNTupleDescriptor.hxx.

Member Data Documentation

◆ fColumn

RColumnDescriptor ROOT::Internal::RColumnDescriptorBuilder::fColumn = RColumnDescriptor()
private

Definition at line 1415 of file RNTupleDescriptor.hxx.

  • tree/ntuple/inc/ROOT/RNTupleDescriptor.hxx
  • tree/ntuple/src/RNTupleDescriptor.cxx