ROOT::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 RNTuple field.

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

Definition at line 1579 of file RNTupleDescriptor.hxx.

Public Member Functions
	RFieldDescriptorBuilder ()
	RFieldDescriptorBuilder (RFieldDescriptor &&source, RStringPool &stringPool)
	RFieldDescriptorBuilder (RStringPool &stringPool)
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
RFieldDescriptorBuilder &	IsSoACollection (bool val)
RResult< RFieldDescriptor >	MoveDescriptor ()
	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 RFieldDescriptor	CloneDescriptor (const RFieldDescriptor &source, RStringPool &stringPool)

Private Attributes
RFieldDescriptor	fField = RFieldDescriptor()
RStringPool *	fStringPool = nullptr

#include <ROOT/RNTupleDescriptor.hxx>

Constructor & Destructor Documentation

RFieldDescriptorBuilder() [1/3]

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

inline

Definition at line 1585 of file RNTupleDescriptor.hxx.

RFieldDescriptorBuilder() [2/3]

ROOT::Internal::RFieldDescriptorBuilder::RFieldDescriptorBuilder ( RStringPool & stringPool )

inlineexplicit

Definition at line 1592 of file RNTupleDescriptor.hxx.

RFieldDescriptorBuilder() [3/3]

ROOT::Internal::RFieldDescriptorBuilder::RFieldDescriptorBuilder ( RFieldDescriptor && source, RStringPool & stringPool )

inline

Definition at line 1596 of file RNTupleDescriptor.hxx.

Member Function Documentation

CloneDescriptor()

ROOT::RFieldDescriptor ROOT::Internal::RFieldDescriptorBuilder::CloneDescriptor ( const RFieldDescriptor & source, RStringPool & stringPool )

static

Definition at line 1205 of file RNTupleDescriptor.cxx.

FieldDescription()

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

inline

Definition at line 1634 of file RNTupleDescriptor.hxx.

FieldId()

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

inline

Definition at line 1604 of file RNTupleDescriptor.hxx.

FieldName()

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

inline

Definition at line 1629 of file RNTupleDescriptor.hxx.

FieldVersion()

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

inline

Definition at line 1609 of file RNTupleDescriptor.hxx.

GetParentId()

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

inline

Definition at line 1669 of file RNTupleDescriptor.hxx.

IsSoACollection()

RFieldDescriptorBuilder & ROOT::Internal::RFieldDescriptorBuilder::IsSoACollection ( bool val )

inline

Definition at line 1664 of file RNTupleDescriptor.hxx.

MoveDescriptor()

ROOT::RResult< ROOT::RFieldDescriptor > ROOT::Internal::RFieldDescriptorBuilder::MoveDescriptor

(

)

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

NRepetitions()

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

inline

Definition at line 1649 of file RNTupleDescriptor.hxx.

ParentId()

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

inline

Definition at line 1619 of file RNTupleDescriptor.hxx.

ProjectionSourceId()

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

inline

Definition at line 1624 of file RNTupleDescriptor.hxx.

Structure()

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

inline

Definition at line 1654 of file RNTupleDescriptor.hxx.

TypeAlias()

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

inline

Definition at line 1644 of file RNTupleDescriptor.hxx.

TypeChecksum()

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

inline

Definition at line 1659 of file RNTupleDescriptor.hxx.

TypeName()

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

inline

Definition at line 1639 of file RNTupleDescriptor.hxx.

TypeVersion()

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

inline

Definition at line 1614 of file RNTupleDescriptor.hxx.

Member Data Documentation

fField

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

private

Definition at line 1581 of file RNTupleDescriptor.hxx.

fStringPool

RStringPool* ROOT::Internal::RFieldDescriptorBuilder::fStringPool = nullptr

private

Definition at line 1582 of file RNTupleDescriptor.hxx.

Libraries for ROOT::Internal::RFieldDescriptorBuilder:

---

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

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