ROOT::Experimental::Internal::RFieldDescriptorBuilder Class Reference

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

Dangling field descriptors describe a single field in isolation. They are missing the necessary relationship information (parent field, any child fields) required to describe a real NTuple field.

Dangling field descriptors can only become actual descriptors when added to an RNTupleDescriptorBuilder instance and then linked to other fields.

Definition at line 1262 of file RNTupleDescriptor.hxx.

Public Member Functions
	RFieldDescriptorBuilder ()=default
	Make an empty dangling field descriptor.
	RFieldDescriptorBuilder (const RFieldDescriptor &fieldDesc)
	Make a new RFieldDescriptorBuilder based off an existing descriptor.
RFieldDescriptorBuilder &	FieldDescription (const std::string &fieldDescription)
RFieldDescriptorBuilder &	FieldId (ROOT::DescriptorId_t fieldId)
RFieldDescriptorBuilder &	FieldName (const std::string &fieldName)
RFieldDescriptorBuilder &	FieldVersion (std::uint32_t fieldVersion)
ROOT::DescriptorId_t	GetParentId () const
RResult< RFieldDescriptor >	MakeDescriptor () const
	Attempt to make a field descriptor.
RFieldDescriptorBuilder &	NRepetitions (std::uint64_t nRepetitions)
RFieldDescriptorBuilder &	ParentId (ROOT::DescriptorId_t id)
RFieldDescriptorBuilder &	ProjectionSourceId (ROOT::DescriptorId_t id)
RFieldDescriptorBuilder &	Structure (const ROOT::ENTupleStructure &structure)
RFieldDescriptorBuilder &	TypeAlias (const std::string &typeAlias)
RFieldDescriptorBuilder &	TypeChecksum (const std::optional< std::uint32_t > typeChecksum)
RFieldDescriptorBuilder &	TypeName (const std::string &typeName)
RFieldDescriptorBuilder &	TypeVersion (std::uint32_t typeVersion)

Static Public Member Functions
static RFieldDescriptorBuilder	FromField (const RFieldBase &field)
	Make a new RFieldDescriptorBuilder based off a live NTuple field.

Private Attributes
RFieldDescriptor	fField = RFieldDescriptor()

#include <ROOT/RNTupleDescriptor.hxx>

Constructor & Destructor Documentation

RFieldDescriptorBuilder() [1/2]

ROOT::Experimental::Internal::RFieldDescriptorBuilder::RFieldDescriptorBuilder ( )

default

Make an empty dangling field descriptor.

RFieldDescriptorBuilder() [2/2]

ROOT::Experimental::Internal::RFieldDescriptorBuilder::RFieldDescriptorBuilder ( const RFieldDescriptor & fieldDesc )

explicit

Make a new RFieldDescriptorBuilder based off an existing descriptor.

Relationship information is lost during the conversion to a dangling descriptor:

• Parent id is reset to an invalid id.
• Field children ids are forgotten.

These properties must be set using RNTupleDescriptorBuilder::AddFieldLink().

Definition at line 1031 of file RNTupleDescriptor.cxx.

Member Function Documentation

FieldDescription()

RFieldDescriptorBuilder & ROOT::Experimental::Internal::RFieldDescriptorBuilder::FieldDescription ( const std::string & fieldDescription )

inline

Definition at line 1311 of file RNTupleDescriptor.hxx.

FieldId()

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

inline

Definition at line 1281 of file RNTupleDescriptor.hxx.

FieldName()

RFieldDescriptorBuilder & ROOT::Experimental::Internal::RFieldDescriptorBuilder::FieldName ( const std::string & fieldName )

inline

Definition at line 1306 of file RNTupleDescriptor.hxx.

FieldVersion()

RFieldDescriptorBuilder & ROOT::Experimental::Internal::RFieldDescriptorBuilder::FieldVersion ( std::uint32_t fieldVersion )

inline

Definition at line 1286 of file RNTupleDescriptor.hxx.

FromField()

ROOT::Experimental::Internal::RFieldDescriptorBuilder ROOT::Experimental::Internal::RFieldDescriptorBuilder::FromField ( const RFieldBase & field )

static

Make a new RFieldDescriptorBuilder based off a live NTuple field.

Definition at line 1040 of file RNTupleDescriptor.cxx.

GetParentId()

ROOT::DescriptorId_t ROOT::Experimental::Internal::RFieldDescriptorBuilder::GetParentId ( ) const

inline

Definition at line 1341 of file RNTupleDescriptor.hxx.

MakeDescriptor()

ROOT::RResult< ROOT::Experimental::RFieldDescriptor > ROOT::Experimental::Internal::RFieldDescriptorBuilder::MakeDescriptor

(

)

const

Attempt to make a field descriptor.

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

Definition at line 1057 of file RNTupleDescriptor.cxx.

NRepetitions()

RFieldDescriptorBuilder & ROOT::Experimental::Internal::RFieldDescriptorBuilder::NRepetitions ( std::uint64_t nRepetitions )

inline

Definition at line 1326 of file RNTupleDescriptor.hxx.

ParentId()

RFieldDescriptorBuilder & ROOT::Experimental::Internal::RFieldDescriptorBuilder::ParentId ( ROOT::DescriptorId_t id )

inline

Definition at line 1296 of file RNTupleDescriptor.hxx.

ProjectionSourceId()

RFieldDescriptorBuilder & ROOT::Experimental::Internal::RFieldDescriptorBuilder::ProjectionSourceId ( ROOT::DescriptorId_t id )

inline

Definition at line 1301 of file RNTupleDescriptor.hxx.

Structure()

RFieldDescriptorBuilder & ROOT::Experimental::Internal::RFieldDescriptorBuilder::Structure ( const ROOT::ENTupleStructure & structure )

inline

Definition at line 1331 of file RNTupleDescriptor.hxx.

TypeAlias()

RFieldDescriptorBuilder & ROOT::Experimental::Internal::RFieldDescriptorBuilder::TypeAlias ( const std::string & typeAlias )

inline

Definition at line 1321 of file RNTupleDescriptor.hxx.

TypeChecksum()

RFieldDescriptorBuilder & ROOT::Experimental::Internal::RFieldDescriptorBuilder::TypeChecksum ( const std::optional< std::uint32_t > typeChecksum )

inline

Definition at line 1336 of file RNTupleDescriptor.hxx.

TypeName()

RFieldDescriptorBuilder & ROOT::Experimental::Internal::RFieldDescriptorBuilder::TypeName ( const std::string & typeName )

inline

Definition at line 1316 of file RNTupleDescriptor.hxx.

TypeVersion()

RFieldDescriptorBuilder & ROOT::Experimental::Internal::RFieldDescriptorBuilder::TypeVersion ( std::uint32_t typeVersion )

inline

Definition at line 1291 of file RNTupleDescriptor.hxx.

Member Data Documentation

fField

RFieldDescriptor ROOT::Experimental::Internal::RFieldDescriptorBuilder::fField = RFieldDescriptor()

private

Definition at line 1264 of file RNTupleDescriptor.hxx.

Libraries for ROOT::Experimental::Internal::RFieldDescriptorBuilder:

---

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

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