Definition at line 81 of file RField.hxx.

Classes
class	RColumnRepresentations
	Some fields have multiple possible column representations, e.g. More...

class	RSchemaIterator
	Iterates over the sub tree of fields in depth-first search order. More...

Public Types
using	ColumnRepresentation_t = std::vector< EColumnType >

Public Member Functions
	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. More...

virtual	~RFieldBase ()

virtual void	AcceptVisitor (RFieldVisitor &visitor) const

std::size_t	Append (const RFieldValue &value)
	Write the given value into columns. More...

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

RSchemaIterator	begin ()

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

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

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

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

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

RSchemaIterator	end ()

void	Flush () const
	Ensure that all received items are written from page buffers to the storage. More...

RFieldValue	GenerateValue ()
	Generates an object of the field type and allocates new initialized memory according to the type. More...

virtual RFieldValue	GenerateValue (void *where)=0
	Generates a tree value in a given location of size at least GetValueSize(). More...

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

const ColumnRepresentation_t &	GetColumnRepresentative () const
	Returns the fColumnRepresentative pointee or, if unset, the field's default representative. More...

std::string	GetDescription () const
	Get the field's description. More...

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

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

RFieldBase *	GetParent () const

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

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

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

bool	HasDefaultColumnRepresentative () const
	Whether or not an explicit column representative was set. More...

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

void	SetColumnRepresentative (const ColumnRepresentation_t &representative)
	Fixes a column representative. More...

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

Static Public Member Functions
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. More...

static RResult< void >	EnsureValidFieldName (std::string_view fieldName)
	Check whether a given string is a valid field name. More...

Static Public Attributes
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. More...

static constexpr int	kTraitTriviallyConstructible = 0x01
	No constructor needs to be called, i.e. More...

static constexpr int	kTraitTriviallyDestructible = 0x02
	The type is cleaned up just by freeing its memory. I.e. DestroyValue() is a no-op. More...

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

Protected Member Functions
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. More...

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

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

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

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

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

virtual const RColumnRepresentations &	GetColumnRepresentations () const
	Implementations in derived classes should return a static RColumnRepresentations object. More...

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

virtual void	ReadGlobalImpl (NTupleSize_t globalIndex, RFieldValue *value)

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

void	RemoveReadCallback (size_t idx)

Protected Attributes
const ColumnRepresentation_t *	fColumnRepresentative = nullptr
	Points into the static vector GetColumnRepresentations().GetSerializationTypes() when SetColumnRepresentative is called. More...

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

std::uint32_t	fOnDiskTypeVersion = kInvalidTypeVersion
	C++ type version cached from the descriptor after a call to `ConnectPageSource()` More...

RFieldBase *	fParent
	Sub fields point to their mother field. More...

RColumn *	fPrincipalColumn
	Points into fColumns. More...

std::vector< ReadCallback_t >	fReadCallbacks
	List of functions to be called after reading a value. More...

std::vector< std::unique_ptr< RFieldBase > >	fSubFields
	Collections and classes own sub fields. More...

int	fTraits = 0
	Properties of the type that allow for optimizations of collections of that type. More...

Private Types
using	ReadCallback_t = std::function< void(RFieldValue &)>

Private Member Functions
void	InvokeReadCallbacks (RFieldValue &value)

Private Attributes
std::string	fDescription
	Free text set by the user. More...

bool	fIsSimple
	A field qualifies as simple if it is both mappable and has no post-read callback. More...

std::string	fName
	The field name relative to its parent field. More...

std::size_t	fNRepetitions
	For fixed sized arrays, the array length. More...

DescriptorId_t	fOnDiskId = kInvalidDescriptorId
	When the columns are connected to a page source or page sink, the field represents a field id in the corresponding RNTuple descriptor. More...

ENTupleStructure	fStructure
	The role of this field in the data model structure. More...

std::string	fType
	The C++ type captured by this field. More...

Friends
struct	ROOT::Experimental::Internal::RFieldCallbackInjector

class	ROOT::Experimental::RCollectionField

#include <ROOT/RField.hxx>

Inheritance diagram for ROOT::Experimental::Detail::RFieldBase:

[legend]

Member Typedef Documentation

◆ ColumnRepresentation_t

using ROOT::Experimental::Detail::RFieldBase::ColumnRepresentation_t = std::vector<EColumnType>

Definition at line 99 of file RField.hxx.

◆ ReadCallback_t

using ROOT::Experimental::Detail::RFieldBase::ReadCallback_t = std::function<void(RFieldValue &)>

private

Definition at line 84 of file RField.hxx.

Constructor & Destructor Documentation

◆ RFieldBase() [1/3]

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

If isSimple is true, the trait kTraitMappable is automatically set on construction. However, the field might be demoted to non-simple if a post-read callback is set.

Definition at line 209 of file RField.cxx.

◆ RFieldBase() [2/3]

ROOT::Experimental::Detail::RFieldBase::RFieldBase ( const RFieldBase & )

delete

◆ RFieldBase() [3/3]

ROOT::Experimental::Detail::RFieldBase::RFieldBase ( RFieldBase && )

default

◆ ~RFieldBase()

ROOT::Experimental::Detail::RFieldBase::~RFieldBase ( )

virtual

Definition at line 216 of file RField.cxx.

Member Function Documentation

◆ AcceptVisitor()

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

virtual

Definition at line 544 of file RField.cxx.

◆ AddReadCallback()

size_t ROOT::Experimental::Detail::RFieldBase::AddReadCallback ( ReadCallback_t func )

protected

Set a user-defined function to be called after reading a value, giving a chance to inspect and/or modify the value object.

Returns an index that can be used to remove the callback.

Definition at line 472 of file RField.cxx.

◆ Append()

std::size_t ROOT::Experimental::Detail::RFieldBase::Append ( const RFieldValue & value )

inline

Write the given value into columns.

The value object has to be of the same type as the field. Returns the number of uncompressed bytes written.

Definition at line 282 of file RField.hxx.

◆ AppendImpl()

std::size_t ROOT::Experimental::Detail::RFieldBase::AppendImpl ( const RFieldValue & value )

protectedvirtual

Operations on values of complex types, e.g.

ones that involve multiple columns or for which no direct column type exists.

Reimplemented in ROOT::Experimental::RClassField, ROOT::Experimental::RCollectionClassField, ROOT::Experimental::RRecordField, ROOT::Experimental::RVectorField, ROOT::Experimental::RArrayField, ROOT::Experimental::RBitsetField, ROOT::Experimental::RVariantField, ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >, and ROOT::Experimental::RRVecField.

Definition at line 371 of file RField.cxx.

◆ Attach()

void ROOT::Experimental::Detail::RFieldBase::Attach ( std::unique_ptr< Detail::RFieldBase > child )

Add a new subfield to the list of nested fields.

Definition at line 403 of file RField.cxx.

◆ begin()

ROOT::Experimental::Detail::RFieldBase::RSchemaIterator ROOT::Experimental::Detail::RFieldBase::begin ( )

Definition at line 550 of file RField.cxx.

◆ CaptureValue()

virtual RFieldValue ROOT::Experimental::Detail::RFieldBase::CaptureValue ( void * where )

pure virtual

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

◆ Clone()

std::unique_ptr< ROOT::Experimental::Detail::RFieldBase > ROOT::Experimental::Detail::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.

Definition at line 361 of file RField.cxx.

◆ CloneImpl()

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

protectedpure virtual

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

◆ CommitCluster()

virtual void ROOT::Experimental::Detail::RFieldBase::CommitCluster ( )

inlinevirtual

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

Reimplemented in ROOT::Experimental::RCollectionClassField, ROOT::Experimental::RVectorField, ROOT::Experimental::RRVecField, ROOT::Experimental::RVariantField, and ROOT::Experimental::RCollectionField.

Definition at line 321 of file RField.hxx.

◆ ConnectPageSink()

void ROOT::Experimental::Detail::RFieldBase::ConnectPageSink ( RPageSink & pageSink )

Fields and their columns live in the void until connected to a physical page storage.

Only once connected, data can be read or written. In order to find the field in the page storage, the field's on-disk ID has to be set.

Definition at line 485 of file RField.cxx.

◆ ConnectPageSource()

void ROOT::Experimental::Detail::RFieldBase::ConnectPageSource ( RPageSource & pageSource )

Definition at line 514 of file RField.cxx.

◆ Create()

ROOT::Experimental::RResult< std::unique_ptr< ROOT::Experimental::Detail::RFieldBase > > ROOT::Experimental::Detail::RFieldBase::Create	(	const std::string &	fieldName,
		const std::string &	typeName
	)

static

Factory method to resurrect a field from the stored on-disk type information.

Definition at line 232 of file RField.cxx.

◆ DestroyValue()

void ROOT::Experimental::Detail::RFieldBase::DestroyValue	(	const RFieldValue &	value,
		bool	dtorOnly = `false`
	)

virtual

Releases the resources acquired during GenerateValue (memory and constructor) This implementation works for simple types but needs to be overwritten for complex ones.

Reimplemented in ROOT::Experimental::RClassField, ROOT::Experimental::RCollectionClassField, ROOT::Experimental::RVectorField, ROOT::Experimental::RArrayField, ROOT::Experimental::RVariantField, ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >, ROOT::Experimental::RRecordField, ROOT::Experimental::RRVecField, ROOT::Experimental::RPairField, and ROOT::Experimental::RTupleField.

Definition at line 391 of file RField.cxx.

◆ end()

ROOT::Experimental::Detail::RFieldBase::RSchemaIterator ROOT::Experimental::Detail::RFieldBase::end ( )

Definition at line 557 of file RField.cxx.

◆ EnsureCompatibleColumnTypes()

const ROOT::Experimental::Detail::RFieldBase::ColumnRepresentation_t & ROOT::Experimental::Detail::RFieldBase::EnsureCompatibleColumnTypes ( const RNTupleDescriptor & desc ) const

protected

Returns the on-disk column types found in the provided descriptor for fOnDiskId.

Throws an exception if the types don't match any of the deserialization types from GetColumnRepresentations().

Definition at line 448 of file RField.cxx.

◆ EnsureValidFieldName()

ROOT::Experimental::RResult< void > ROOT::Experimental::Detail::RFieldBase::EnsureValidFieldName ( std::string_view fieldName )

static

Check whether a given string is a valid field name.

Definition at line 343 of file RField.cxx.

◆ Flush()

void ROOT::Experimental::Detail::RFieldBase::Flush ( ) const

Ensure that all received items are written from page buffers to the storage.

Definition at line 421 of file RField.cxx.

◆ GenerateColumnsImpl() [1/2]

virtual void ROOT::Experimental::Detail::RFieldBase::GenerateColumnsImpl ( )

protectedpure virtual

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

◆ GenerateColumnsImpl() [2/2]

virtual void ROOT::Experimental::Detail::RFieldBase::GenerateColumnsImpl ( const RNTupleDescriptor & desc )

protectedpure virtual

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.

◆ GenerateValue() [1/2]

ROOT::Experimental::Detail::RFieldValue ROOT::Experimental::Detail::RFieldBase::GenerateValue ( )

Generates an object of the field type and allocates new initialized memory according to the type.

Definition at line 384 of file RField.cxx.

◆ GenerateValue() [2/2]

virtual RFieldValue ROOT::Experimental::Detail::RFieldBase::GenerateValue ( void * where )

pure virtual

Generates a tree value in a given location of size at least GetValueSize().

Assumes that where has been allocated by malloc().

◆ GetAlignment()

virtual size_t ROOT::Experimental::Detail::RFieldBase::GetAlignment ( ) const

pure virtual

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.

◆ GetColumnRepresentations()

const ROOT::Experimental::Detail::RFieldBase::RColumnRepresentations & ROOT::Experimental::Detail::RFieldBase::GetColumnRepresentations ( ) const

protectedvirtual

Implementations in derived classes should return a static RColumnRepresentations object.

The default implementation does not attach any columns to the field.

Reimplemented in ROOT::Experimental::Internal::RRDFCardinalityField, ROOT::Experimental::RCollectionClassField, ROOT::Experimental::RVectorField, ROOT::Experimental::RRVecField, ROOT::Experimental::RBitsetField, ROOT::Experimental::RVariantField, ROOT::Experimental::RCollectionField, ROOT::Experimental::RField< ClusterSize_t >, ROOT::Experimental::RField< RNTupleCardinality >, ROOT::Experimental::RField< bool >, ROOT::Experimental::RField< float >, ROOT::Experimental::RField< double >, and ROOT::Experimental::RField< char >.

Definition at line 354 of file RField.cxx.

◆ GetColumnRepresentative()

const ROOT::Experimental::Detail::RFieldBase::ColumnRepresentation_t & ROOT::Experimental::Detail::RFieldBase::GetColumnRepresentative ( ) const

Returns the fColumnRepresentative pointee or, if unset, the field's default representative.

Definition at line 429 of file RField.cxx.

◆ GetDescription()

std::string ROOT::Experimental::Detail::RFieldBase::GetDescription ( ) const

inline

Get the field's description.

Definition at line 337 of file RField.hxx.

◆ GetFieldVersion()

virtual std::uint32_t ROOT::Experimental::Detail::RFieldBase::GetFieldVersion ( ) const

inlinevirtual

Indicates an evolution of the mapping scheme from C++ type to columns.

Definition at line 358 of file RField.hxx.

◆ GetName()

std::string ROOT::Experimental::Detail::RFieldBase::GetName ( ) const

inline

Definition at line 326 of file RField.hxx.

◆ GetNElements()

NTupleSize_t ROOT::Experimental::Detail::RFieldBase::GetNElements ( ) const

inline

Definition at line 332 of file RField.hxx.

◆ GetNRepetitions()

std::size_t ROOT::Experimental::Detail::RFieldBase::GetNRepetitions ( ) const

inline

Definition at line 331 of file RField.hxx.

◆ GetOnDiskId()

DescriptorId_t ROOT::Experimental::Detail::RFieldBase::GetOnDiskId ( ) const

inline

Definition at line 340 of file RField.hxx.

◆ GetOnDiskTypeVersion()

std::uint32_t ROOT::Experimental::Detail::RFieldBase::GetOnDiskTypeVersion ( ) const

inline

Return the C++ type version stored in the field descriptor; only valid after a call to ConnectPageSource()

Definition at line 362 of file RField.hxx.

◆ GetParent()

RFieldBase * ROOT::Experimental::Detail::RFieldBase::GetParent ( ) const

inline

Definition at line 333 of file RField.hxx.

◆ GetQualifiedFieldName()

std::string ROOT::Experimental::Detail::RFieldBase::GetQualifiedFieldName ( ) const

Returns the field name and parent field names separated by dots ("grandparent.parent.child")

Definition at line 220 of file RField.cxx.

◆ GetStructure()

ENTupleStructure ROOT::Experimental::Detail::RFieldBase::GetStructure ( ) const

inline

Definition at line 330 of file RField.hxx.

◆ GetSubFields()

std::vector< ROOT::Experimental::Detail::RFieldBase * > ROOT::Experimental::Detail::RFieldBase::GetSubFields ( ) const

Definition at line 411 of file RField.cxx.

◆ GetTraits()

int ROOT::Experimental::Detail::RFieldBase::GetTraits ( ) const

inline

Definition at line 277 of file RField.hxx.

◆ GetType()

std::string ROOT::Experimental::Detail::RFieldBase::GetType ( ) const

inline

Definition at line 329 of file RField.hxx.

◆ GetTypeVersion()

virtual std::uint32_t ROOT::Experimental::Detail::RFieldBase::GetTypeVersion ( ) const

inlinevirtual

Indicates an evolution of the C++ type itself.

Reimplemented in ROOT::Experimental::RClassField.

Definition at line 360 of file RField.hxx.

◆ GetValueSize()

virtual size_t ROOT::Experimental::Detail::RFieldBase::GetValueSize ( ) const

pure virtual

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

◆ HasDefaultColumnRepresentative()

bool ROOT::Experimental::Detail::RFieldBase::HasDefaultColumnRepresentative ( ) const

inline

Whether or not an explicit column representative was set.

Definition at line 350 of file RField.hxx.

◆ HasReadCallbacks()

bool ROOT::Experimental::Detail::RFieldBase::HasReadCallbacks ( ) const

inline

Definition at line 278 of file RField.hxx.

◆ InvokeReadCallbacks()

void ROOT::Experimental::Detail::RFieldBase::InvokeReadCallbacks ( RFieldValue & value )

inlineprivate

Definition at line 143 of file RField.hxx.

◆ IsSimple()

bool ROOT::Experimental::Detail::RFieldBase::IsSimple ( ) const

inline

Definition at line 335 of file RField.hxx.

◆ OnConnectPageSource()

virtual void ROOT::Experimental::Detail::RFieldBase::OnConnectPageSource ( )

inlineprotectedvirtual

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

Reimplemented in ROOT::Experimental::RClassField.

Definition at line 202 of file RField.hxx.

◆ operator=() [1/2]

RFieldBase & ROOT::Experimental::Detail::RFieldBase::operator= ( const RFieldBase & )

delete

◆ operator=() [2/2]

RFieldBase & ROOT::Experimental::Detail::RFieldBase::operator= ( RFieldBase && )

default

◆ Read() [1/2]

void ROOT::Experimental::Detail::RFieldBase::Read	(	const RClusterIndex &	clusterIndex,
		RFieldValue *	value
	)

inline

Definition at line 306 of file RField.hxx.

◆ Read() [2/2]

void ROOT::Experimental::Detail::RFieldBase::Read	(	NTupleSize_t	globalIndex,
		RFieldValue *	value
	)

inline

Populate a single value with data from the tree, which needs to be of the fitting type.

Reading copies data into the memory wrapped by the ntuple value. The fast path is conditioned by the field qualifying as simple, i.e. maps as-is to a single column and has no read callback.

Definition at line 294 of file RField.hxx.

◆ ReadGlobalImpl()

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

protectedvirtual

Reimplemented in ROOT::Experimental::RClassField, ROOT::Experimental::RCollectionClassField, ROOT::Experimental::RRecordField, ROOT::Experimental::RVectorField, ROOT::Experimental::RArrayField, ROOT::Experimental::RBitsetField, ROOT::Experimental::RVariantField, ROOT::Experimental::RField< RNTupleCardinality >, ROOT::Experimental::RField< ROOT::VecOps::RVec< ItemT > >, ROOT::Experimental::RRVecField, and ROOT::Experimental::Internal::RRDFCardinalityField.

Definition at line 377 of file RField.cxx.

◆ ReadInClusterImpl()

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

inlineprotectedvirtual

Reimplemented in ROOT::Experimental::RClassField, ROOT::Experimental::RRecordField, ROOT::Experimental::RArrayField, ROOT::Experimental::RField< RNTupleCardinality >, and ROOT::Experimental::Internal::RRDFCardinalityField.

Definition at line 187 of file RField.hxx.

◆ RemoveReadCallback()

void ROOT::Experimental::Detail::RFieldBase::RemoveReadCallback ( size_t idx )

protected

Definition at line 479 of file RField.cxx.

◆ SetColumnRepresentative()

void ROOT::Experimental::Detail::RFieldBase::SetColumnRepresentative ( const ColumnRepresentation_t & representative )

Fixes a column representative.

This can only be done before connecting the field to a page sink. Otherwise, or if the provided representation is not in the list of GetColumnRepresentations, an exception is thrown

Definition at line 436 of file RField.cxx.

◆ SetDescription()

void ROOT::Experimental::Detail::RFieldBase::SetDescription ( std::string_view description )

inline

Definition at line 338 of file RField.hxx.

◆ SetOnDiskId()

void ROOT::Experimental::Detail::RFieldBase::SetOnDiskId ( DescriptorId_t id )

inline

Definition at line 341 of file RField.hxx.

◆ SplitValue()

std::vector< ROOT::Experimental::Detail::RFieldValue > ROOT::Experimental::Detail::RFieldBase::SplitValue ( const RFieldValue & value ) const

virtual

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 in ROOT::Experimental::RClassField, ROOT::Experimental::RCollectionClassField, ROOT::Experimental::RRecordField, ROOT::Experimental::RVectorField, ROOT::Experimental::RRVecField, and ROOT::Experimental::RArrayField.

Definition at line 398 of file RField.cxx.

Friends And Related Function Documentation

◆ ROOT::Experimental::Internal::RFieldCallbackInjector

friend struct ROOT::Experimental::Internal::RFieldCallbackInjector

friend

Definition at line 83 of file RField.hxx.

◆ ROOT::Experimental::RCollectionField

friend class ROOT::Experimental::RCollectionField

friend

Definition at line 82 of file RField.hxx.

Member Data Documentation

◆ fColumnRepresentative

const ColumnRepresentation_t* ROOT::Experimental::Detail::RFieldBase::fColumnRepresentative = nullptr

protected

Points into the static vector GetColumnRepresentations().GetSerializationTypes() when SetColumnRepresentative is called.

Otherwise GetColumnRepresentative returns the default representation.

Definition at line 168 of file RField.hxx.

◆ fColumns

std::vector<std::unique_ptr<RColumn> > ROOT::Experimental::Detail::RFieldBase::fColumns

protected

The columns are connected either to a sink or to a source (not to both); they are owned by the field.

Definition at line 159 of file RField.hxx.

◆ fDescription

std::string ROOT::Experimental::Detail::RFieldBase::fDescription

private

Free text set by the user.

Definition at line 141 of file RField.hxx.

◆ fIsSimple

bool ROOT::Experimental::Detail::RFieldBase::fIsSimple

private

A field qualifies as simple if it is both mappable and has no post-read callback.

Definition at line 135 of file RField.hxx.

◆ fName

std::string ROOT::Experimental::Detail::RFieldBase::fName

private

The field name relative to its parent field.

Definition at line 127 of file RField.hxx.

◆ fNRepetitions

std::size_t ROOT::Experimental::Detail::RFieldBase::fNRepetitions

private

For fixed sized arrays, the array length.

Definition at line 133 of file RField.hxx.

◆ fOnDiskId

DescriptorId_t ROOT::Experimental::Detail::RFieldBase::fOnDiskId = kInvalidDescriptorId

private

When the columns are connected to a page source or page sink, the field represents a field id in the corresponding RNTuple descriptor.

This on-disk ID is set in RPageSink::Create() for writing and by RFieldDescriptor::CreateField() when recreating a field / model from the stored descriptor.

Definition at line 139 of file RField.hxx.

◆ fOnDiskTypeVersion

std::uint32_t ROOT::Experimental::Detail::RFieldBase::fOnDiskTypeVersion = kInvalidTypeVersion

protected

C++ type version cached from the descriptor after a call to ConnectPageSource()

Definition at line 165 of file RField.hxx.

◆ fParent

RFieldBase* ROOT::Experimental::Detail::RFieldBase::fParent

protected

Sub fields point to their mother field.

Definition at line 153 of file RField.hxx.

◆ fPrincipalColumn

RColumn* ROOT::Experimental::Detail::RFieldBase::fPrincipalColumn

protected

Points into fColumns.

All fields that have columns have a distinct main column. For simple fields (float, int, ...), the principal column corresponds to the field type. For collection fields expect std::array, the main column is the offset field. Class fields have no column of their own.

Definition at line 157 of file RField.hxx.

◆ fReadCallbacks

std::vector<ReadCallback_t> ROOT::Experimental::Detail::RFieldBase::fReadCallbacks

protected

List of functions to be called after reading a value.

Definition at line 163 of file RField.hxx.

◆ fStructure

ENTupleStructure ROOT::Experimental::Detail::RFieldBase::fStructure

private

The role of this field in the data model structure.

Definition at line 131 of file RField.hxx.

◆ fSubFields

std::vector<std::unique_ptr<RFieldBase> > ROOT::Experimental::Detail::RFieldBase::fSubFields

protected

Collections and classes own sub fields.

Definition at line 151 of file RField.hxx.

◆ fTraits

int ROOT::Experimental::Detail::RFieldBase::fTraits = 0

protected

Properties of the type that allow for optimizations of collections of that type.

Definition at line 161 of file RField.hxx.

◆ fType

std::string ROOT::Experimental::Detail::RFieldBase::fType

private

The C++ type captured by this field.

Definition at line 129 of file RField.hxx.

◆ kInvalidTypeVersion

constexpr std::uint32_t ROOT::Experimental::Detail::RFieldBase::kInvalidTypeVersion = -1U

staticconstexpr

Definition at line 87 of file RField.hxx.

◆ kTraitMappable

constexpr int ROOT::Experimental::Detail::RFieldBase::kTraitMappable = 0x04

staticconstexpr

A field of a fundamental type that can be directly mapped via RField<T>::Map(), i.e.

maps as-is to a single column

Definition at line 95 of file RField.hxx.

◆ kTraitTriviallyConstructible

constexpr int ROOT::Experimental::Detail::RFieldBase::kTraitTriviallyConstructible = 0x01

staticconstexpr

No constructor needs to be called, i.e.

any bit pattern in the allocated memory represents a valid type A trivially constructible field has a no-op GenerateValue() implementation

Definition at line 90 of file RField.hxx.

◆ kTraitTriviallyDestructible

constexpr int ROOT::Experimental::Detail::RFieldBase::kTraitTriviallyDestructible = 0x02

staticconstexpr

The type is cleaned up just by freeing its memory. I.e. DestroyValue() is a no-op.

Definition at line 92 of file RField.hxx.

◆ kTraitTrivialType

constexpr int ROOT::Experimental::Detail::RFieldBase::kTraitTrivialType = kTraitTriviallyConstructible | kTraitTriviallyDestructible

staticconstexpr

Shorthand for types that are both trivially constructible and destructible.

Definition at line 97 of file RField.hxx.

Libraries for ROOT::Experimental::Detail::RFieldBase:

[legend]

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Friends

Member Typedef Documentation

◆ ColumnRepresentation_t

◆ ReadCallback_t

Constructor & Destructor Documentation

◆ RFieldBase() [1/3]

◆ RFieldBase() [2/3]

◆ RFieldBase() [3/3]

◆ ~RFieldBase()

Member Function Documentation

◆ AcceptVisitor()

◆ AddReadCallback()

◆ Append()

◆ AppendImpl()

◆ Attach()

◆ begin()

◆ CaptureValue()

◆ Clone()

◆ CloneImpl()

◆ CommitCluster()

◆ ConnectPageSink()

◆ ConnectPageSource()

◆ Create()

◆ DestroyValue()

◆ end()

◆ EnsureCompatibleColumnTypes()

◆ EnsureValidFieldName()

◆ Flush()

◆ GenerateColumnsImpl() [1/2]

◆ GenerateColumnsImpl() [2/2]

◆ GenerateValue() [1/2]

◆ GenerateValue() [2/2]

◆ GetAlignment()

◆ GetColumnRepresentations()

◆ GetColumnRepresentative()

◆ GetDescription()

◆ GetFieldVersion()

◆ GetName()

◆ GetNElements()

◆ GetNRepetitions()

◆ GetOnDiskId()

◆ GetOnDiskTypeVersion()

◆ GetParent()

◆ GetQualifiedFieldName()

◆ GetStructure()

◆ GetSubFields()

◆ GetTraits()

◆ GetType()

◆ GetTypeVersion()

◆ GetValueSize()

◆ HasDefaultColumnRepresentative()

◆ HasReadCallbacks()

◆ InvokeReadCallbacks()

◆ IsSimple()

◆ OnConnectPageSource()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Read() [1/2]

◆ Read() [2/2]

◆ ReadGlobalImpl()

◆ ReadInClusterImpl()

◆ RemoveReadCallback()

◆ SetColumnRepresentative()

◆ SetDescription()

◆ SetOnDiskId()

◆ SplitValue()

Friends And Related Function Documentation

◆ ROOT::Experimental::Internal::RFieldCallbackInjector

◆ ROOT::Experimental::RCollectionField

Member Data Documentation