ROOT::REntry Class Reference

The REntry is a collection of values in an ntuple corresponding to a complete row in the data set.

The entry provides a memory-managed binder for a set of values read from fields in an RNTuple. The memory locations that are associated with values are managed through shared pointers.

Definition at line 55 of file REntry.hxx.

Classes
class	RFieldToken
	The field token identifies a (sub)field in this entry. More...

Public Types
using	ConstIterator_t = decltype(fValues)::const_iterator

Public Member Functions
	REntry (const REntry &other)=delete
	REntry (REntry &&other)=default
	~REntry ()=default
ConstIterator_t	begin () const
template<typename T >
void	BindRawPtr (RFieldToken token, T *rawPtr)
template<typename T >
void	BindRawPtr (std::string_view fieldName, T *rawPtr)
template<typename T >
void	BindValue (RFieldToken token, std::shared_ptr< T > objPtr)
template<typename T >
void	BindValue (std::string_view fieldName, std::shared_ptr< T > objPtr)
void	EmplaceNewValue (RFieldToken token)
void	EmplaceNewValue (std::string_view fieldName)
ConstIterator_t	end () const
std::uint64_t	GetModelId () const
template<typename T >
std::shared_ptr< T >	GetPtr (RFieldToken token) const
template<typename T >
std::shared_ptr< T >	GetPtr (std::string_view fieldName) const
std::uint64_t	GetSchemaId () const
RFieldToken	GetToken (std::string_view fieldName) const
	The ordinal of the (sub)field fieldName; can be used in other methods to address the corresponding value.
const std::string &	GetTypeName (RFieldToken token) const
const std::string &	GetTypeName (std::string_view fieldName) const
REntry &	operator= (const REntry &other)=delete
REntry &	operator= (REntry &&other)=default

Private Member Functions
	REntry ()=default
	Creation of entries can be done by the RNTupleModel, the RNTupleReader, or the RNTupleWriter.
	REntry (std::uint64_t modelId, std::uint64_t schemaId)
template<typename T >
std::shared_ptr< T >	AddValue (ROOT::RField< T > &field)
	While building the entry, adds a new value for the field and returns the value's shared pointer.
void	AddValue (ROOT::RFieldBase::RValue &&value)
std::size_t	Append ()
void	EnsureMatchingModel (RFieldToken token) const
template<typename T >
void	EnsureMatchingType (RFieldToken token) const
const std::string &	FindFieldName (RFieldToken token) const
	This function has linear complexity, only use it for more helpful error messages!
ROOT::RFieldBase::RValue &	GetValue (RFieldToken token)
	Return the RValue currently bound to the provided field.
ROOT::RFieldBase::RValue &	GetValue (std::string_view fieldName)
void	Read (ROOT::NTupleSize_t index)
void	UpdateValue (RFieldToken token, ROOT::RFieldBase::RValue &&value)
	Update the RValue for a field in the entry.
void	UpdateValue (RFieldToken token, ROOT::RFieldBase::RValue &value)

Private Attributes
std::unordered_map< std::string, std::size_t >	fFieldName2Token
	For fast lookup of token IDs given a (sub)field name present in the entry.
std::vector< std::string >	fFieldTypes
	To ensure that the entry is standalone, a copy of all field types.
std::uint64_t	fModelId = 0
	The entry must be linked to a specific model, identified by a model ID.
std::uint64_t	fSchemaId = 0
	The entry and its tokens are also linked to a specific schema, identified by a schema ID.
std::vector< ROOT::RFieldBase::RValue >	fValues
	Corresponds to the fields of the linked model.

Friends
class	Experimental::RNTupleChainProcessor
class	Experimental::RNTupleFillContext
class	Experimental::RNTupleJoinProcessor
class	Experimental::RNTupleProcessor
class	Experimental::RNTupleSingleProcessor
class	RNTupleModel
class	RNTupleReader

#include <ROOT/REntry.hxx>

Member Typedef Documentation

ConstIterator_t

using ROOT::REntry::ConstIterator_t = decltype(fValues)::const_iterator

Definition at line 171 of file REntry.hxx.

Constructor & Destructor Documentation

REntry() [1/4]

ROOT::REntry::REntry ( )

privatedefault

Creation of entries can be done by the RNTupleModel, the RNTupleReader, or the RNTupleWriter.

REntry() [2/4]

ROOT::REntry::REntry ( std::uint64_t modelId, std::uint64_t schemaId )

inlineexplicitprivate

Definition at line 93 of file REntry.hxx.

REntry() [3/4]

ROOT::REntry::REntry ( const REntry & other )

delete

REntry() [4/4]

ROOT::REntry::REntry ( REntry && other )

default

~REntry()

ROOT::REntry::~REntry ( )

default

Member Function Documentation

AddValue() [1/2]

template<typename T >

std::shared_ptr< T > ROOT::REntry::AddValue ( ROOT::RField< T > & field )

inlineprivate

While building the entry, adds a new value for the field and returns the value's shared pointer.

Definition at line 104 of file REntry.hxx.

AddValue() [2/2]

void ROOT::REntry::AddValue ( ROOT::RFieldBase::RValue && value )

inlineprivate

Definition at line 95 of file REntry.hxx.

Append()

std::size_t ROOT::REntry::Append ( )

inlineprivate

Definition at line 129 of file REntry.hxx.

begin()

ConstIterator_t ROOT::REntry::begin ( ) const

inline

Definition at line 250 of file REntry.hxx.

BindRawPtr() [1/2]

template<typename T >

void ROOT::REntry::BindRawPtr ( RFieldToken token, T * rawPtr )

inline

Definition at line 212 of file REntry.hxx.

BindRawPtr() [2/2]

template<typename T >

void ROOT::REntry::BindRawPtr ( std::string_view fieldName, T * rawPtr )

inline

Definition at line 220 of file REntry.hxx.

BindValue() [1/2]

template<typename T >

void ROOT::REntry::BindValue ( RFieldToken token, std::shared_ptr< T > objPtr )

inline

Definition at line 198 of file REntry.hxx.

BindValue() [2/2]

template<typename T >

void ROOT::REntry::BindValue ( std::string_view fieldName, std::shared_ptr< T > objPtr )

inline

Definition at line 206 of file REntry.hxx.

EmplaceNewValue() [1/2]

void ROOT::REntry::EmplaceNewValue ( RFieldToken token )

inline

Definition at line 189 of file REntry.hxx.

EmplaceNewValue() [2/2]

void ROOT::REntry::EmplaceNewValue ( std::string_view fieldName )

inline

Definition at line 195 of file REntry.hxx.

end()

ConstIterator_t ROOT::REntry::end ( ) const

inline

Definition at line 251 of file REntry.hxx.

EnsureMatchingModel()

void ROOT::REntry::EnsureMatchingModel ( RFieldToken token ) const

inlineprivate

Definition at line 138 of file REntry.hxx.

EnsureMatchingType()

template<typename T >

void ROOT::REntry::EnsureMatchingType ( RFieldToken token ) const

inlineprivate

Definition at line 160 of file REntry.hxx.

FindFieldName()

const std::string & ROOT::REntry::FindFieldName ( RFieldToken token ) const

inlineprivate

This function has linear complexity, only use it for more helpful error messages!

Definition at line 147 of file REntry.hxx.

GetModelId()

std::uint64_t ROOT::REntry::GetModelId ( ) const

inline

Definition at line 247 of file REntry.hxx.

GetPtr() [1/2]

template<typename T >

std::shared_ptr< T > ROOT::REntry::GetPtr ( RFieldToken token ) const

inline

Definition at line 226 of file REntry.hxx.

GetPtr() [2/2]

template<typename T >

std::shared_ptr< T > ROOT::REntry::GetPtr ( std::string_view fieldName ) const

inline

Definition at line 234 of file REntry.hxx.

GetSchemaId()

std::uint64_t ROOT::REntry::GetSchemaId ( ) const

inline

Definition at line 248 of file REntry.hxx.

GetToken()

RFieldToken ROOT::REntry::GetToken ( std::string_view fieldName ) const

inline

The ordinal of the (sub)field fieldName; can be used in other methods to address the corresponding value.

Definition at line 180 of file REntry.hxx.

GetTypeName() [1/2]

const std::string & ROOT::REntry::GetTypeName ( RFieldToken token ) const

inline

Definition at line 239 of file REntry.hxx.

GetTypeName() [2/2]

const std::string & ROOT::REntry::GetTypeName ( std::string_view fieldName ) const

inline

Definition at line 245 of file REntry.hxx.

GetValue() [1/2]

ROOT::RFieldBase::RValue & ROOT::REntry::GetValue ( RFieldToken token )

inlineprivate

Return the RValue currently bound to the provided field.

Definition at line 119 of file REntry.hxx.

GetValue() [2/2]

ROOT::RFieldBase::RValue & ROOT::REntry::GetValue ( std::string_view fieldName )

inlineprivate

Definition at line 120 of file REntry.hxx.

operator=() [1/2]

REntry & ROOT::REntry::operator= ( const REntry & other )

delete

operator=() [2/2]

REntry & ROOT::REntry::operator= ( REntry && other )

default

Read()

void ROOT::REntry::Read ( ROOT::NTupleSize_t index )

inlineprivate

Definition at line 122 of file REntry.hxx.

UpdateValue() [1/2]

void ROOT::REntry::UpdateValue ( RFieldToken token, ROOT::RFieldBase::RValue && value )

inlineprivate

Update the RValue for a field in the entry.

To be used when its underlying ROOT::RFieldBase changes, which typically happens when the page source from which the field values are read changes.

Definition at line 115 of file REntry.hxx.

UpdateValue() [2/2]

void ROOT::REntry::UpdateValue ( RFieldToken token, ROOT::RFieldBase::RValue & value )

inlineprivate

Definition at line 116 of file REntry.hxx.

Friends And Related Symbol Documentation

Experimental::RNTupleChainProcessor

friend class Experimental::RNTupleChainProcessor

friend

Definition at line 61 of file REntry.hxx.

Experimental::RNTupleFillContext

friend class Experimental::RNTupleFillContext

friend

Definition at line 58 of file REntry.hxx.

Experimental::RNTupleJoinProcessor

friend class Experimental::RNTupleJoinProcessor

friend

Definition at line 62 of file REntry.hxx.

Experimental::RNTupleProcessor

friend class Experimental::RNTupleProcessor

friend

Definition at line 59 of file REntry.hxx.

Experimental::RNTupleSingleProcessor

friend class Experimental::RNTupleSingleProcessor

friend

Definition at line 60 of file REntry.hxx.

RNTupleModel

friend class RNTupleModel

friend

Definition at line 56 of file REntry.hxx.

RNTupleReader

friend class RNTupleReader

friend

Definition at line 57 of file REntry.hxx.

Member Data Documentation

fFieldName2Token

std::unordered_map<std::string, std::size_t> ROOT::REntry::fFieldName2Token

private

For fast lookup of token IDs given a (sub)field name present in the entry.

Definition at line 87 of file REntry.hxx.

fFieldTypes

std::vector<std::string> ROOT::REntry::fFieldTypes

private

To ensure that the entry is standalone, a copy of all field types.

Definition at line 89 of file REntry.hxx.

fModelId

std::uint64_t ROOT::REntry::fModelId = 0

private

The entry must be linked to a specific model, identified by a model ID.

Definition at line 81 of file REntry.hxx.

fSchemaId

std::uint64_t ROOT::REntry::fSchemaId = 0

private

The entry and its tokens are also linked to a specific schema, identified by a schema ID.

Definition at line 83 of file REntry.hxx.

fValues

std::vector<ROOT::RFieldBase::RValue> ROOT::REntry::fValues

private

Corresponds to the fields of the linked model.

Definition at line 85 of file REntry.hxx.

Libraries for ROOT::REntry:

---

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

• tree/ntuple/v7/inc/ROOT/REntry.hxx