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 988 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.

std::unique_ptr< Detail::RFieldBase >	Clone (std::string_view newName) const final

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

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.

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

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

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

size_t	GetAlignment () const final
	For many types, the alignment requirement is equal to the size; otherwise override.

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

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, std::size_t nRepetitions=0)
	The constructor creates the underlying column objects and connects them to either a sink or a source.

virtual	~RFieldBase ()

virtual void	AcceptVisitor (RFieldVisitor &visitor) const

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

void	Attach (std::unique_ptr< Detail::RFieldBase > child)
	Add a new subfield to the list of nested fields.

RSchemaIterator	begin ()

RSchemaIterator	end ()

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

RFieldValue	GenerateValue ()
	Generates an object of the field type and allocates new initialized memory according to the type.

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

std::string	GetName () const

NTupleSize_t	GetNElements () const

std::size_t	GetNRepetitions () const

const RFieldBase *	GetParent () const

ENTupleStructure	GetStructure () const

std::vector< const RFieldBase * >	GetSubFields () const

std::string	GetType () const

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

bool	IsSimple () const

RFieldBase &	operator= (const RFieldBase &)=delete

RFieldBase &	operator= (RFieldBase &&)=default

void	Read (const RClusterIndex &clusterIndex, RFieldValue *value)

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

virtual std::vector< RFieldValue >	SplitValue (const RFieldValue &value) const
	Creates the list of direct child values given a value for this field.

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

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

static RResult< void >	EnsureValidFieldName (std::string_view fieldName)
	Check whether a given string is a valid field name.

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

void	ReadGlobalImpl (NTupleSize_t globalIndex, Detail::RFieldValue *value) final

Protected Member Functions inherited from ROOT::Experimental::Detail::RFieldBase
virtual void	ReadInClusterImpl (const RClusterIndex &clusterIndex, RFieldValue *value)

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

Private Attributes
size_t	fItemSize

ClusterSize_t	fNWritten

Additional Inherited Members
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.

RFieldBase *	fParent
	Sub fields point to their mother field.

RColumn *	fPrincipalColumn
	Points into fColumns.

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

#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 989 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 1019 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 1026 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

◆ AppendImpl()

template<typename ItemT >

void ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >::AppendImpl ( 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 995 of file RField.hxx.

◆ 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 1068 of file RField.hxx.

◆ Clone()

template<typename ItemT >

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

inlinefinalvirtual

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

Definition at line 1033 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 1055 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 1044 of file RField.hxx.

◆ GenerateColumnsImpl()

template<typename ItemT >

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

inlinefinalvirtual

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

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

Definition at line 1038 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 1065 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 1061 of file RField.hxx.

◆ GetAlignment()

template<typename ItemT >

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

inlinefinalvirtual

For many types, the alignment requirement is equal to the size; otherwise override.

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

Definition at line 1072 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 1071 of file RField.hxx.

◆ operator=()

template<typename ItemT >

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

default

◆ ReadGlobalImpl()

template<typename ItemT >

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

inlinefinalprotectedvirtual

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

Definition at line 1006 of file RField.hxx.

◆ TypeName()

template<typename ItemT >

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

inlinestatic

Definition at line 1057 of file RField.hxx.

Member Data Documentation

◆ fItemSize

template<typename ItemT >

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

private

Definition at line 991 of file RField.hxx.

◆ fNWritten

template<typename ItemT >

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

private

Definition at line 992 of file RField.hxx.

tree/ntuple/v7/inc/ROOT/RField.hxx

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

◆ AppendImpl()

◆ CaptureValue()

◆ Clone()

◆ CommitCluster()

◆ DestroyValue()

◆ GenerateColumnsImpl()

◆ GenerateValue() [1/2]

◆ GenerateValue() [2/2]

◆ GetAlignment()

◆ GetValueSize()

◆ operator=()

◆ ReadGlobalImpl()

◆ TypeName()

Member Data Documentation

◆ fItemSize

◆ fNWritten