Logo ROOT  

Reference Guide
 
Loading...
Searching...
No Matches
List of all members | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
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 862 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 (DescriptorId_t fieldId)
 
RFieldDescriptorBuilder & FieldName (const std::string &fieldName)
 
RFieldDescriptorBuilder & FieldVersion (std::uint32_t fieldVersion)
 
DescriptorId_t GetParentId () const
 
RResult< RFieldDescriptor > MakeDescriptor () const
 Attempt to make a field descriptor.
 
RFieldDescriptorBuilder & NRepetitions (std::uint64_t nRepetitions)
 
RFieldDescriptorBuilder & ParentId (DescriptorId_t id)
 
RFieldDescriptorBuilder & Structure (const ENTupleStructure &structure)
 
RFieldDescriptorBuilder & TypeAlias (const std::string &typeAlias)
 
RFieldDescriptorBuilder & TypeName (const std::string &typeName)
 
RFieldDescriptorBuilder & TypeVersion (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.
 

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 677 of file RNTupleDescriptor.cxx.

Member Function Documentation

◆ FieldDescription()

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

Definition at line 902 of file RNTupleDescriptor.hxx.

◆ FieldId()

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

Definition at line 880 of file RNTupleDescriptor.hxx.

◆ FieldName()

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

Definition at line 898 of file RNTupleDescriptor.hxx.

◆ FieldVersion()

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

Definition at line 884 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 685 of file RNTupleDescriptor.cxx.

◆ GetParentId()

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

Definition at line 923 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 699 of file RNTupleDescriptor.cxx.

◆ NRepetitions()

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

Definition at line 915 of file RNTupleDescriptor.hxx.

◆ ParentId()

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

Definition at line 894 of file RNTupleDescriptor.hxx.

◆ Structure()

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

Definition at line 919 of file RNTupleDescriptor.hxx.

◆ TypeAlias()

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

Definition at line 910 of file RNTupleDescriptor.hxx.

◆ TypeName()

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

Definition at line 906 of file RNTupleDescriptor.hxx.

◆ TypeVersion()

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

Definition at line 889 of file RNTupleDescriptor.hxx.

Member Data Documentation

◆ fField

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

Definition at line 864 of file RNTupleDescriptor.hxx.

Libraries for ROOT::Experimental::RFieldDescriptorBuilder:
[legend]
The documentation for this class was generated from the following files: