Definition at line 432 of file RField.hxx.

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

	RCollectionField (std::string_view name, std::shared_ptr< RCollectionNTuple > collectionNTuple, std::unique_ptr< RNTupleModel > collectionModel)

	~RCollectionField ()=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	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().

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

RCollectionField &	operator= (RCollectionField &&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 ()

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 size_t	GetAlignment () const
	For many types, the alignment requirement is equal to the size; otherwise override.

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.

Private Attributes
std::shared_ptr< RCollectionNTuple >	fCollectionNTuple
	Save the link to the collection ntuple in order to reset the offset counter when committing the cluster.

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

virtual void	ReadGlobalImpl (NTupleSize_t globalIndex, RFieldValue *value)

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

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::RCollectionField:

[legend]

Constructor & Destructor Documentation

◆ RCollectionField() [1/2]

ROOT::Experimental::RCollectionField::RCollectionField	(	std::string_view	name,
		std::shared_ptr< RCollectionNTuple >	collectionNTuple,
		std::unique_ptr< RNTupleModel >	collectionModel
	)

Definition at line 1053 of file RField.cxx.

◆ RCollectionField() [2/2]

ROOT::Experimental::RCollectionField::RCollectionField ( RCollectionField && other )

default

◆ ~RCollectionField()

ROOT::Experimental::RCollectionField::~RCollectionField ( )

default

Member Function Documentation

◆ CaptureValue()

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

inlinefinalvirtual

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

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

Definition at line 454 of file RField.hxx.

◆ Clone()

std::unique_ptr< ROOT::Experimental::Detail::RFieldBase > ROOT::Experimental::RCollectionField::Clone ( std::string_view newName ) const

finalvirtual

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

Definition at line 1077 of file RField.cxx.

◆ CommitCluster()

void ROOT::Experimental::RCollectionField::CommitCluster ( )

finalvirtual

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

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

Definition at line 1091 of file RField.cxx.

◆ GenerateColumnsImpl()

void ROOT::Experimental::RCollectionField::GenerateColumnsImpl ( )

finalvirtual

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

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

Definition at line 1067 of file RField.cxx.

◆ GenerateValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RCollectionField::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 449 of file RField.hxx.

◆ GetValueSize()

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

inlinefinalvirtual

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

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

Definition at line 458 of file RField.hxx.

◆ operator=()

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

default

◆ TypeName()

static std::string ROOT::Experimental::RCollectionField::TypeName ( )

inlinestatic

Definition at line 437 of file RField.hxx.

Member Data Documentation

◆ fCollectionNTuple

std::shared_ptr<RCollectionNTuple> ROOT::Experimental::RCollectionField::fCollectionNTuple

private

Save the link to the collection ntuple in order to reset the offset counter when committing the cluster.

Definition at line 435 of file RField.hxx.

Libraries for ROOT::Experimental::RCollectionField:

[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

Static Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RCollectionField() [1/2]

◆ RCollectionField() [2/2]

◆ ~RCollectionField()

Member Function Documentation

◆ CaptureValue()

◆ Clone()

◆ CommitCluster()

◆ GenerateColumnsImpl()

◆ GenerateValue()

◆ GetValueSize()

◆ operator=()

◆ TypeName()

Member Data Documentation

◆ fCollectionNTuple