Logo ROOT  
Reference Guide
ROOT::Experimental::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 781 of file RNTupleDescriptor.hxx.

Public Member Functions

 RFieldDescriptorBuilder ()=default
 Make an empty dangling field descriptor. More...
 
 RFieldDescriptorBuilder (const RFieldDescriptor &fieldDesc)
 Make a new RFieldDescriptorBuilder based off an existing descriptor. More...
 
RFieldDescriptorBuilderFieldDescription (const std::string &fieldDescription)
 
RFieldDescriptorBuilderFieldId (DescriptorId_t fieldId)
 
RFieldDescriptorBuilderFieldName (const std::string &fieldName)
 
RFieldDescriptorBuilderFieldVersion (std::uint32_t fieldVersion)
 
DescriptorId_t GetParentId () const
 
RResult< RFieldDescriptorMakeDescriptor () const
 Attempt to make a field descriptor. More...
 
RFieldDescriptorBuilderNRepetitions (std::uint64_t nRepetitions)
 
RFieldDescriptorBuilderParentId (DescriptorId_t id)
 
RFieldDescriptorBuilderStructure (const ENTupleStructure &structure)
 
RFieldDescriptorBuilderTypeName (const std::string &typeName)
 
RFieldDescriptorBuilderTypeVersion (std::uint32_t typeVersion)
 

Static Public Member Functions

static RFieldDescriptorBuilder FromField (const Detail::RFieldBase &field)
 Make a new RFieldDescriptorBuilder based off a live NTuple field. More...
 

Private Attributes

RFieldDescriptor fField = RFieldDescriptor()
 

#include <ROOT/RNTupleDescriptor.hxx>

Constructor & Destructor Documentation

◆ RFieldDescriptorBuilder() [1/2]

ROOT::Experimental::RFieldDescriptorBuilder::RFieldDescriptorBuilder ( )
default

Make an empty dangling field descriptor.

◆ RFieldDescriptorBuilder() [2/2]

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

Member Function Documentation

◆ FieldDescription()

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

Definition at line 821 of file RNTupleDescriptor.hxx.

◆ FieldId()

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

Definition at line 799 of file RNTupleDescriptor.hxx.

◆ FieldName()

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

Definition at line 817 of file RNTupleDescriptor.hxx.

◆ FieldVersion()

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

Definition at line 803 of file RNTupleDescriptor.hxx.

◆ FromField()

ROOT::Experimental::RFieldDescriptorBuilder ROOT::Experimental::RFieldDescriptorBuilder::FromField ( const Detail::RFieldBase field)
static

Make a new RFieldDescriptorBuilder based off a live NTuple field.

Definition at line 536 of file RNTupleDescriptor.cxx.

◆ GetParentId()

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

Definition at line 837 of file RNTupleDescriptor.hxx.

◆ MakeDescriptor()

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

◆ NRepetitions()

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

Definition at line 829 of file RNTupleDescriptor.hxx.

◆ ParentId()

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

Definition at line 813 of file RNTupleDescriptor.hxx.

◆ Structure()

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

Definition at line 833 of file RNTupleDescriptor.hxx.

◆ TypeName()

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

Definition at line 825 of file RNTupleDescriptor.hxx.

◆ TypeVersion()

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

Definition at line 808 of file RNTupleDescriptor.hxx.

Member Data Documentation

◆ fField

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

Definition at line 783 of file RNTupleDescriptor.hxx.

Libraries for ROOT::Experimental::RFieldDescriptorBuilder:
[legend]

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