ROOT::Experimental::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 1028 of file RNTupleDescriptor.hxx.

Public Member Functions
	RColumnDescriptorBuilder ()=default
	Make an empty column descriptor builder.
RColumnDescriptorBuilder &	BitsOnStorage (std::uint16_t bitsOnStorage)
RColumnDescriptorBuilder &	FieldId (DescriptorId_t fieldId)
RColumnDescriptorBuilder &	FirstElementIndex (std::uint64_t firstElementIdx)
DescriptorId_t	GetFieldId () const
DescriptorId_t	GetRepresentationIndex () const
RColumnDescriptorBuilder &	Index (std::uint32_t index)
RColumnDescriptorBuilder &	LogicalColumnId (DescriptorId_t logicalColumnId)
RResult< RColumnDescriptor >	MakeDescriptor () const
	Attempt to make a column descriptor.
RColumnDescriptorBuilder &	PhysicalColumnId (DescriptorId_t physicalColumnId)
RColumnDescriptorBuilder &	RepresentationIndex (std::uint16_t representationIndex)
RColumnDescriptorBuilder &	SetSuppressedDeferred ()
RColumnDescriptorBuilder &	Type (EColumnType 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::Experimental::Internal::RColumnDescriptorBuilder::RColumnDescriptorBuilder ( )

default

Make an empty column descriptor builder.

Member Function Documentation

BitsOnStorage()

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

inline

Definition at line 1046 of file RNTupleDescriptor.hxx.

FieldId()

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

inline

Definition at line 1056 of file RNTupleDescriptor.hxx.

FirstElementIndex()

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

inline

Definition at line 1066 of file RNTupleDescriptor.hxx.

GetFieldId()

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

inline

Definition at line 1093 of file RNTupleDescriptor.hxx.

GetRepresentationIndex()

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

inline

Definition at line 1094 of file RNTupleDescriptor.hxx.

Index()

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

inline

Definition at line 1061 of file RNTupleDescriptor.hxx.

LogicalColumnId()

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

inline

Definition at line 1036 of file RNTupleDescriptor.hxx.

MakeDescriptor()

ROOT::Experimental::RResult< ROOT::Experimental::RColumnDescriptor > ROOT::Experimental::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 850 of file RNTupleDescriptor.cxx.

PhysicalColumnId()

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

inline

Definition at line 1041 of file RNTupleDescriptor.hxx.

RepresentationIndex()

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

inline

Definition at line 1078 of file RNTupleDescriptor.hxx.

SetSuppressedDeferred()

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

inline

Definition at line 1071 of file RNTupleDescriptor.hxx.

Type()

RColumnDescriptorBuilder & ROOT::Experimental::Internal::RColumnDescriptorBuilder::Type ( EColumnType  type )

inline

Definition at line 1051 of file RNTupleDescriptor.hxx.

ValueRange() [1/2]

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

inline

Definition at line 1083 of file RNTupleDescriptor.hxx.

ValueRange() [2/2]

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

inline

Definition at line 1088 of file RNTupleDescriptor.hxx.

Member Data Documentation

fColumn

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

private

Definition at line 1030 of file RNTupleDescriptor.hxx.

Libraries for ROOT::Experimental::Internal::RColumnDescriptorBuilder:

---

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

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