The generic field for std::tuple<Ts...> types.

Definition at line 1679 of file RField.hxx.

Classes
class	RTupleDeleter

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

	RTupleField (std::string_view fieldName, std::vector< std::unique_ptr< RFieldBase > > &itemFields)

	~RTupleField () override=default

RTupleField &	operator= (RTupleField &&other)=default

Public Member Functions inherited from ROOT::Experimental::RRecordField
	RRecordField (RRecordField &&other)=default

	RRecordField (std::string_view fieldName, std::vector< std::unique_ptr< RFieldBase > > &&itemFields)
	Construct a RRecordField based on a vector of child fields.

	RRecordField (std::string_view fieldName, std::vector< std::unique_ptr< RFieldBase > > &itemFields)

	~RRecordField () override=default

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

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

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

RRecordField &	operator= (RRecordField &&other)=default

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

Public Member Functions inherited from ROOT::Experimental::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 ()=default

RSchemaIterator	begin ()

RValue	BindValue (std::shared_ptr< void > objPtr)
	Creates a value from a memory location with an already constructed object.

RConstSchemaIterator	cbegin () const

RConstSchemaIterator	cend () const

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.

RBulk	CreateBulk ()
	The returned bulk is initially empty; RBulk::ReadBulk will construct the array of values.

template<typename T >
std::unique_ptr< T, typename RCreateObjectDeleter< T >::deleter >	CreateObject () const
	Generates an object of the field type and allocates new initialized memory according to the type.

template<>
std::unique_ptr< void, typename RFieldBase::RCreateObjectDeleter< void >::deleter >	CreateObject () const

template<>
std::unique_ptr< void, typename ROOT::Experimental::RFieldBase::RCreateObjectDeleter< void >::deleter >	CreateObject () const

RValue	CreateValue ()
	Generates an object of the field type and wraps the created object in a shared pointer and returns it an RValue connected to the field.

RSchemaIterator	end ()

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.

std::string	GetFieldName () const

virtual std::uint32_t	GetFieldVersion () const
	Indicates an evolution of the mapping scheme from C++ type to columns.

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

const RFieldBase *	GetParent () const

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

EState	GetState () const

ENTupleStructure	GetStructure () const

std::vector< RFieldBase * >	GetSubFields ()

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

int	GetTraits () const

std::string	GetTypeAlias () const

std::string	GetTypeName () const

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

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	SetColumnRepresentative (const ColumnRepresentation_t &representative)
	Fixes a column representative.

void	SetDescription (std::string_view description)

void	SetOnDiskId (DescriptorId_t id)

Protected Member Functions
	RTupleField (std::string_view fieldName, std::vector< std::unique_ptr< RFieldBase > > &&itemFields, const std::vector< std::size_t > &offsets)

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

void	ConstructValue (void *where) const override
	Constructs value in a given location of size at least GetValueSize(). Called by the base class' CreateValue().

std::unique_ptr< RDeleter >	GetDeleter () const override

Protected Member Functions inherited from ROOT::Experimental::RRecordField
template<std::size_t N>
	RRecordField (std::string_view fieldName, std::array< std::unique_ptr< RFieldBase >, N > &&itemFields, const std::array< std::size_t, N > &offsets, std::string_view typeName="")

	RRecordField (std::string_view fieldName, std::vector< std::unique_ptr< RFieldBase > > &&itemFields, const std::vector< std::size_t > &offsets, std::string_view typeName="")

std::size_t	AppendImpl (const void *from) final
	Operations on values of complex types, e.g.

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

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

std::size_t	GetItemPadding (std::size_t baseOffset, std::size_t itemAlignment) const

void	ReadGlobalImpl (NTupleSize_t globalIndex, void *to) final

void	ReadInClusterImpl (RClusterIndex clusterIndex, void *to) final

Protected Member Functions inherited from ROOT::Experimental::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.

std::size_t	Append (const void *from)
	Write the given value into columns.

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

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

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

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.

void	Read (NTupleSize_t globalIndex, void *to)
	Populate a single value with data from the field.

void	Read (RClusterIndex clusterIndex, void *to)

std::size_t	ReadBulk (const RBulkSpec &bulkSpec)
	Returns the number of newly available values, that is the number of bools in bulkSpec.fMaskAvail that flipped from false to true.

virtual std::size_t	ReadBulkImpl (const RBulkSpec &bulkSpec)
	General implementation of bulk read.

void	RemoveReadCallback (size_t idx)

Static Private Member Functions
static std::string	GetTypeList (const std::vector< std::unique_ptr< RFieldBase > > &itemFields)

Private Attributes
TClass *	fClass = nullptr

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

enum class	EState { kUnconnected , kConnectedToSink , kConnectedToSource }
	During its lifetime, a field undergoes the following possible state transitions: More...

using	RConstSchemaIterator = RSchemaIteratorTemplate<true>

using	RSchemaIterator = RSchemaIteratorTemplate<false>

Static Public Member Functions inherited from ROOT::Experimental::RFieldBase
static std::vector< RCheckResult >	Check (const std::string &fieldName, const std::string &typeName)
	Checks if the given type is supported by RNTuple.

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::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. the destructor performs a no-op.

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

Static Protected Member Functions inherited from ROOT::Experimental::RFieldBase
static std::size_t	CallAppendOn (RFieldBase &other, const void *from)
	Allow derived classes to call Append and Read on other (sub) fields.

static void	CallConstructValueOn (const RFieldBase &other, void *where)
	Allow derived classes to call ConstructValue(void *) and GetDeleter on other (sub) fields.

static void	CallReadOn (RFieldBase &other, NTupleSize_t globalIndex, void *to)

static void	CallReadOn (RFieldBase &other, RClusterIndex clusterIndex, void *to)

static RResult< std::unique_ptr< RFieldBase > >	Create (const std::string &fieldName, const std::string &canonicalType, const std::string &typeAlias, bool fContinueOnError=false)
	Factory method to resurrect a field from the stored on-disk type information.

static std::unique_ptr< RDeleter >	GetDeleterOf (const RFieldBase &other)

static Internal::RColumn *	GetPrincipalColumnOf (const RFieldBase &other)
	Fields may need direct access to the principal column of their sub fields, e.g. in RRVecField::ReadBulk.

Protected Attributes inherited from ROOT::Experimental::RRecordField
std::size_t	fMaxAlignment = 1

std::vector< std::size_t >	fOffsets

std::size_t	fSize = 0

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

std::vector< std::unique_ptr< Internal::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.

Internal::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::RTupleField:

[legend]

Constructor & Destructor Documentation

◆ RTupleField() [1/3]

ROOT::Experimental::RTupleField::RTupleField	(	std::string_view	fieldName,
		std::vector< std::unique_ptr< RFieldBase > > &&	itemFields,
		const std::vector< std::size_t > &	offsets )

protected

Definition at line 3378 of file RField.cxx.

◆ RTupleField() [2/3]

ROOT::Experimental::RTupleField::RTupleField	(	std::string_view	fieldName,
		std::vector< std::unique_ptr< RFieldBase > > &	itemFields )

Definition at line 3386 of file RField.cxx.

◆ RTupleField() [3/3]

ROOT::Experimental::RTupleField::RTupleField ( RTupleField && other )

default

◆ ~RTupleField()

ROOT::Experimental::RTupleField::~RTupleField ( )

overridedefault

Member Function Documentation

◆ CloneImpl()

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

overrideprotectedvirtual

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

Reimplemented from ROOT::Experimental::RRecordField.

Definition at line 3411 of file RField.cxx.

◆ ConstructValue()

void ROOT::Experimental::RTupleField::ConstructValue ( void * where ) const

overrideprotectedvirtual

Constructs value in a given location of size at least GetValueSize(). Called by the base class' CreateValue().

Reimplemented from ROOT::Experimental::RRecordField.

Definition at line 3423 of file RField.cxx.

◆ GetDeleter()

std::unique_ptr< RDeleter > ROOT::Experimental::RTupleField::GetDeleter ( ) const

inlineoverrideprotectedvirtual

Reimplemented from ROOT::Experimental::RRecordField.

Definition at line 1697 of file RField.hxx.

◆ GetTypeList()

static std::string ROOT::Experimental::RTupleField::GetTypeList ( const std::vector< std::unique_ptr< RFieldBase > > & itemFields )

staticprivate

◆ operator=()

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

default

Member Data Documentation

◆ fClass

TClass* ROOT::Experimental::RTupleField::fClass = nullptr

private

Definition at line 1690 of file RField.hxx.

Libraries for ROOT::Experimental::RTupleField:

[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

Static Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RTupleField() [1/3]

◆ RTupleField() [2/3]

◆ RTupleField() [3/3]

◆ ~RTupleField()

Member Function Documentation

◆ CloneImpl()

◆ ConstructValue()

◆ GetDeleter()

◆ GetTypeList()

◆ operator=()

Member Data Documentation

◆ fClass