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 111 of file RNTupleSerialize.hxx.

Public Member Functions
std::uint64_t	GetHeaderSize () const
std::uint64_t	GetHeaderXxHash3 () const
ROOT::DescriptorId_t	GetMemClusterGroupId (ROOT::DescriptorId_t onDiskId) const
ROOT::DescriptorId_t	GetMemClusterId (ROOT::DescriptorId_t onDiskId) const
ROOT::DescriptorId_t	GetMemColumnId (ROOT::DescriptorId_t onDiskId) const
ROOT::DescriptorId_t	GetMemFieldId (ROOT::DescriptorId_t onDiskId) const
ROOT::DescriptorId_t	GetOnDiskClusterGroupId (ROOT::DescriptorId_t memId) const
ROOT::DescriptorId_t	GetOnDiskClusterId (ROOT::DescriptorId_t memId) const
ROOT::DescriptorId_t	GetOnDiskColumnId (ROOT::DescriptorId_t memId) const
ROOT::DescriptorId_t	GetOnDiskFieldId (ROOT::DescriptorId_t memId) const
const std::vector< ROOT::DescriptorId_t > &	GetOnDiskFieldList () const
	Return a vector containing the in-memory field ID for each on-disk counterpart, in order, i.e.
ROOT::DescriptorId_t	MapClusterGroupId (ROOT::DescriptorId_t memId)
ROOT::DescriptorId_t	MapClusterId (ROOT::DescriptorId_t memId)
ROOT::DescriptorId_t	MapFieldId (ROOT::DescriptorId_t memId)
	Map an in-memory field ID to its on-disk counterpart.
ROOT::DescriptorId_t	MapPhysicalColumnId (ROOT::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::uint64_t	fHeaderSize = 0
std::uint64_t	fHeaderXxHash3 = 0
std::map< ROOT::DescriptorId_t, ROOT::DescriptorId_t >	fMem2OnDiskClusterGroupIDs
std::map< ROOT::DescriptorId_t, ROOT::DescriptorId_t >	fMem2OnDiskClusterIDs
std::map< ROOT::DescriptorId_t, ROOT::DescriptorId_t >	fMem2OnDiskColumnIDs
std::map< ROOT::DescriptorId_t, ROOT::DescriptorId_t >	fMem2OnDiskFieldIDs
std::vector< ROOT::DescriptorId_t >	fOnDisk2MemClusterGroupIDs
std::vector< ROOT::DescriptorId_t >	fOnDisk2MemClusterIDs
std::vector< ROOT::DescriptorId_t >	fOnDisk2MemColumnIDs
std::vector< ROOT::DescriptorId_t >	fOnDisk2MemFieldIDs

#include <ROOT/RNTupleSerialize.hxx>

Member Function Documentation

◆ GetHeaderSize()

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

inline

Definition at line 126 of file RNTupleSerialize.hxx.

◆ GetHeaderXxHash3()

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

inline

Definition at line 128 of file RNTupleSerialize.hxx.

◆ GetMemClusterGroupId()

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

inline

Definition at line 193 of file RNTupleSerialize.hxx.

◆ GetMemClusterId()

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

inline

Definition at line 189 of file RNTupleSerialize.hxx.

◆ GetMemColumnId()

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

inline

Definition at line 185 of file RNTupleSerialize.hxx.

◆ GetMemFieldId()

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

inline

Definition at line 184 of file RNTupleSerialize.hxx.

◆ GetOnDiskClusterGroupId()

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

inline

Definition at line 180 of file RNTupleSerialize.hxx.

◆ GetOnDiskClusterId()

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

inline

Definition at line 176 of file RNTupleSerialize.hxx.

◆ GetOnDiskColumnId()

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

inline

Definition at line 172 of file RNTupleSerialize.hxx.

◆ GetOnDiskFieldId()

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

inline

Definition at line 171 of file RNTupleSerialize.hxx.

◆ GetOnDiskFieldList()

const std::vector< ROOT::DescriptorId_t > & ROOT::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 200 of file RNTupleSerialize.hxx.

◆ MapClusterGroupId()

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

inline

Definition at line 159 of file RNTupleSerialize.hxx.

◆ MapClusterId()

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

inline

Definition at line 152 of file RNTupleSerialize.hxx.

◆ MapFieldId()

ROOT::DescriptorId_t ROOT::Internal::RNTupleSerializer::RContext::MapFieldId ( ROOT::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 131 of file RNTupleSerialize.hxx.

◆ MapPhysicalColumnId()

ROOT::DescriptorId_t ROOT::Internal::RNTupleSerializer::RContext::MapPhysicalColumnId ( ROOT::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 144 of file RNTupleSerialize.hxx.

◆ MapSchema()

void ROOT::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 1304 of file RNTupleSerialize.cxx.

◆ SetHeaderSize()

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

inline

Definition at line 125 of file RNTupleSerialize.hxx.

◆ SetHeaderXxHash3()

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

inline

Definition at line 127 of file RNTupleSerialize.hxx.

Member Data Documentation

◆ fHeaderSize

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

private

Definition at line 113 of file RNTupleSerialize.hxx.

◆ fHeaderXxHash3

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

private

Definition at line 114 of file RNTupleSerialize.hxx.

◆ fMem2OnDiskClusterGroupIDs

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

private

Definition at line 118 of file RNTupleSerialize.hxx.

◆ fMem2OnDiskClusterIDs

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

private

Definition at line 117 of file RNTupleSerialize.hxx.

◆ fMem2OnDiskColumnIDs

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

private

Definition at line 116 of file RNTupleSerialize.hxx.

◆ fMem2OnDiskFieldIDs

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

private

Definition at line 115 of file RNTupleSerialize.hxx.

◆ fOnDisk2MemClusterGroupIDs

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

private

Definition at line 122 of file RNTupleSerialize.hxx.

◆ fOnDisk2MemClusterIDs

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

private

Definition at line 121 of file RNTupleSerialize.hxx.

◆ fOnDisk2MemColumnIDs

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

private

Definition at line 120 of file RNTupleSerialize.hxx.

◆ fOnDisk2MemFieldIDs

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

private

Definition at line 119 of file RNTupleSerialize.hxx.

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

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

Public Member Functions

Private Attributes

Member Function Documentation

◆ GetHeaderSize()

◆ GetHeaderXxHash3()

◆ GetMemClusterGroupId()

◆ GetMemClusterId()

◆ GetMemColumnId()

◆ GetMemFieldId()

◆ GetOnDiskClusterGroupId()

◆ GetOnDiskClusterId()

◆ GetOnDiskColumnId()

◆ GetOnDiskFieldId()

◆ GetOnDiskFieldList()

◆ MapClusterGroupId()

◆ MapClusterId()

◆ MapFieldId()

◆ MapPhysicalColumnId()

◆ MapSchema()

◆ SetHeaderSize()

◆ SetHeaderXxHash3()

Member Data Documentation

◆ fHeaderSize

◆ fHeaderXxHash3

◆ fMem2OnDiskClusterGroupIDs

◆ fMem2OnDiskClusterIDs

◆ fMem2OnDiskColumnIDs

◆ fMem2OnDiskFieldIDs

◆ fOnDisk2MemClusterGroupIDs

◆ fOnDisk2MemClusterIDs

◆ fOnDisk2MemColumnIDs

◆ fOnDisk2MemFieldIDs