The field for a class with dictionary.

Definition at line 399 of file RField.hxx.

Classes
struct	RSubFieldInfo

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

	RClassField (std::string_view fieldName, std::string_view className)

	~RClassField () override=default

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

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.

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

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

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

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

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

virtual void	AcceptVisitor (RFieldVisitor &visitor) const

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

virtual RFieldValue	CaptureValue (void *where)=0
	Creates a value from a memory location with an already constructed object.

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.

virtual void	CommitCluster ()
	Perform housekeeping tasks for global to cluster-local index translation.

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

void	ConnectPageSource (RPageSource &pageSource)

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 RFieldValue	GenerateValue (void *where)=0
	Generates a tree value in a given location of size at least GetValueSize().

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

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.

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

std::uint32_t	GetOnDiskTypeVersion () const
	Return the C++ type version stored in the field descriptor; only valid after a call to `ConnectPageSource()`

RFieldBase *	GetParent () const

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

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.

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

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

void	SetDescription (std::string_view description)

void	SetOnDiskId (DescriptorId_t id)

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

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

void	OnConnectPageSource () final
	Called by `ConnectPageSource()` only once connected; derived classes may override this as appropriate.

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

void	ReadInClusterImpl (const RClusterIndex &clusterIndex, 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.

virtual std::size_t	AppendImpl (const RFieldValue &value)
	Operations on values of complex types, e.g.

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 std::unique_ptr< RFieldBase >	CloneImpl (std::string_view newName) const =0
	Called by Clone(), which additionally copies the on-disk ID.

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

virtual void	GenerateColumnsImpl ()=0
	Creates the backing columns corresponsing to the field type for writing.

virtual void	GenerateColumnsImpl (const RNTupleDescriptor &desc)=0
	Creates the backing columns corresponsing to the field type for reading.

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.

virtual void	ReadGlobalImpl (NTupleSize_t globalIndex, RFieldValue *value)

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

void	RemoveReadCallback (size_t idx)

Private Types
enum	ESubFieldRole { kBaseClass , kDataMember }

Private Member Functions
	RClassField (std::string_view fieldName, std::string_view className, TClass *classp)

void	AddReadCallbacksFromIORules (const std::span< const TSchemaRule * > rules, TClass *classp=nullptr)
	Register post-read callbacks corresponding to a list of ROOT I/O customization rules.

void	Attach (std::unique_ptr< Detail::RFieldBase > child, RSubFieldInfo info)

Private Attributes
TClass *	fClass

std::size_t	fMaxAlignment = 1

std::vector< RSubFieldInfo >	fSubFieldsInfo
	Additional information kept for each entry in `fSubFields`

Static Private Attributes
static constexpr const char *	kPrefixInherited {":"}
	Prefix used in the subfield names generated for base classes.

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

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 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. 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
const ColumnRepresentation_t *	fColumnRepresentative = nullptr
	Points into the static vector GetColumnRepresentations().GetSerializationTypes() when SetColumnRepresentative is called.

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.

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.

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

[legend]

Member Enumeration Documentation

◆ ESubFieldRole

enum ROOT::Experimental::RClassField::ESubFieldRole

private

Enumerator
kBaseClass
kDataMember

Definition at line 401 of file RField.hxx.

Constructor & Destructor Documentation

◆ RClassField() [1/3]

ROOT::Experimental::RClassField::RClassField	(	std::string_view	fieldName,
		std::string_view	className,
		TClass *	classp
	)

private

Definition at line 1060 of file RField.cxx.

◆ RClassField() [2/3]

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

Definition at line 1055 of file RField.cxx.

◆ RClassField() [3/3]

ROOT::Experimental::RClassField::RClassField ( RClassField && other )

default

◆ ~RClassField()

ROOT::Experimental::RClassField::~RClassField ( )

overridedefault

Member Function Documentation

◆ AcceptVisitor()

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

overridevirtual

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

Definition at line 1239 of file RField.cxx.

◆ AddReadCallbacksFromIORules()

void ROOT::Experimental::RClassField::AddReadCallbacksFromIORules	(	const std::span< const TSchemaRule * >	rules,
		TClass *	classp = `nullptr`
	)

private

Register post-read callbacks corresponding to a list of ROOT I/O customization rules.

classp is used to fill the TVirtualObject instance passed to the user function.

Definition at line 1122 of file RField.cxx.

◆ AppendImpl()

std::size_t ROOT::Experimental::RClassField::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 1148 of file RField.cxx.

◆ Attach()

void ROOT::Experimental::RClassField::Attach	(	std::unique_ptr< Detail::RFieldBase >	child,
		RSubFieldInfo	info
	)

private

Definition at line 1115 of file RField.cxx.

◆ CaptureValue()

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

finalvirtual

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

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

Definition at line 1211 of file RField.cxx.

◆ CloneImpl()

std::unique_ptr< ROOT::Experimental::Detail::RFieldBase > ROOT::Experimental::RClassField::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 1143 of file RField.cxx.

◆ DestroyValue()

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

◆ GenerateColumnsImpl() [1/2]

void ROOT::Experimental::RClassField::GenerateColumnsImpl ( )

inlinefinalprotectedvirtual

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

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

Definition at line 426 of file RField.hxx.

◆ GenerateColumnsImpl() [2/2]

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

inlinefinalprotectedvirtual

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 427 of file RField.hxx.

◆ GenerateValue()

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::RClassField::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.

Reimplemented in ROOT::Experimental::RField< T, typename >.

Definition at line 1199 of file RField.cxx.

◆ GetAlignment()

size_t ROOT::Experimental::RClassField::GetAlignment ( ) const

inlinefinalvirtual

As a rule of thumb, the alignment is equal to the size of the type.

There are, however, various exceptions to this rule depending on OS and CPU architecture. So enforce the alignment to be explicitly spelled out.

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

Definition at line 445 of file RField.hxx.

◆ GetTypeVersion()

std::uint32_t ROOT::Experimental::RClassField::GetTypeVersion ( ) const

finalvirtual

Indicates an evolution of the C++ type itself.

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

Definition at line 1234 of file RField.cxx.

◆ GetValueSize()

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

overridevirtual

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

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

Definition at line 1229 of file RField.cxx.

◆ OnConnectPageSource()

void ROOT::Experimental::RClassField::OnConnectPageSource ( )

finalprotectedvirtual

Called by ConnectPageSource() only once connected; derived classes may override this as appropriate.

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

Definition at line 1173 of file RField.cxx.

◆ operator=()

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

default

◆ ReadGlobalImpl()

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

finalprotectedvirtual

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

Definition at line 1157 of file RField.cxx.

◆ ReadInClusterImpl()

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

finalprotectedvirtual

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

Definition at line 1165 of file RField.cxx.

◆ SplitValue()

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

Member Data Documentation

◆ fClass

TClass* ROOT::Experimental::RClassField::fClass

private

Definition at line 412 of file RField.hxx.

◆ fMaxAlignment

std::size_t ROOT::Experimental::RClassField::fMaxAlignment = 1

private

Definition at line 415 of file RField.hxx.

◆ fSubFieldsInfo

std::vector<RSubFieldInfo> ROOT::Experimental::RClassField::fSubFieldsInfo

private

Additional information kept for each entry in fSubFields

Definition at line 414 of file RField.hxx.

◆ kPrefixInherited

constexpr const char* ROOT::Experimental::RClassField::kPrefixInherited {":"}

staticconstexprprivate

Prefix used in the subfield names generated for base classes.

Definition at line 410 of file RField.hxx.

Libraries for ROOT::Experimental::RClassField:

[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

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ ESubFieldRole

Constructor & Destructor Documentation

◆ RClassField() [1/3]

◆ RClassField() [2/3]

◆ RClassField() [3/3]

◆ ~RClassField()

Member Function Documentation

◆ AcceptVisitor()

◆ AddReadCallbacksFromIORules()

◆ AppendImpl()

◆ Attach()

◆ CaptureValue()

◆ CloneImpl()

◆ DestroyValue()

◆ GenerateColumnsImpl() [1/2]

◆ GenerateColumnsImpl() [2/2]

◆ GenerateValue()

◆ GetAlignment()

◆ GetTypeVersion()

◆ GetValueSize()

◆ OnConnectPageSource()

◆ operator=()

◆ ReadGlobalImpl()

◆ ReadInClusterImpl()

◆ SplitValue()

Member Data Documentation

◆ fClass

◆ fMaxAlignment

◆ fSubFieldsInfo

◆ kPrefixInherited