ROOT::Experimental::RNTupleModel Class Reference

The RNTupleModel encapulates the schema of an ntuple.

The ntuple model comprises a collection of hierarchically organized fields. From a frozen model, "entries" can be extracted. For convenience, the model provides a default entry. Models have a unique model identifier that faciliates checking whether entries are compatible with it (i.e.: have been extracted from that model). A model needs to be frozen before it can be used to create a live ntuple.

Definition at line 46 of file RNTupleModel.hxx.

Public Member Functions
	RNTupleModel ()
	RNTupleModel (const RNTupleModel &)=delete
	~RNTupleModel ()=default
template<typename T >
void	AddField (std::string_view fieldName, T *fromWhere)
void	AddField (std::unique_ptr< Detail::RFieldBase > field)
	Adds a field whose type is not known at compile time. Thus there is no shared pointer returned.
std::unique_ptr< RNTupleModel >	Clone () const
std::unique_ptr< REntry >	CreateEntry ()
template<typename T >
T *	Get (std::string_view fieldName)
REntry *	GetDefaultEntry ()
std::string	GetDescription () const
RFieldZero *	GetFieldZero () const
RNTupleUuid	GetUuid () const
RNTupleVersion	GetVersion () const
std::shared_ptr< RCollectionNTuple >	MakeCollection (std::string_view fieldName, std::unique_ptr< RNTupleModel > collectionModel)
	Ingests a model for a sub collection and attaches it to the current model.
template<typename T , typename... ArgsT>
std::shared_ptr< T >	MakeField (std::string_view fieldName, ArgsT &&... args)
	Creates a new field and a corresponding tree value that is managed by a shared pointer.
RNTupleModel &	operator= (const RNTupleModel &)=delete

Static Public Member Functions
static std::unique_ptr< RNTupleModel >	Create ()

Private Member Functions
void	EnsureValidFieldName (std::string_view fieldName)
	Checks that user-provided field names are valid in the context of this NTuple model.

Private Attributes
std::unique_ptr< REntry >	fDefaultEntry
	Contains field values corresponding to the created top-level fields.
std::unordered_set< std::string >	fFieldNames
	Keeps track of which field names are taken.
std::unique_ptr< RFieldZero >	fFieldZero
	Hierarchy of fields consisting of simple types and collections (sub trees)

#include <ROOT/RNTupleModel.hxx>

Constructor & Destructor Documentation

RNTupleModel() [1/2]

ROOT::Experimental::RNTupleModel::RNTupleModel

(

)

Definition at line 38 of file RNTupleModel.cxx.

RNTupleModel() [2/2]

ROOT::Experimental::RNTupleModel::RNTupleModel ( const RNTupleModel &  )

delete

~RNTupleModel()

ROOT::Experimental::RNTupleModel::~RNTupleModel ( )

default

Member Function Documentation

AddField() [1/2]

template<typename T >

void ROOT::Experimental::RNTupleModel::AddField ( std::string_view  fieldName, T *  fromWhere  )

inline

Definition at line 81 of file RNTupleModel.hxx.

AddField() [2/2]

void ROOT::Experimental::RNTupleModel::AddField

(

std::unique_ptr< Detail::RFieldBase >

field

)

Adds a field whose type is not known at compile time. Thus there is no shared pointer returned.

Definition at line 53 of file RNTupleModel.cxx.

Clone()

std::unique_ptr< ROOT::Experimental::RNTupleModel > ROOT::Experimental::RNTupleModel::Clone

(

)

const

Definition at line 43 of file RNTupleModel.cxx.

Create()

static std::unique_ptr< RNTupleModel > ROOT::Experimental::RNTupleModel::Create ( )

inlinestatic

Definition at line 65 of file RNTupleModel.hxx.

CreateEntry()

std::unique_ptr< ROOT::Experimental::REntry > ROOT::Experimental::RNTupleModel::CreateEntry

(

)

Definition at line 72 of file RNTupleModel.cxx.

EnsureValidFieldName()

void ROOT::Experimental::RNTupleModel::EnsureValidFieldName ( std::string_view  fieldName )

private

Checks that user-provided field names are valid in the context of this NTuple model.

Throws an RException for invalid names.

Definition at line 26 of file RNTupleModel.cxx.

Get()

template<typename T >

T * ROOT::Experimental::RNTupleModel::Get ( std::string_view  fieldName )

inline

Definition at line 89 of file RNTupleModel.hxx.

GetDefaultEntry()

REntry * ROOT::Experimental::RNTupleModel::GetDefaultEntry ( )

inline

Definition at line 99 of file RNTupleModel.hxx.

GetDescription()

std::string ROOT::Experimental::RNTupleModel::GetDescription ( ) const

inline

Definition at line 102 of file RNTupleModel.hxx.

GetFieldZero()

RFieldZero * ROOT::Experimental::RNTupleModel::GetFieldZero ( ) const

inline

Definition at line 98 of file RNTupleModel.hxx.

GetUuid()

RNTupleUuid ROOT::Experimental::RNTupleModel::GetUuid ( ) const

inline

Definition at line 103 of file RNTupleModel.hxx.

GetVersion()

RNTupleVersion ROOT::Experimental::RNTupleModel::GetVersion ( ) const

inline

Definition at line 101 of file RNTupleModel.hxx.

MakeCollection()

std::shared_ptr< ROOT::Experimental::RCollectionNTuple > ROOT::Experimental::RNTupleModel::MakeCollection	(	std::string_view	fieldName,
		std::unique_ptr< RNTupleModel >	collectionModel
	)

Ingests a model for a sub collection and attaches it to the current model.

Definition at line 61 of file RNTupleModel.cxx.

MakeField()

template<typename T , typename... ArgsT>

std::shared_ptr< T > ROOT::Experimental::RNTupleModel::MakeField ( std::string_view  fieldName, ArgsT &&...  args  )

inline

Creates a new field and a corresponding tree value that is managed by a shared pointer.

Definition at line 69 of file RNTupleModel.hxx.

operator=()

RNTupleModel & ROOT::Experimental::RNTupleModel::operator= ( const RNTupleModel &  )

delete

Member Data Documentation

fDefaultEntry

std::unique_ptr<REntry> ROOT::Experimental::RNTupleModel::fDefaultEntry

private

Contains field values corresponding to the created top-level fields.

Definition at line 50 of file RNTupleModel.hxx.

fFieldNames

std::unordered_set<std::string> ROOT::Experimental::RNTupleModel::fFieldNames

private

Keeps track of which field names are taken.

Definition at line 52 of file RNTupleModel.hxx.

fFieldZero

std::unique_ptr<RFieldZero> ROOT::Experimental::RNTupleModel::fFieldZero

private

Hierarchy of fields consisting of simple types and collections (sub trees)

Definition at line 48 of file RNTupleModel.hxx.

Libraries for ROOT::Experimental::RNTupleModel:

---

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

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