The generic field for fixed size arrays, which do not need an offset column.

Definition at line 342 of file RField.hxx.

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

	RArrayField (std::string_view fieldName, std::unique_ptr< Detail::RFieldBase > itemField, std::size_t arrayLength)

	~RArrayField ()=default

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

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

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.

size_t	GetLength () const

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

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

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	CommitCluster ()
	Perform housekeeping tasks for global to cluster-local index translation.

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.

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

void	ReadInClusterImpl (const RClusterIndex &clusterIndex, Detail::RFieldValue *value) final

Private Attributes
std::size_t	fArrayLength

std::size_t	fItemSize

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.

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

[legend]

Constructor & Destructor Documentation

◆ RArrayField() [1/2]

ROOT::Experimental::RArrayField::RArrayField	(	std::string_view	fieldName,
		std::unique_ptr< Detail::RFieldBase >	itemField,
		std::size_t	arrayLength
	)

Definition at line 835 of file RField.cxx.

◆ RArrayField() [2/2]

ROOT::Experimental::RArrayField::RArrayField ( RArrayField && other )

default

◆ ~RArrayField()

ROOT::Experimental::RArrayField::~RArrayField ( )

default

Member Function Documentation

◆ AcceptVisitor()

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

finalvirtual

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

Definition at line 920 of file RField.cxx.

◆ AppendImpl()

void ROOT::Experimental::RArrayField::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 852 of file RField.cxx.

◆ CaptureValue()

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

finalvirtual

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

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

Definition at line 903 of file RField.cxx.

◆ Clone()

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

finalvirtual

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

Definition at line 846 of file RField.cxx.

◆ DestroyValue()

void ROOT::Experimental::RArrayField::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 892 of file RField.cxx.

◆ GenerateColumnsImpl()

void ROOT::Experimental::RArrayField::GenerateColumnsImpl ( )

finalvirtual

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

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

Definition at line 879 of file RField.cxx.

◆ GenerateValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RArrayField::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 883 of file RField.cxx.

◆ GetAlignment()

size_t ROOT::Experimental::RArrayField::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 367 of file RField.hxx.

◆ GetLength()

size_t ROOT::Experimental::RArrayField::GetLength ( ) const

inline

Definition at line 365 of file RField.hxx.

◆ GetValueSize()

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

inlinefinalvirtual

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

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

Definition at line 366 of file RField.hxx.

◆ operator=()

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

default

◆ ReadGlobalImpl()

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

finalprotectedvirtual

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

Definition at line 860 of file RField.cxx.

◆ ReadInClusterImpl()

void ROOT::Experimental::RArrayField::ReadInClusterImpl	(	const RClusterIndex &	clusterIndex,
		Detail::RFieldValue *	value
	)

finalprotectedvirtual

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

Definition at line 869 of file RField.cxx.

◆ SplitValue()

std::vector< ROOT::Experimental::Detail::RFieldValue > ROOT::Experimental::RArrayField::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 909 of file RField.cxx.

Member Data Documentation

◆ fArrayLength

std::size_t ROOT::Experimental::RArrayField::fArrayLength

private

Definition at line 345 of file RField.hxx.

◆ fItemSize

std::size_t ROOT::Experimental::RArrayField::fItemSize

private

Definition at line 344 of file RField.hxx.

Libraries for ROOT::Experimental::RArrayField:

[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 Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RArrayField() [1/2]

◆ RArrayField() [2/2]

◆ ~RArrayField()

Member Function Documentation

◆ AcceptVisitor()

◆ AppendImpl()

◆ CaptureValue()

◆ Clone()

◆ DestroyValue()

◆ GenerateColumnsImpl()

◆ GenerateValue()

◆ GetAlignment()

◆ GetLength()

◆ GetValueSize()

◆ operator=()

◆ ReadGlobalImpl()

◆ ReadInClusterImpl()

◆ SplitValue()

Member Data Documentation

◆ fArrayLength

◆ fItemSize