The field for a class representing a collection of elements via TVirtualCollectionProxy.

Objects of such type behave as collections that can be accessed through the corresponding member functions in TVirtualCollectionProxy. At a bare minimum, the user is required to provide an implementation for the following functions in TVirtualCollectionProxy: HasPointers(), GetProperties(), GetValueClass(), GetType(), PushProxy(), PopProxy(), GetFunctionCreateIterators(), GetFunctionNext(), and GetFunctionDeleteTwoIterators().

The collection proxy for a given class can be set via TClass::CopyCollectionProxy().

Definition at line 473 of file RField.hxx.

Classes
class	RCollectionIterableOnce
	Allows for iterating over the elements of a proxied collection. More...

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

	RCollectionClassField (std::string_view fieldName, std::string_view className)

	~RCollectionClassField () override=default

void	AcceptVisitor (Detail::RFieldVisitor &visitor) const final

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

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.

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

size_t	GetAlignment () const final
	As a rule of thumb, the alignment is equal to the size of the type.

void	GetCollectionInfo (const RClusterIndex &clusterIndex, RClusterIndex collectionStart, ClusterSize_t size) const

void	GetCollectionInfo (NTupleSize_t globalIndex, RClusterIndex collectionStart, ClusterSize_t size) const

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

RCollectionClassField &	operator= (RCollectionClassField &&other)=default

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

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

std::size_t	Append (const RFieldValue &value)
	Write the given value into columns.

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

RSchemaIterator	begin ()

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

std::unique_ptr< RFieldBase >	Clone (std::string_view newName) const
	Copies the field and its sub fields using a possibly new name and a new, unconnected set of columns.

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

void	ConnectPageSink (RPageSink &pageSink, NTupleSize_t firstEntry=0)
	Fields and their columns live in the void until connected to a physical page storage.

void	ConnectPageSource (RPageSource &pageSource)

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.

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 RFieldValue	GenerateValue (void *where)=0
	Generates a tree value in a given location of size at least GetValueSize().

virtual size_t	GetAlignment () const =0
	As a rule of thumb, the alignment is equal to the size of the type.

const ColumnRepresentation_t &	GetColumnRepresentative () const
	Returns the fColumnRepresentative pointee or, if unset, the field's default representative.

std::string	GetDescription () const
	Get the field's description.

virtual std::uint32_t	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

DescriptorId_t	GetOnDiskId () const

std::uint32_t	GetOnDiskTypeVersion () const
	Return the C++ type version stored in the field descriptor; only valid after a call to `ConnectPageSource()`

RFieldBase *	GetParent () const

std::string	GetQualifiedFieldName () const
	Returns the field name and parent field names separated by dots ("grandparent.parent.child")

ENTupleStructure	GetStructure () const

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

int	GetTraits () const

std::string	GetType () const

std::string	GetTypeAlias () const

virtual std::uint32_t	GetTypeVersion () const
	Indicates an evolution of the C++ type itself.

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

bool	HasDefaultColumnRepresentative () const
	Whether or not an explicit column representative was set.

bool	HasReadCallbacks () const

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.

void	SetColumnRepresentative (const ColumnRepresentation_t &representative)
	Fixes a column representative.

void	SetDescription (std::string_view description)

void	SetOnDiskId (DescriptorId_t id)

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

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

std::unique_ptr< Detail::RFieldBase >	CloneImpl (std::string_view newName) const final
	Called by Clone(), which additionally copies the on-disk ID.

void	GenerateColumnsImpl () final
	Creates the backing columns corresponsing to the field type for writing.

void	GenerateColumnsImpl (const RNTupleDescriptor &desc) final
	Creates the backing columns corresponsing to the field type for reading.

const RColumnRepresentations &	GetColumnRepresentations () const final
	Implementations in derived classes should return a static RColumnRepresentations object.

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

Protected Member Functions inherited from ROOT::Experimental::Detail::RFieldBase
size_t	AddReadCallback (ReadCallback_t func)
	Set a user-defined function to be called after reading a value, giving a chance to inspect and/or modify the value object.

virtual std::size_t	AppendImpl (const RFieldValue &value)
	Operations on values of complex types, e.g.

void	AutoAdjustColumnTypes (const RNTupleWriteOptions &options)
	When connecting a field to a page sink, the field's default column representation is subject to adjustment according to the write options.

virtual std::unique_ptr< RFieldBase >	CloneImpl (std::string_view newName) const =0
	Called by Clone(), which additionally copies the on-disk ID.

const ColumnRepresentation_t &	EnsureCompatibleColumnTypes (const RNTupleDescriptor &desc) const
	Returns the on-disk column types found in the provided descriptor for fOnDiskId.

virtual void	GenerateColumnsImpl ()=0
	Creates the backing columns corresponsing to the field type for writing.

virtual void	GenerateColumnsImpl (const RNTupleDescriptor &desc)=0
	Creates the backing columns corresponsing to the field type for reading.

virtual const RColumnRepresentations &	GetColumnRepresentations () const
	Implementations in derived classes should return a static RColumnRepresentations object.

virtual void	OnConnectPageSource ()
	Called by `ConnectPageSource()` only once connected; derived classes may override this as appropriate.

virtual void	ReadGlobalImpl (NTupleSize_t globalIndex, RFieldValue *value)

virtual void	ReadInClusterImpl (const RClusterIndex &clusterIndex, RFieldValue *value)

void	RemoveReadCallback (size_t idx)

Private Member Functions
	RCollectionClassField (std::string_view fieldName, std::string_view className, TClass *classp)

Private Attributes
RCollectionIterableOnce::RIteratorFuncs	fIFuncsRead
	Two sets of functions to operate on iterators, to be used depending on the access type.

RCollectionIterableOnce::RIteratorFuncs	fIFuncsWrite

std::size_t	fItemSize

ClusterSize_t	fNWritten

Int_t	fProperties

std::unique_ptr< TVirtualCollectionProxy >	fProxy

Additional Inherited Members
Public Types inherited from ROOT::Experimental::Detail::RFieldBase
using	ColumnRepresentation_t = std::vector< EColumnType >

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.

Static Public Attributes inherited from ROOT::Experimental::Detail::RFieldBase
static constexpr std::uint32_t	kInvalidTypeVersion = -1U

static constexpr int	kTraitMappable = 0x04
	A field of a fundamental type that can be directly mapped via `RField<T>::Map()`, i.e.

static constexpr int	kTraitTriviallyConstructible = 0x01
	No constructor needs to be called, i.e.

static constexpr int	kTraitTriviallyDestructible = 0x02
	The type is cleaned up just by freeing its memory. I.e. DestroyValue() is a no-op.

static constexpr int	kTraitTrivialType = kTraitTriviallyConstructible \| kTraitTriviallyDestructible
	Shorthand for types that are both trivially constructible and destructible.

Protected Attributes inherited from ROOT::Experimental::Detail::RFieldBase
const ColumnRepresentation_t *	fColumnRepresentative = nullptr
	Points into the static vector GetColumnRepresentations().GetSerializationTypes() when SetColumnRepresentative is called.

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.

std::uint32_t	fOnDiskTypeVersion = kInvalidTypeVersion
	C++ type version cached from the descriptor after a call to `ConnectPageSource()`

RFieldBase *	fParent
	Sub fields point to their mother field.

RColumn *	fPrincipalColumn
	Points into fColumns.

std::vector< ReadCallback_t >	fReadCallbacks
	List of functions to be called after reading a value.

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

int	fTraits = 0
	Properties of the type that allow for optimizations of collections of that type.

std::string	fTypeAlias
	A typedef or using name that was used when creating the field.

#include <ROOT/RField.hxx>

Inheritance diagram for ROOT::Experimental::RCollectionClassField:

[legend]

Constructor & Destructor Documentation

◆ RCollectionClassField() [1/3]

ROOT::Experimental::RCollectionClassField::RCollectionClassField	(	std::string_view	fieldName,
		std::string_view	className,
		TClass *	classp
	)

private

Definition at line 1316 of file RField.cxx.

◆ RCollectionClassField() [2/3]

ROOT::Experimental::RCollectionClassField::RCollectionClassField	(	std::string_view	fieldName,
		std::string_view	className
	)

Definition at line 1311 of file RField.cxx.

◆ RCollectionClassField() [3/3]

ROOT::Experimental::RCollectionClassField::RCollectionClassField ( RCollectionClassField && other )

default

◆ ~RCollectionClassField()

ROOT::Experimental::RCollectionClassField::~RCollectionClassField ( )

overridedefault

Member Function Documentation

◆ AcceptVisitor()

void ROOT::Experimental::RCollectionClassField::AcceptVisitor ( Detail::RFieldVisitor & visitor ) const

finalvirtual

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

Definition at line 1471 of file RField.cxx.

◆ AppendImpl()

std::size_t ROOT::Experimental::RCollectionClassField::AppendImpl ( const Detail::RFieldValue & value )

finalprotectedvirtual

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 1374 of file RField.cxx.

◆ CaptureValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RCollectionClassField::CaptureValue ( void * where )

overridevirtual

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

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

Definition at line 1450 of file RField.cxx.

◆ CloneImpl()

std::unique_ptr< ROOT::Experimental::Detail::RFieldBase > ROOT::Experimental::RCollectionClassField::CloneImpl ( std::string_view newName ) const

finalprotectedvirtual

Called by Clone(), which additionally copies the on-disk ID.

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

Definition at line 1368 of file RField.cxx.

◆ CommitCluster()

void ROOT::Experimental::RCollectionClassField::CommitCluster ( )

finalvirtual

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

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

Definition at line 1466 of file RField.cxx.

◆ DestroyValue()

void ROOT::Experimental::RCollectionClassField::DestroyValue	(	const Detail::RFieldValue &	value,
		bool	dtorOnly = `false`
	)

finalvirtual

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 1436 of file RField.cxx.

◆ GenerateColumnsImpl() [1/2]

void ROOT::Experimental::RCollectionClassField::GenerateColumnsImpl ( )

finalprotectedvirtual

Creates the backing columns corresponsing to the field type for writing.

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

Definition at line 1420 of file RField.cxx.

◆ GenerateColumnsImpl() [2/2]

void ROOT::Experimental::RCollectionClassField::GenerateColumnsImpl ( const RNTupleDescriptor & desc )

finalprotectedvirtual

Creates the backing columns corresponsing to the field type for reading.

The method should to check, using the page source and fOnDiskId, if the column types match and throw if they don't.

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

Definition at line 1425 of file RField.cxx.

◆ GenerateValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RCollectionClassField::GenerateValue ( void * where )

overridevirtual

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 1431 of file RField.cxx.

◆ GetAlignment()

size_t ROOT::Experimental::RCollectionClassField::GetAlignment ( ) const

inlinefinalvirtual

As a rule of thumb, the alignment is equal to the size of the type.

There are, however, various exceptions to this rule depending on OS and CPU architecture. So enforce the alignment to be explicitly spelled out.

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

Definition at line 558 of file RField.hxx.

◆ GetCollectionInfo() [1/2]

void ROOT::Experimental::RCollectionClassField::GetCollectionInfo	(	const RClusterIndex &	clusterIndex,
		RClusterIndex *	collectionStart,
		ClusterSize_t *	size
	)		const

inline

Definition at line 565 of file RField.hxx.

◆ GetCollectionInfo() [2/2]

void ROOT::Experimental::RCollectionClassField::GetCollectionInfo	(	NTupleSize_t	globalIndex,
		RClusterIndex *	collectionStart,
		ClusterSize_t *	size
	)		const

inline

Definition at line 561 of file RField.hxx.

◆ GetColumnRepresentations()

const ROOT::Experimental::Detail::RFieldBase::RColumnRepresentations & ROOT::Experimental::RCollectionClassField::GetColumnRepresentations ( ) const

finalprotectedvirtual

Implementations in derived classes should return a static RColumnRepresentations object.

The default implementation does not attach any columns to the field.

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

Definition at line 1412 of file RField.cxx.

◆ GetValueSize()

size_t ROOT::Experimental::RCollectionClassField::GetValueSize ( ) const

inlineoverridevirtual

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

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

Definition at line 557 of file RField.hxx.

◆ operator=()

RCollectionClassField & ROOT::Experimental::RCollectionClassField::operator= ( RCollectionClassField && other )

default

◆ ReadGlobalImpl()

void ROOT::Experimental::RCollectionClassField::ReadGlobalImpl	(	NTupleSize_t	globalIndex,
		Detail::RFieldValue *	value
	)

finalprotectedvirtual

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

Definition at line 1391 of file RField.cxx.

◆ SplitValue()

std::vector< ROOT::Experimental::Detail::RFieldValue > ROOT::Experimental::RCollectionClassField::SplitValue ( const Detail::RFieldValue & value ) const

finalvirtual

Creates the list of direct child values given a value for this field.

E.g. a single value for the correct variant or all the elements of a collection. The default implementation assumes no sub values and returns an empty vector.

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

Definition at line 1456 of file RField.cxx.

Member Data Documentation

◆ fIFuncsRead

RCollectionIterableOnce::RIteratorFuncs ROOT::Experimental::RCollectionClassField::fIFuncsRead

private

Two sets of functions to operate on iterators, to be used depending on the access type.

Definition at line 531 of file RField.hxx.

◆ fIFuncsWrite

RCollectionIterableOnce::RIteratorFuncs ROOT::Experimental::RCollectionClassField::fIFuncsWrite

private

Definition at line 532 of file RField.hxx.

◆ fItemSize

std::size_t ROOT::Experimental::RCollectionClassField::fItemSize

private

Definition at line 533 of file RField.hxx.

◆ fNWritten

ClusterSize_t ROOT::Experimental::RCollectionClassField::fNWritten

private

Definition at line 534 of file RField.hxx.

◆ fProperties

Int_t ROOT::Experimental::RCollectionClassField::fProperties

private

Definition at line 529 of file RField.hxx.

◆ fProxy

std::unique_ptr<TVirtualCollectionProxy> ROOT::Experimental::RCollectionClassField::fProxy

private

Definition at line 528 of file RField.hxx.

Libraries for ROOT::Experimental::RCollectionClassField:

[legend]

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

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

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RCollectionClassField() [1/3]

◆ RCollectionClassField() [2/3]

◆ RCollectionClassField() [3/3]

◆ ~RCollectionClassField()

Member Function Documentation

◆ AcceptVisitor()

◆ AppendImpl()

◆ CaptureValue()

◆ CloneImpl()

◆ CommitCluster()

◆ DestroyValue()

◆ GenerateColumnsImpl() [1/2]

◆ GenerateColumnsImpl() [2/2]

◆ GenerateValue()

◆ GetAlignment()

◆ GetCollectionInfo() [1/2]

◆ GetCollectionInfo() [2/2]

◆ GetColumnRepresentations()

◆ GetValueSize()

◆ operator=()

◆ ReadGlobalImpl()

◆ SplitValue()

Member Data Documentation

◆ fIFuncsRead

◆ fIFuncsWrite

◆ fItemSize

◆ fNWritten

◆ fProperties

◆ fProxy