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(), Sizeof(), PushProxy(), PopProxy(), At(), Clear(), and Insert().

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

Definition at line 392 of file RField.hxx.

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.

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.

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

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

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 ()

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 ()

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.

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

void	ConnectPageSource (RPageSource &pageSource)

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.

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

RFieldBase *	GetParent () const

ENTupleStructure	GetStructure () const

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

int	GetTraits () const

std::string	GetType () const

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

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	SetDescription (std::string_view description)

void	SetOnDiskId (DescriptorId_t id)

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

ROOT::Experimental::EColumnType	EnsureColumnType (const std::vector< EColumnType > &requestedTypes, unsigned int columnIndex, const RNTupleDescriptor &desc)
	Throws an exception if the column given by fOnDiskId and the columnIndex in the provided descriptor is not of one of the requested types.

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
std::size_t	fItemSize

ClusterSize_t	fNWritten

std::unique_ptr< TVirtualCollectionProxy >	fProxy

Static Private Attributes
static constexpr const std::size_t	kReadChunkSize = 64 * 1024
	Chunk size in bytes used in `ReadGlobalImp()`.

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

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

◆ RCollectionClassField() [2/3]

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

Definition at line 988 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 1150 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 1047 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 1128 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 1041 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 1145 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 1113 of file RField.cxx.

◆ GenerateColumnsImpl() [1/2]

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

finalvirtual

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

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

Definition at line 1095 of file RField.cxx.

◆ GenerateColumnsImpl() [2/2]

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

finalvirtual

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

◆ GetAlignment()

size_t ROOT::Experimental::RCollectionClassField::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 422 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 429 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 425 of file RField.hxx.

◆ 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 421 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 1062 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 1134 of file RField.cxx.

Member Data Documentation

◆ fItemSize

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

private

Definition at line 398 of file RField.hxx.

◆ fNWritten

ClusterSize_t ROOT::Experimental::RCollectionClassField::fNWritten

private

Definition at line 399 of file RField.hxx.

◆ fProxy

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

private

Definition at line 397 of file RField.hxx.

◆ kReadChunkSize

constexpr const std::size_t ROOT::Experimental::RCollectionClassField::kReadChunkSize = 64 * 1024

staticconstexprprivate

Chunk size in bytes used in ReadGlobalImp().

Items held in the same chunk will be inserted in a single TVirtualCollectionProxy::Insert() call.

Definition at line 396 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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static 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]

◆ GetValueSize()

◆ operator=()

◆ ReadGlobalImpl()

◆ SplitValue()

Member Data Documentation

◆ fItemSize

◆ fNWritten

◆ fProxy

◆ kReadChunkSize