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

Definition at line 1704 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 () override=default

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

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.

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::RRVecField
	RRVecField (const RRVecField &)=delete

	RRVecField (RRVecField &&)=default

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

	~RRVecField () 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) override
	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 override
	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.

RRVecField &	operator= (RRVecField &&)=default

RRVecField &	operator= (RRVecField &)=delete

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)

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
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::RRVecField
std::size_t	AppendImpl (const Detail::RFieldValue &value) override
	Operations on values of complex types, e.g.

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

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

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 Types
using	ContainerT = typename ROOT::VecOps::RVec< ItemT >

Additional Inherited Members
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::RRVecField
std::size_t	fItemSize

ClusterSize_t	fNWritten

std::size_t	fValueSize

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::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 1705 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 1737 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 1742 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 ( )

overridedefault

Member Function Documentation

◆ AppendImpl()

template<typename ItemT >

std::size_t 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 1711 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 1768 of file RField.hxx.

◆ CloneImpl()

template<typename ItemT >

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

inlinefinalprotectedvirtual

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

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

Definition at line 1707 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 1750 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 1765 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 1761 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 1772 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 1771 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 1724 of file RField.hxx.

◆ TypeName()

template<typename ItemT >

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

inlinestatic

Definition at line 1757 of file RField.hxx.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

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

◆ CloneImpl()

◆ DestroyValue()

◆ GenerateValue() [1/2]

◆ GenerateValue() [2/2]

◆ GetAlignment()

◆ GetValueSize()

◆ operator=()

◆ ReadGlobalImpl()

◆ TypeName()