ROOT::RNTupleModel::RUpdater Class Reference

A model is usually immutable after passing it to an RNTupleWriter.

However, for the rare cases that require changing the model after the fact, RUpdater provides limited support for incremental updates, e.g. addition of new fields.

See RNTupleWriter::CreateModelUpdater() for an example.

Definition at line 426 of file RNTupleModel.hxx.

Public Member Functions
	RUpdater (ROOT::RNTupleWriter &writer)
	~RUpdater ()
void	AddField (std::unique_ptr< ROOT::RFieldBase > field)
RResult< void >	AddProjectedField (std::unique_ptr< ROOT::RFieldBase > field, FieldMappingFunc_t mapping)
void	BeginUpdate ()
	Begin a new set of alterations to the underlying model.
void	CommitUpdate ()
	Commit changes since the last call to BeginUpdate().
template<typename T >
std::shared_ptr< T >	MakeField (std::string_view name, std::string_view description="")

Private Attributes
std::uint64_t	fNewModelId = 0
	The model ID after committing.
Internal::RNTupleModelChangeset	fOpenChangeset
ROOT::RNTupleWriter &	fWriter

#include <ROOT/RNTupleModel.hxx>

Constructor & Destructor Documentation

RUpdater()

ROOT::RNTupleModel::RUpdater::RUpdater ( ROOT::RNTupleWriter & writer )

explicit

Definition at line 185 of file RNTupleModel.cxx.

~RUpdater()

ROOT::RNTupleModel::RUpdater::~RUpdater ( )

inline

Definition at line 434 of file RNTupleModel.hxx.

Member Function Documentation

AddField()

void ROOT::RNTupleModel::RUpdater::AddField

(

std::unique_ptr< ROOT::RFieldBase >

field

)

Definition at line 217 of file RNTupleModel.cxx.

AddProjectedField()

ROOT::RResult< void > ROOT::RNTupleModel::RUpdater::AddProjectedField	(	std::unique_ptr< ROOT::RFieldBase >	field,
		FieldMappingFunc_t	mapping )

See also

RNTupleModel::AddProjectedField()

Definition at line 233 of file RNTupleModel.cxx.

BeginUpdate()

void ROOT::RNTupleModel::RUpdater::BeginUpdate

(

)

Begin a new set of alterations to the underlying model.

As a side effect, all REntry instances related to the model are invalidated.

Definition at line 190 of file RNTupleModel.cxx.

CommitUpdate()

void ROOT::RNTupleModel::RUpdater::CommitUpdate

(

)

Commit changes since the last call to BeginUpdate().

All the invalidated REntries remain invalid. CreateEntry() or CreateBareEntry() can be used to create an REntry that matches the new model. Upon completion, BeginUpdate() can be called again to begin a new set of changes.

Definition at line 198 of file RNTupleModel.cxx.

MakeField()

template<typename T >

std::shared_ptr< T > ROOT::RNTupleModel::RUpdater::MakeField ( std::string_view name, std::string_view description = "" )

inline

Definition at line 444 of file RNTupleModel.hxx.

Member Data Documentation

fNewModelId

std::uint64_t ROOT::RNTupleModel::RUpdater::fNewModelId = 0

private

The model ID after committing.

Definition at line 430 of file RNTupleModel.hxx.

fOpenChangeset

Internal::RNTupleModelChangeset ROOT::RNTupleModel::RUpdater::fOpenChangeset

private

Definition at line 429 of file RNTupleModel.hxx.

fWriter

ROOT::RNTupleWriter& ROOT::RNTupleModel::RUpdater::fWriter

private

Definition at line 428 of file RNTupleModel.hxx.

Libraries for ROOT::RNTupleModel::RUpdater:

---

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

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