ROOT::Internal::RColumnDescriptorBuilder Class Reference

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 1384 of file RNTupleDescriptor.hxx.

Public Member Functions
	RColumnDescriptorBuilder ()=default
	Make an empty column descriptor builder.
RColumnDescriptorBuilder &	BitsOnStorage (std::uint16_t bitsOnStorage)
RColumnDescriptorBuilder &	FieldId (ROOT::DescriptorId_t fieldId)
RColumnDescriptorBuilder &	FirstElementIndex (std::uint64_t firstElementIdx)
ROOT::DescriptorId_t	GetFieldId () const
ROOT::DescriptorId_t	GetRepresentationIndex () const
RColumnDescriptorBuilder &	Index (std::uint32_t index)
RColumnDescriptorBuilder &	LogicalColumnId (ROOT::DescriptorId_t logicalColumnId)
RResult< RColumnDescriptor >	MakeDescriptor () const
	Attempt to make a column descriptor.
RColumnDescriptorBuilder &	PhysicalColumnId (ROOT::DescriptorId_t physicalColumnId)
RColumnDescriptorBuilder &	RepresentationIndex (std::uint16_t representationIndex)
RColumnDescriptorBuilder &	SetSuppressedDeferred ()
RColumnDescriptorBuilder &	Type (ROOT::ENTupleColumnType type)
RColumnDescriptorBuilder &	ValueRange (double min, double max)
RColumnDescriptorBuilder &	ValueRange (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 1402 of file RNTupleDescriptor.hxx.

FieldId()

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

inline

Definition at line 1412 of file RNTupleDescriptor.hxx.

FirstElementIndex()

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

inline

Definition at line 1422 of file RNTupleDescriptor.hxx.

GetFieldId()

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

inline

Definition at line 1449 of file RNTupleDescriptor.hxx.

GetRepresentationIndex()

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

inline

Definition at line 1450 of file RNTupleDescriptor.hxx.

Index()

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

inline

Definition at line 1417 of file RNTupleDescriptor.hxx.

LogicalColumnId()

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

inline

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

RepresentationIndex()

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

inline

Definition at line 1434 of file RNTupleDescriptor.hxx.

SetSuppressedDeferred()

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

inline

Definition at line 1427 of file RNTupleDescriptor.hxx.

Type()

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

inline

Definition at line 1407 of file RNTupleDescriptor.hxx.

ValueRange() [1/2]

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

inline

Definition at line 1439 of file RNTupleDescriptor.hxx.

ValueRange() [2/2]

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

inline

Definition at line 1444 of file RNTupleDescriptor.hxx.

Member Data Documentation

fColumn

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

private

Definition at line 1386 of file RNTupleDescriptor.hxx.

Libraries for ROOT::Internal::RColumnDescriptorBuilder:

---

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

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