The serialization context is used for the piecewise serialization of a descriptor.

During header serialization, the mapping of in-memory field and column IDs to on-disk IDs is built so that it can be used for the footer serialization in a second step.

Definition at line 104 of file RNTupleSerialize.hxx.

Public Member Functions
void	BeginHeaderExtension ()
	Mark the first on-disk field ID that is part of the schema extension.

std::size_t	GetHeaderExtensionOffset () const
	Return the offset of the first element in `fOnDisk2MemFieldIDs` that is part of the schema extension.

std::uint64_t	GetHeaderSize () const

std::uint64_t	GetHeaderXxHash3 () const

DescriptorId_t	GetMemClusterGroupId (DescriptorId_t onDiskId) const

DescriptorId_t	GetMemClusterId (DescriptorId_t onDiskId) const

DescriptorId_t	GetMemColumnId (DescriptorId_t onDiskId) const

DescriptorId_t	GetMemFieldId (DescriptorId_t onDiskId) const

DescriptorId_t	GetOnDiskClusterGroupId (DescriptorId_t memId) const

DescriptorId_t	GetOnDiskClusterId (DescriptorId_t memId) const

DescriptorId_t	GetOnDiskColumnId (DescriptorId_t memId) const

DescriptorId_t	GetOnDiskFieldId (DescriptorId_t memId) const

const std::vector< DescriptorId_t > &	GetOnDiskFieldList () const
	Return a vector containing the in-memory field ID for each on-disk counterpart, in order, i.e.

DescriptorId_t	MapClusterGroupId (DescriptorId_t memId)

DescriptorId_t	MapClusterId (DescriptorId_t memId)

DescriptorId_t	MapFieldId (DescriptorId_t memId)
	Map an in-memory field ID to its on-disk counterpart.

DescriptorId_t	MapPhysicalColumnId (DescriptorId_t memId)
	Map an in-memory column ID to its on-disk counterpart.

void	MapSchema (const RNTupleDescriptor &desc, bool forHeaderExtension)
	Map in-memory field and column IDs to their on-disk counterparts.

void	SetHeaderSize (std::uint64_t size)

void	SetHeaderXxHash3 (std::uint64_t xxhash3)

Private Attributes
std::size_t	fHeaderExtensionOffset = -1U

std::uint64_t	fHeaderSize = 0

std::uint64_t	fHeaderXxHash3 = 0

std::map< DescriptorId_t, DescriptorId_t >	fMem2OnDiskClusterGroupIDs

std::map< DescriptorId_t, DescriptorId_t >	fMem2OnDiskClusterIDs

std::map< DescriptorId_t, DescriptorId_t >	fMem2OnDiskColumnIDs

std::map< DescriptorId_t, DescriptorId_t >	fMem2OnDiskFieldIDs

std::vector< DescriptorId_t >	fOnDisk2MemClusterGroupIDs

std::vector< DescriptorId_t >	fOnDisk2MemClusterIDs

std::vector< DescriptorId_t >	fOnDisk2MemColumnIDs

std::vector< DescriptorId_t >	fOnDisk2MemFieldIDs

#include <ROOT/RNTupleSerialize.hxx>

Member Function Documentation

◆ BeginHeaderExtension()

void ROOT::Experimental::Internal::RNTupleSerializer::RContext::BeginHeaderExtension ( )

inline

Mark the first on-disk field ID that is part of the schema extension.

Definition at line 184 of file RNTupleSerialize.hxx.

◆ GetHeaderExtensionOffset()

std::size_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::GetHeaderExtensionOffset ( ) const

inline

Return the offset of the first element in fOnDisk2MemFieldIDs that is part of the schema extension.

Definition at line 186 of file RNTupleSerialize.hxx.

◆ GetHeaderSize()

std::uint64_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::GetHeaderSize ( ) const

inline

Definition at line 120 of file RNTupleSerialize.hxx.

◆ GetHeaderXxHash3()

std::uint64_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::GetHeaderXxHash3 ( ) const

inline

Definition at line 122 of file RNTupleSerialize.hxx.

◆ GetMemClusterGroupId()

DescriptorId_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::GetMemClusterGroupId ( DescriptorId_t onDiskId ) const

inline

Definition at line 175 of file RNTupleSerialize.hxx.

◆ GetMemClusterId()

DescriptorId_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::GetMemClusterId ( DescriptorId_t onDiskId ) const

inline

Definition at line 174 of file RNTupleSerialize.hxx.

◆ GetMemColumnId()

DescriptorId_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::GetMemColumnId ( DescriptorId_t onDiskId ) const

inline

Definition at line 173 of file RNTupleSerialize.hxx.

◆ GetMemFieldId()

DescriptorId_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::GetMemFieldId ( DescriptorId_t onDiskId ) const

inline

Definition at line 172 of file RNTupleSerialize.hxx.

◆ GetOnDiskClusterGroupId()

DescriptorId_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::GetOnDiskClusterGroupId ( DescriptorId_t memId ) const

inline

Definition at line 168 of file RNTupleSerialize.hxx.

◆ GetOnDiskClusterId()

DescriptorId_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::GetOnDiskClusterId ( DescriptorId_t memId ) const

inline

Definition at line 167 of file RNTupleSerialize.hxx.

◆ GetOnDiskColumnId()

DescriptorId_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::GetOnDiskColumnId ( DescriptorId_t memId ) const

inline

Definition at line 166 of file RNTupleSerialize.hxx.

◆ GetOnDiskFieldId()

DescriptorId_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::GetOnDiskFieldId ( DescriptorId_t memId ) const

inline

Definition at line 165 of file RNTupleSerialize.hxx.

◆ GetOnDiskFieldList()

const std::vector< DescriptorId_t > & ROOT::Experimental::Internal::RNTupleSerializer::RContext::GetOnDiskFieldList ( ) const

inline

Return a vector containing the in-memory field ID for each on-disk counterpart, in order, i.e.

the i-th value corresponds to the in-memory field ID for i-th on-disk ID

Definition at line 182 of file RNTupleSerialize.hxx.

◆ MapClusterGroupId()

DescriptorId_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::MapClusterGroupId ( DescriptorId_t memId )

inline

Definition at line 153 of file RNTupleSerialize.hxx.

◆ MapClusterId()

DescriptorId_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::MapClusterId ( DescriptorId_t memId )

inline

Definition at line 146 of file RNTupleSerialize.hxx.

◆ MapFieldId()

DescriptorId_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::MapFieldId ( DescriptorId_t memId )

inline

Map an in-memory field ID to its on-disk counterpart.

It is allowed to call this function multiple times for the same memId, in which case the return value is the on-disk ID assigned on the first call.

Definition at line 125 of file RNTupleSerialize.hxx.

◆ MapPhysicalColumnId()

DescriptorId_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::MapPhysicalColumnId ( DescriptorId_t memId )

inline

Map an in-memory column ID to its on-disk counterpart.

It is allowed to call this function multiple times for the same memId, in which case the return value is the on-disk ID assigned on the first call. Note that we only map physical column IDs. Logical column IDs of alias columns are shifted before the serialization of the extension header. Also, we only need to query physical column IDs for the page list serialization.

Definition at line 138 of file RNTupleSerialize.hxx.

◆ MapSchema()

void ROOT::Experimental::Internal::RNTupleSerializer::RContext::MapSchema	(	const RNTupleDescriptor &	desc,
		bool	forHeaderExtension
	)

Map in-memory field and column IDs to their on-disk counterparts.

This function is unconditionally called during header serialization. This function must be manually called after an incremental schema update as page list serialization requires all columns to be mapped.

Definition at line 1228 of file RNTupleSerialize.cxx.

◆ SetHeaderSize()

void ROOT::Experimental::Internal::RNTupleSerializer::RContext::SetHeaderSize ( std::uint64_t size )

inline

Definition at line 119 of file RNTupleSerialize.hxx.

◆ SetHeaderXxHash3()

void ROOT::Experimental::Internal::RNTupleSerializer::RContext::SetHeaderXxHash3 ( std::uint64_t xxhash3 )

inline

Definition at line 121 of file RNTupleSerialize.hxx.

Member Data Documentation

◆ fHeaderExtensionOffset

std::size_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::fHeaderExtensionOffset = -1U

private

Definition at line 116 of file RNTupleSerialize.hxx.

◆ fHeaderSize

std::uint64_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::fHeaderSize = 0

private

Definition at line 106 of file RNTupleSerialize.hxx.

◆ fHeaderXxHash3

std::uint64_t ROOT::Experimental::Internal::RNTupleSerializer::RContext::fHeaderXxHash3 = 0

private

Definition at line 107 of file RNTupleSerialize.hxx.

◆ fMem2OnDiskClusterGroupIDs

std::map<DescriptorId_t, DescriptorId_t> ROOT::Experimental::Internal::RNTupleSerializer::RContext::fMem2OnDiskClusterGroupIDs

private

Definition at line 111 of file RNTupleSerialize.hxx.

◆ fMem2OnDiskClusterIDs

std::map<DescriptorId_t, DescriptorId_t> ROOT::Experimental::Internal::RNTupleSerializer::RContext::fMem2OnDiskClusterIDs

private

Definition at line 110 of file RNTupleSerialize.hxx.

◆ fMem2OnDiskColumnIDs

std::map<DescriptorId_t, DescriptorId_t> ROOT::Experimental::Internal::RNTupleSerializer::RContext::fMem2OnDiskColumnIDs

private

Definition at line 109 of file RNTupleSerialize.hxx.

◆ fMem2OnDiskFieldIDs

std::map<DescriptorId_t, DescriptorId_t> ROOT::Experimental::Internal::RNTupleSerializer::RContext::fMem2OnDiskFieldIDs

private

Definition at line 108 of file RNTupleSerialize.hxx.

◆ fOnDisk2MemClusterGroupIDs

std::vector<DescriptorId_t> ROOT::Experimental::Internal::RNTupleSerializer::RContext::fOnDisk2MemClusterGroupIDs

private

Definition at line 115 of file RNTupleSerialize.hxx.

◆ fOnDisk2MemClusterIDs

std::vector<DescriptorId_t> ROOT::Experimental::Internal::RNTupleSerializer::RContext::fOnDisk2MemClusterIDs

private

Definition at line 114 of file RNTupleSerialize.hxx.

◆ fOnDisk2MemColumnIDs

std::vector<DescriptorId_t> ROOT::Experimental::Internal::RNTupleSerializer::RContext::fOnDisk2MemColumnIDs

private

Definition at line 113 of file RNTupleSerialize.hxx.

◆ fOnDisk2MemFieldIDs

std::vector<DescriptorId_t> ROOT::Experimental::Internal::RNTupleSerializer::RContext::fOnDisk2MemFieldIDs

private

Definition at line 112 of file RNTupleSerialize.hxx.

Libraries for ROOT::Experimental::Internal::RNTupleSerializer::RContext:

[legend]

The documentation for this class was generated from the following files:

tree/ntuple/v7/inc/ROOT/RNTupleSerialize.hxx
tree/ntuple/v7/src/RNTupleSerialize.cxx

Public Member Functions

Private Attributes

Member Function Documentation

◆ BeginHeaderExtension()

◆ GetHeaderExtensionOffset()

◆ GetHeaderSize()

◆ GetHeaderXxHash3()

◆ GetMemClusterGroupId()

◆ GetMemClusterId()

◆ GetMemColumnId()

◆ GetMemFieldId()

◆ GetOnDiskClusterGroupId()

◆ GetOnDiskClusterId()

◆ GetOnDiskColumnId()

◆ GetOnDiskFieldId()

◆ GetOnDiskFieldList()

◆ MapClusterGroupId()

◆ MapClusterId()

◆ MapFieldId()

◆ MapPhysicalColumnId()

◆ MapSchema()

◆ SetHeaderSize()

◆ SetHeaderXxHash3()

Member Data Documentation

◆ fHeaderExtensionOffset

◆ fHeaderSize

◆ fHeaderXxHash3

◆ fMem2OnDiskClusterGroupIDs

◆ fMem2OnDiskClusterIDs

◆ fMem2OnDiskColumnIDs

◆ fMem2OnDiskFieldIDs

◆ fOnDisk2MemClusterGroupIDs

◆ fOnDisk2MemClusterIDs

◆ fOnDisk2MemColumnIDs

◆ fOnDisk2MemFieldIDs