template<typename ItemT>
class ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >

The RVec type has different layouts depending on the item type, therefore we cannot go with a generic RVec implementation as we can with std::vector.

Definition at line 649 of file RField.hxx.

Public Member Functions
	RField (RField &&other)=default

	RField (std::string_view fieldName, std::unique_ptr< Detail::RFieldBase > itemField)

	RField (std::string_view name)

	~RField ()=default

Detail::RFieldValue	CaptureValue (void *where) final
	Creates a value from a memory location with an already constructed object. More...

RFieldBase *	Clone (std::string_view newName) final

void	CommitCluster () final
	Perform housekeeping tasks for global to cluster-local index translation. More...

void	DestroyValue (const Detail::RFieldValue &value, bool dtorOnly=false) final
	Releases the resources acquired during GenerateValue (memory and constructor) This implementation works for simple types but needs to be overwritten for complex ones. More...

void	DoGenerateColumns () final
	Creates the backing columns corresponsing to the field type and name. More...

ROOT::Experimental::Detail::RFieldValue	GenerateValue (void *where) final
	Generates a tree value in a given location of size at least GetValueSize(). More...

template<typename... ArgsT>
ROOT::Experimental::Detail::RFieldValue	GenerateValue (void *where, ArgsT &&... args)

unsigned int	GetNColumns () const final
	Returns the number of columns generated to store data for the field; defaults to 1. More...

size_t	GetValueSize () const final
	The number of bytes taken by a value of the appropriate type. More...

RField &	operator= (RField &&other)=default

Public Member Functions inherited from ROOT::Experimental::Detail::RFieldBase
	RFieldBase (const RFieldBase &)=delete

	RFieldBase (RFieldBase &&)=default

	RFieldBase (std::string_view name, std::string_view type, ENTupleStructure structure, bool isSimple)
	The constructor creates the underlying column objects and connects them to either a sink or a source. More...

virtual	~RFieldBase ()

void	Append (const RFieldValue &value)
	Write the given value into columns. The value object has to be of the same type as the field. More...

void	Attach (std::unique_ptr< Detail::RFieldBase > child)

RIterator	begin ()

virtual RFieldValue	CaptureValue (void *where)=0
	Creates a value from a memory location with an already constructed object. More...

virtual RFieldBase *	Clone (std::string_view newName)=0

virtual void	CommitCluster ()
	Perform housekeeping tasks for global to cluster-local index translation. More...

void	ConnectColumns (Detail::RPageStorage *pageStorage)
	Registeres (or re-registers) the backing columns with the physical storage. More...

virtual void	DestroyValue (const RFieldValue &value, bool dtorOnly=false)
	Releases the resources acquired during GenerateValue (memory and constructor) This implementation works for simple types but needs to be overwritten for complex ones. More...

RIterator	end ()

void	Flush () const
	Ensure that all received items are written from page buffers to the storage. More...

RFieldValue	GenerateValue ()
	Generates a tree value of the field type and allocates new initialized memory according to the type. More...

virtual RFieldValue	GenerateValue (void *where)=0
	Generates a tree value in a given location of size at least GetValueSize(). More...

virtual RNTupleVersion	GetFieldVersion () const
	Indicates an evolution of the mapping scheme from C++ type to columns. More...

std::string	GetName () const

virtual unsigned int	GetNColumns () const =0
	Returns the number of columns generated to store data for the field; defaults to 1. More...

NTupleSize_t	GetNItems ()
	The number of elements in the principal column. For top level fields, the number of entries. More...

const RFieldBase *	GetParent () const

ENTupleStructure	GetStructure () const

std::string	GetType () const

virtual RNTupleVersion	GetTypeVersion () const
	Indicates an evolution of the C++ type itself. More...

virtual size_t	GetValueSize () const =0
	The number of bytes taken by a value of the appropriate type. More...

bool	IsSimple () const

RFieldBase &	operator= (const RFieldBase &)=delete

RFieldBase &	operator= (RFieldBase &&)=default

void	Read (NTupleSize_t index, RFieldValue *value)
	Populate a single value with data from the tree, which needs to be of the fitting type. More...

void	ReadV (NTupleSize_t index, NTupleSize_t count, void *dst)
	Type unsafe bulk read interface; dst must point to a vector of objects of the field type. More...

Static Public Member Functions
static std::string	MyTypeName ()

Static Public Member Functions inherited from ROOT::Experimental::Detail::RFieldBase
static RFieldBase *	Create (const std::string &fieldName, const std::string &typeName)
	Factory method to resurrect a field from the stored on-disk type information. More...

static std::string	GetCollectionName (const std::string &parentName)
	Get the name for an item sub field that is part of a collection, e.g. the float field of std::vector<float> More...

static std::string	GetLeafName (const std::string &fullName)
	Get the tail of the field name up to the last dot. More...

Protected Member Functions
void	DoAppend (const Detail::RFieldValue &value) final
	Operations on values of complex types, e.g. More...

void	DoRead (NTupleSize_t index, Detail::RFieldValue *value) final

Protected Member Functions inherited from ROOT::Experimental::Detail::RFieldBase
virtual void	DoAppend (const RFieldValue &value)
	Operations on values of complex types, e.g. More...

virtual void	DoGenerateColumns ()=0
	Creates the backing columns corresponsing to the field type and name. More...

virtual void	DoRead (NTupleSize_t index, RFieldValue *value)

virtual void	DoReadV (NTupleSize_t index, NTupleSize_t count, void *dst)

Private Types
using	ContainerT = typename ROOT::VecOps::RVec< ItemT >

Private Attributes
size_t	fItemSize

ClusterSize_t	fNWritten

Additional Inherited Members
Static Public Attributes inherited from ROOT::Experimental::Detail::RFieldBase
static constexpr char	kCollectionSeparator = '/'
	Field names convey the level of subfields; sub fields (nested collections) are separated by a dot. More...

Protected Attributes inherited from ROOT::Experimental::Detail::RFieldBase
std::vector< std::unique_ptr< RColumn > >	fColumns
	The columns are connected either to a sink or to a source (not to both); they are owned by the field. More...

RFieldBase *	fParent
	Sub fields point to their mother field. More...

RColumn *	fPrincipalColumn
	All fields have a main column. For collection fields, the main column is the index field. Points into fColumns. More...

std::vector< std::unique_ptr< RFieldBase > >	fSubFields
	Collections and classes own sub fields. More...

#include <ROOT/RField.hxx>

Inheritance diagram for ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >:

[legend]

Member Typedef Documentation

◆ ContainerT

template<typename ItemT >

using ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::ContainerT = typename ROOT::VecOps::RVec<ItemT>

private

Definition at line 650 of file RField.hxx.

Constructor & Destructor Documentation

◆ RField() [1/3]

template<typename ItemT >

ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::RField	(	std::string_view	fieldName,
		std::unique_ptr< Detail::RFieldBase >	itemField
	)

inline

Definition at line 680 of file RField.hxx.

◆ RField() [2/3]

template<typename ItemT >

ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::RField ( std::string_view name )

inlineexplicit

Definition at line 687 of file RField.hxx.

◆ RField() [3/3]

template<typename ItemT >

ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::RField ( RField< ROOT::VecOps::RVec< ItemT > > && other )

default

◆ ~RField()

template<typename ItemT >

ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::~RField ( )

default

Member Function Documentation

◆ CaptureValue()

template<typename ItemT >

Detail::RFieldValue ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::CaptureValue ( void * where )

inlinefinalvirtual

Creates a value from a memory location with an already constructed object.

Implements ROOT::Experimental::Detail::RFieldBase.

Definition at line 729 of file RField.hxx.

◆ Clone()

template<typename ItemT >

RFieldBase * ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::Clone ( std::string_view newName )

inlinefinalvirtual

Implements ROOT::Experimental::Detail::RFieldBase.

Definition at line 694 of file RField.hxx.

◆ CommitCluster()

template<typename ItemT >

void ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::CommitCluster ( )

inlinefinalvirtual

Perform housekeeping tasks for global to cluster-local index translation.

Reimplemented from ROOT::Experimental::Detail::RFieldBase.

Definition at line 716 of file RField.hxx.

◆ DestroyValue()

template<typename ItemT >

void ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::DestroyValue	(	const Detail::RFieldValue &	value,
		bool	dtorOnly = `false`
	)

inlinefinalvirtual

Releases the resources acquired during GenerateValue (memory and constructor) This implementation works for simple types but needs to be overwritten for complex ones.

Reimplemented from ROOT::Experimental::Detail::RFieldBase.

Definition at line 705 of file RField.hxx.

◆ DoAppend()

template<typename ItemT >

void ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::DoAppend ( const Detail::RFieldValue & value )

inlinefinalprotectedvirtual

Operations on values of complex types, e.g.

ones that involve multiple columns or for which no direct column type exists.

Reimplemented from ROOT::Experimental::Detail::RFieldBase.

Definition at line 656 of file RField.hxx.

◆ DoGenerateColumns()

template<typename ItemT >

void ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::DoGenerateColumns ( )

inlinefinalvirtual

Creates the backing columns corresponsing to the field type and name.

Implements ROOT::Experimental::Detail::RFieldBase.

Definition at line 699 of file RField.hxx.

◆ DoRead()

template<typename ItemT >

void ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::DoRead	(	NTupleSize_t	index,
		Detail::RFieldValue *	value
	)

inlinefinalprotectedvirtual

Reimplemented from ROOT::Experimental::Detail::RFieldBase.

Definition at line 667 of file RField.hxx.

◆ GenerateValue() [1/2]

template<typename ItemT >

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::GenerateValue ( void * where )

inlinefinalvirtual

Generates a tree value in a given location of size at least GetValueSize().

Assumes that where has been allocated by malloc().

Implements ROOT::Experimental::Detail::RFieldBase.

Definition at line 726 of file RField.hxx.

◆ GenerateValue() [2/2]

template<typename ItemT >

template<typename... ArgsT>

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::GenerateValue	(	void *	where,
		ArgsT &&...	args
	)

inline

Definition at line 722 of file RField.hxx.

◆ GetNColumns()

template<typename ItemT >

unsigned int ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::GetNColumns ( ) const

inlinefinalvirtual

Returns the number of columns generated to store data for the field; defaults to 1.

Implements ROOT::Experimental::Detail::RFieldBase.

Definition at line 704 of file RField.hxx.

◆ GetValueSize()

template<typename ItemT >

size_t ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::GetValueSize ( ) const

inlinefinalvirtual

The number of bytes taken by a value of the appropriate type.

Implements ROOT::Experimental::Detail::RFieldBase.

Definition at line 732 of file RField.hxx.

◆ MyTypeName()

template<typename ItemT >

static std::string ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::MyTypeName ( )

inlinestatic

Definition at line 718 of file RField.hxx.

◆ operator=()

template<typename ItemT >

RField & ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::operator= ( RField< ROOT::VecOps::RVec< ItemT > > && other )

default

Member Data Documentation

◆ fItemSize

template<typename ItemT >

size_t ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::fItemSize

private

Definition at line 652 of file RField.hxx.

◆ fNWritten

template<typename ItemT >

ClusterSize_t ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::fNWritten

private

Definition at line 653 of file RField.hxx.

Libraries for ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >:

[legend]

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ContainerT

Constructor & Destructor Documentation

◆ RField() [1/3]

◆ RField() [2/3]

◆ RField() [3/3]

◆ ~RField()

Member Function Documentation

◆ CaptureValue()

◆ Clone()

◆ CommitCluster()

◆ DestroyValue()

◆ DoAppend()

◆ DoGenerateColumns()

◆ DoRead()

◆ GenerateValue() [1/2]

◆ GenerateValue() [2/2]

◆ GetNColumns()

◆ GetValueSize()

◆ MyTypeName()

◆ operator=()

Member Data Documentation

◆ fItemSize

◆ fNWritten