Processor specialization for processing a single RNTuple.

Definition at line 744 of file RNTupleProcessor.hxx.

Public Member Functions
	RNTupleSingleProcessor (const RNTupleSingleProcessor &)=delete

	RNTupleSingleProcessor (RNTupleSingleProcessor &&)=delete

	~RNTupleSingleProcessor () override

RIterator	begin ()

RIterator	end ()

ROOT::NTupleSize_t	GetNEntriesProcessed () const
	Get the total number of entries processed so far.

const RNTupleProcessorOptions &	GetOptions () const
	Get the options used for this processor.

void	LoadEntry (const REntryMapping &mapping)
	Load the entry identified by the entry mapping.

RNTupleSingleProcessor &	operator= (const RNTupleSingleProcessor &)=delete

RNTupleSingleProcessor &	operator= (RNTupleSingleProcessor &&)=delete

void	PrintStructure (std::ostream &output=std::cout)
	Print a graphical representation of the processor composition.

RNTupleProcessorValuePtr< void >	RequestField (const std::string &fieldName, const std::string &typeName, void *valuePtr=nullptr)
	Request access to a field for reading during processing.

template<typename T >
RNTupleProcessorValuePtr< T >	RequestField (const std::string &fieldName, void *valuePtr=nullptr)
	Request access to a field for reading during processing.

Static Public Member Functions
static std::unique_ptr< RNTupleProcessor >	Create (RNTupleInputSpec ntuple, const RNTupleProcessorOptions &opts=RNTupleProcessorOptions())
	Create an RNTupleProcessor for a single RNTuple.

static std::unique_ptr< RNTupleProcessor >	CreateChain (std::vector< RNTupleInputSpec > ntuples, const RNTupleProcessorOptions &opts=RNTupleProcessorOptions())
	Create an RNTupleProcessor for a chain (i.e., a vertical combination) of RNTuples.

static std::unique_ptr< RNTupleProcessor >	CreateChain (std::vector< std::unique_ptr< RNTupleProcessor > > innerProcessors, const RNTupleProcessorOptions &opts=RNTupleProcessorOptions())
	Create an RNTupleProcessor for a chain (i.e., a vertical combination) of other RNTupleProcessors.

Protected Member Functions
ROOT::Internal::RNTupleProcessorEntry &	GetEntry ()
	Get a reference to the processor's internal entry.

const ROOT::Internal::RNTupleProcessorEntry &	GetEntry () const
	Get a reference to the processor's internal entry.

void	IncrementEntryMapping (REntryMapping &mapping)
	Increment the local entry mapping by one.

bool	IsInitialized () const
	Check if the processor already has been initialized.

Protected Attributes
std::shared_ptr< ROOT::Internal::RNTupleProcessorEntry >	fEntry = nullptr

std::unordered_set< Internal::RNTupleProcessorEntry::FieldIndex_t >	fFieldIdxs

ROOT::NTupleSize_t	fNEntries = kInvalidNTupleIndex
	Total number of entries.

ROOT::NTupleSize_t	fNEntriesProcessed = 0

RNTupleProcessorOptions	fOptions

Private Member Functions
	RNTupleSingleProcessor (RNTupleInputSpec ntuple, const RNTupleProcessorOptions &opts)
	Construct a new RNTupleProcessor for processing a single RNTuple.

void	AddAllFieldsToEntry (const Internal::RNTupleProcessorProvenance &provenance, bool includeSubfields) final
	Add all known fields (from on-disk information) to the entry.

void	AddEntriesToJoinTable (Experimental::Internal::RNTupleJoinTable &joinTable, ROOT::NTupleSize_t entryOffset=0) final
	Add the entry mappings for this processor to the provided join table.

Internal::RNTupleProcessorEntry::FieldIndex_t	AddFieldToEntry (const std::string &fieldName, const std::string &typeName, void *valuePtr=nullptr, const Internal::RNTupleProcessorProvenance &provenance=Internal::RNTupleProcessorProvenance()) final
	Add a field to the entry.

Internal::RNTupleProcessorEntry::FieldIndex_t	AddFieldToEntry (std::unique_ptr< ROOT::RFieldBase > field, const std::string &fieldName, void *valuePtr, const Internal::RNTupleProcessorProvenance &provenance) final
	Add a field to the entry.

bool	CanReadFieldFromDisk (std::string_view fieldName) final
	Check if a field exists on-disk and can be read by the processor.

void	Connect (const std::unordered_set< Internal::RNTupleProcessorEntry::FieldIndex_t > &fieldIdxs, const Internal::RNTupleProcessorProvenance &provenance=Internal::RNTupleProcessorProvenance(), bool updateFields=false) final
	Connect the provided fields indices in the entry to their on-disk fields.

std::unique_ptr< ROOT::RFieldBase >	ConnectField (std::unique_ptr< ROOT::RFieldBase > field)
	Connect an existing field to the processor's page source.

std::unique_ptr< ROOT::RFieldBase >	CreateAndConnectField (const std::string &qualifiedFieldName, const std::string &typeName)
	Create a new field and connect it to the processor's page source.

void	Disconnect () final
	Disconnect the processor from associated physical storage.

ROOT::NTupleSize_t	GetNEntries () final
	Get the total number of entries in this processor.

void	Initialize (std::shared_ptr< ROOT::Internal::RNTupleProcessorEntry > entry=nullptr) final
	Initialize the processor by creating an (initially empty) `fEntry`, or setting an existing one.

void	LoadEntryImpl (const REntryMapping &mapping) final
	Load the entry identified by the entry mapping.

void	PrintStructureImpl (std::ostream &output) const final
	Processor-specific implementation for printing its structure, called by PrintStructure().

void	SetEntryMapping (ROOT::NTupleSize_t globalEntryNumber, REntryMapping &mapping) final
	Set the local entry mapping (for nested processors), according to a global entry number.

Private Attributes
RNTupleInputSpec	fNTupleSpec

std::unique_ptr< ROOT::Internal::RPageSource >	fPageSource

Friends
class	RNTupleProcessor

#include <ROOT/RNTupleProcessor.hxx>

Inheritance diagram for ROOT::RNTupleSingleProcessor:

[legend]

Constructor & Destructor Documentation

◆ RNTupleSingleProcessor() [1/3]

ROOT::RNTupleSingleProcessor::RNTupleSingleProcessor	(	RNTupleInputSpec	ntuple,
		const RNTupleProcessorOptions &	opts )

private

Construct a new RNTupleProcessor for processing a single RNTuple.

Parameters

[in]	ntuple	The source specification (name and storage location) for the RNTuple to process.
[in]	opts	Options for the processor.

Definition at line 107 of file RNTupleProcessor.cxx.

◆ RNTupleSingleProcessor() [2/3]

ROOT::RNTupleSingleProcessor::RNTupleSingleProcessor ( const RNTupleSingleProcessor & )

delete

◆ RNTupleSingleProcessor() [3/3]

ROOT::RNTupleSingleProcessor::RNTupleSingleProcessor ( RNTupleSingleProcessor && )

delete

◆ ~RNTupleSingleProcessor()

ROOT::RNTupleSingleProcessor::~RNTupleSingleProcessor ( )

inlineoverride

Definition at line 862 of file RNTupleProcessor.hxx.

Member Function Documentation

◆ AddAllFieldsToEntry()

void ROOT::RNTupleSingleProcessor::AddAllFieldsToEntry	(	const Internal::RNTupleProcessorProvenance &	provenance,
		bool	includeSubfields )

finalprivatevirtual

Add all known fields (from on-disk information) to the entry.

See also: RNTupleProcessor::AddAllFieldsToEntry()

Implements ROOT::RNTupleProcessor.

Definition at line 252 of file RNTupleProcessor.cxx.

◆ AddEntriesToJoinTable()

void ROOT::RNTupleSingleProcessor::AddEntriesToJoinTable	(	Experimental::Internal::RNTupleJoinTable &	joinTable,
		ROOT::NTupleSize_t	entryOffset = 0 )

finalprivatevirtual

Add the entry mappings for this processor to the provided join table.

See also: ROOT::RNTupleProcessor::AddEntriesToJoinTable

Implements ROOT::RNTupleProcessor.

Definition at line 374 of file RNTupleProcessor.cxx.

◆ AddFieldToEntry() [1/2]

ROOT::Internal::RNTupleProcessorEntry::FieldIndex_t ROOT::RNTupleSingleProcessor::AddFieldToEntry	(	const std::string &	fieldName,
		const std::string &	typeName,
		void *	valuePtr = nullptr,
		const Internal::RNTupleProcessorProvenance &	provenance = Internal::RNTupleProcessorProvenance() )

finalprivatevirtual

Add a field to the entry.

See also: RNTupleProcessor::AddFieldToEntry()

Implements ROOT::RNTupleProcessor.

Definition at line 200 of file RNTupleProcessor.cxx.

◆ AddFieldToEntry() [2/2]

ROOT::Internal::RNTupleProcessorEntry::FieldIndex_t ROOT::RNTupleSingleProcessor::AddFieldToEntry	(	std::unique_ptr< ROOT::RFieldBase >	field,
		const std::string &	fieldName,
		void *	valuePtr,
		const Internal::RNTupleProcessorProvenance &	provenance )

finalprivatevirtual

Add a field to the entry.

See also: RNTupleProcessor::AddFieldToEntry()

Implements ROOT::RNTupleProcessor.

Definition at line 226 of file RNTupleProcessor.cxx.

◆ begin()

RIterator ROOT::RNTupleProcessor::begin ( )

inlineinherited

Definition at line 702 of file RNTupleProcessor.hxx.

◆ CanReadFieldFromDisk()

bool ROOT::RNTupleSingleProcessor::CanReadFieldFromDisk ( std::string_view fieldName )

finalprivatevirtual

Check if a field exists on-disk and can be read by the processor.

See also: RNTupleProcessor::CanReadFieldFromDisk()

Implements ROOT::RNTupleProcessor.

Definition at line 144 of file RNTupleProcessor.cxx.

◆ Connect()

void ROOT::RNTupleSingleProcessor::Connect	(	const std::unordered_set< Internal::RNTupleProcessorEntry::FieldIndex_t > &	fieldIdxs,
		const Internal::RNTupleProcessorProvenance &	provenance = Internal::RNTupleProcessorProvenance(),
		bool	updateFields = false )

finalprivatevirtual

Connect the provided fields indices in the entry to their on-disk fields.

Implements ROOT::RNTupleProcessor.

Definition at line 321 of file RNTupleProcessor.cxx.

◆ ConnectField()

std::unique_ptr< ROOT::RFieldBase > ROOT::RNTupleSingleProcessor::ConnectField ( std::unique_ptr< ROOT::RFieldBase > field )

private

Connect an existing field to the processor's page source.

Parameters

[in] field Pointer to the field to add

Returns: The same field, but wrapped in a new unique pointer. This is needed, because in order to add the field to the page source it first needs to be attached to its zero field, in order to correctly handle field substitutions. Afterwards, we release the field again from the zero field.

Definition at line 190 of file RNTupleProcessor.cxx.

◆ Create()

std::unique_ptr< ROOT::RNTupleProcessor > ROOT::RNTupleProcessor::Create	(	RNTupleInputSpec	ntuple,
		const RNTupleProcessorOptions &	opts = RNTupleProcessorOptions() )

staticinherited

Create an RNTupleProcessor for a single RNTuple.

Parameters

[in]	ntuple	The name and storage location of the RNTuple to process.
[in]	opts	Options for the processor.

Returns: A pointer to the newly created RNTupleProcessor.

Definition at line 36 of file RNTupleProcessor.cxx.

◆ CreateAndConnectField()

std::unique_ptr< ROOT::RFieldBase > ROOT::RNTupleSingleProcessor::CreateAndConnectField	(	const std::string &	qualifiedFieldName,
		const std::string &	typeName )

private

Create a new field and connect it to the processor's page source.

Parameters

[in]	qualifiedFieldName	Name of the field to add, prefixed with its parent fields, if applicable.
[in]	typeName	Type of the field to add.

Returns: The newly created field.

Exceptions

ROOT::RException In case the requested field cannot be found on disk.

Definition at line 155 of file RNTupleProcessor.cxx.

◆ CreateChain() [1/2]

std::unique_ptr< ROOT::RNTupleProcessor > ROOT::RNTupleProcessor::CreateChain	(	std::vector< RNTupleInputSpec >	ntuples,
		const RNTupleProcessorOptions &	opts = RNTupleProcessorOptions() )

staticinherited

Create an RNTupleProcessor for a chain (i.e., a vertical combination) of RNTuples.

Parameters

[in]	ntuples	A list specifying the names and locations of the RNTuples to process.
[in]	opts	Options for the processor.

Returns: A pointer to the newly created RNTupleProcessor.

Definition at line 42 of file RNTupleProcessor.cxx.

◆ CreateChain() [2/2]

std::unique_ptr< ROOT::RNTupleProcessor > ROOT::RNTupleProcessor::CreateChain	(	std::vector< std::unique_ptr< RNTupleProcessor > >	innerProcessors,
		const RNTupleProcessorOptions &	opts = RNTupleProcessorOptions() )

staticinherited

Create an RNTupleProcessor for a chain (i.e., a vertical combination) of other RNTupleProcessors.

Parameters

[in]	innerProcessors	A list with the processors to chain.
[in]	opts	Options for the processor.

Returns: A pointer to the newly created RNTupleProcessor.

Definition at line 58 of file RNTupleProcessor.cxx.

◆ Disconnect()

void ROOT::RNTupleSingleProcessor::Disconnect ( )

finalprivatevirtual

Disconnect the processor from associated physical storage.

Implements ROOT::RNTupleProcessor.

Definition at line 366 of file RNTupleProcessor.cxx.

◆ end()

RIterator ROOT::RNTupleProcessor::end ( )

inlineinherited

Definition at line 703 of file RNTupleProcessor.hxx.

◆ GetEntry() [1/2]

ROOT::Internal::RNTupleProcessorEntry & ROOT::RNTupleProcessor::GetEntry ( )

inlineprotectedinherited

Get a reference to the processor's internal entry.

Definition at line 457 of file RNTupleProcessor.hxx.

◆ GetEntry() [2/2]

const ROOT::Internal::RNTupleProcessorEntry & ROOT::RNTupleProcessor::GetEntry ( ) const

inlineprotectedinherited

Get a reference to the processor's internal entry.

Definition at line 461 of file RNTupleProcessor.hxx.

◆ GetNEntries()

ROOT::NTupleSize_t ROOT::RNTupleSingleProcessor::GetNEntries ( )

inlinefinalprivatevirtual

Get the total number of entries in this processor.

Implements ROOT::RNTupleProcessor.

Definition at line 802 of file RNTupleProcessor.hxx.

◆ GetNEntriesProcessed()

ROOT::NTupleSize_t ROOT::RNTupleProcessor::GetNEntriesProcessed ( ) const

inlineinherited

Get the total number of entries processed so far.

Definition at line 553 of file RNTupleProcessor.hxx.

◆ GetOptions()

const RNTupleProcessorOptions & ROOT::RNTupleProcessor::GetOptions ( ) const

inlineinherited

Get the options used for this processor.

Definition at line 549 of file RNTupleProcessor.hxx.

◆ IncrementEntryMapping()

void ROOT::RNTupleProcessor::IncrementEntryMapping ( REntryMapping & mapping )

inlineprotectedinherited

Increment the local entry mapping by one.

Parameters

[in] mapping Entry mapping to increment

Definition at line 447 of file RNTupleProcessor.hxx.

◆ Initialize()

void ROOT::RNTupleSingleProcessor::Initialize ( std::shared_ptr< ROOT::Internal::RNTupleProcessorEntry > entry = nullptr )

finalprivatevirtual

Initialize the processor by creating an (initially empty) fEntry, or setting an existing one.

At this point, the page source for the underlying RNTuple of the processor will be created and opened.

Implements ROOT::RNTupleProcessor.

Definition at line 127 of file RNTupleProcessor.cxx.

◆ IsInitialized()

bool ROOT::RNTupleProcessor::IsInitialized ( ) const

inlineprotectedinherited

Check if the processor already has been initialized.

Definition at line 420 of file RNTupleProcessor.hxx.

◆ LoadEntry()

void ROOT::RNTupleProcessor::LoadEntry ( const REntryMapping & mapping )

inlineinherited

Load the entry identified by the entry mapping.

Parameters

[in] mapping Mapping to the entry to load

Definition at line 625 of file RNTupleProcessor.hxx.

◆ LoadEntryImpl()

void ROOT::RNTupleSingleProcessor::LoadEntryImpl ( const REntryMapping & mapping )

finalprivatevirtual

Load the entry identified by the entry mapping.

See also: ROOT::RNTupleProcessor::LoadEntryImpl

Implements ROOT::RNTupleProcessor.

Definition at line 290 of file RNTupleProcessor.cxx.

◆ operator=() [1/2]

RNTupleSingleProcessor & ROOT::RNTupleSingleProcessor::operator= ( const RNTupleSingleProcessor & )

delete

◆ operator=() [2/2]

RNTupleSingleProcessor & ROOT::RNTupleSingleProcessor::operator= ( RNTupleSingleProcessor && )

delete

◆ PrintStructure()

void ROOT::RNTupleProcessor::PrintStructure ( std::ostream & output = std::cout )

inlineinherited

Print a graphical representation of the processor composition.

Parameters

[in,out] output Stream to print to (default is stdout).

Example:

The structure of a processor representing a join between a single primary RNTuple and a chain of two auxiliary RNTuples will be printed as follows:

+-----------------------------+ +-----------------------------+
| ntuple                      | | ntuple_aux                  |
| ntuple.root                 | | ntuple_aux1.root            |
+-----------------------------+ +-----------------------------+
                                +-----------------------------+
                                | ntuple_aux                  |
                                | ntuple_aux2.root            |
                                +-----------------------------+

Definition at line 645 of file RNTupleProcessor.hxx.

◆ PrintStructureImpl()

void ROOT::RNTupleSingleProcessor::PrintStructureImpl ( std::ostream & output ) const

finalprivatevirtual

Processor-specific implementation for printing its structure, called by PrintStructure().

See also: ROOT::RNTupleProcessor::PrintStructureImpl

Implements ROOT::RNTupleProcessor.

Definition at line 381 of file RNTupleProcessor.cxx.

◆ RequestField() [1/2]

RNTupleProcessorValuePtr< void > ROOT::RNTupleProcessor::RequestField	(	const std::string &	fieldName,
		const std::string &	typeName,
		void *	valuePtr = nullptr )

inlineinherited

Request access to a field for reading during processing.

Parameters

[in]	fieldName	Name of the requested field.
[in]	typeName	Type of the requested field.
[in]	valuePtr	Pointer to bind to the field's value in the entry. If this is a `nullptr`, a pointer will be created.

Returns: An void-type RNTupleProcessorValuePtr, which provides access to the field's value.

Warning: Provide a valuePtr with care! Values may not always be valid for every entry during processing, for example when a field is not present in one of the chained processors or when during a join operation, no matching entry in the auxiliary processor can be found. Reading valuePtr as-is therefore comes with the risk of reading invalid data. After passing a pointer to RequestField, we strongly recommend only accessing its data through the interface of the returned RNTupleProcessorValuePtr, to ensure that only valid data can be read.

Definition at line 614 of file RNTupleProcessor.hxx.

◆ RequestField() [2/2]

template<typename T >

RNTupleProcessorValuePtr< T > ROOT::RNTupleProcessor::RequestField	(	const std::string &	fieldName,
		void *	valuePtr = nullptr )

inlineinherited

Request access to a field for reading during processing.

Template Parameters

T	Type of the requested field.

Parameters

[in]	fieldName	Name of the requested field.
[in]	valuePtr	Pointer to bind to the field's value in the entry. If this is a `nullptr`, a pointer will be created.

Returns: An RNTupleProcessorValuePtr of type T, which provides access to the field's value.

Warning: Provide a valuePtr with care! Values may not always be valid for every entry during processing, for example when a field is not present in one of the chained processors or when during a join operation, no matching entry in the auxiliary processor can be found. Reading valuePtr as-is therefore comes with the risk of reading invalid data. After passing a pointer to RequestField, we strongly recommend only accessing its data through the interface of the returned RNTupleProcessorValuePtr, to ensure that only valid data can be read.

Definition at line 572 of file RNTupleProcessor.hxx.

◆ SetEntryMapping()

void ROOT::RNTupleSingleProcessor::SetEntryMapping	(	ROOT::NTupleSize_t	globalEntryNumber,
		REntryMapping &	mapping )

finalprivatevirtual

Set the local entry mapping (for nested processors), according to a global entry number.

See also: ROOT::RNTupleProcessor::SetEntryMapping

Implements ROOT::RNTupleProcessor.

Definition at line 282 of file RNTupleProcessor.cxx.

Friends And Related Symbol Documentation

◆ RNTupleProcessor

friend class RNTupleProcessor

friend

Definition at line 745 of file RNTupleProcessor.hxx.

Member Data Documentation

◆ fEntry

std::shared_ptr<ROOT::Internal::RNTupleProcessorEntry> ROOT::RNTupleProcessor::fEntry = nullptr

protectedinherited

Definition at line 405 of file RNTupleProcessor.hxx.

◆ fFieldIdxs

std::unordered_set<Internal::RNTupleProcessorEntry::FieldIndex_t> ROOT::RNTupleProcessor::fFieldIdxs

protectedinherited

Definition at line 406 of file RNTupleProcessor.hxx.

◆ fNEntries

ROOT::NTupleSize_t ROOT::RNTupleProcessor::fNEntries = kInvalidNTupleIndex

protectedinherited

Total number of entries.

Only to be used internally by the processor, not meant to be exposed in the public interface.

Definition at line 410 of file RNTupleProcessor.hxx.

◆ fNEntriesProcessed

ROOT::NTupleSize_t ROOT::RNTupleProcessor::fNEntriesProcessed = 0

protectedinherited

Definition at line 412 of file RNTupleProcessor.hxx.

◆ fNTupleSpec

RNTupleInputSpec ROOT::RNTupleSingleProcessor::fNTupleSpec

private

Definition at line 748 of file RNTupleProcessor.hxx.

◆ fOptions

RNTupleProcessorOptions ROOT::RNTupleProcessor::fOptions

protectedinherited

Definition at line 403 of file RNTupleProcessor.hxx.

◆ fPageSource

std::unique_ptr<ROOT::Internal::RPageSource> ROOT::RNTupleSingleProcessor::fPageSource

private

Definition at line 749 of file RNTupleProcessor.hxx.

Libraries for ROOT::RNTupleSingleProcessor:

[legend]

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Constructor & Destructor Documentation

◆ RNTupleSingleProcessor() [1/3]

◆ RNTupleSingleProcessor() [2/3]

◆ RNTupleSingleProcessor() [3/3]

◆ ~RNTupleSingleProcessor()

Member Function Documentation

◆ AddAllFieldsToEntry()

◆ AddEntriesToJoinTable()

◆ AddFieldToEntry() [1/2]

◆ AddFieldToEntry() [2/2]

◆ begin()

◆ CanReadFieldFromDisk()

◆ Connect()

◆ ConnectField()

◆ Create()

◆ CreateAndConnectField()

◆ CreateChain() [1/2]

◆ CreateChain() [2/2]

◆ Disconnect()

◆ end()

◆ GetEntry() [1/2]

◆ GetEntry() [2/2]

◆ GetNEntries()

◆ GetNEntriesProcessed()

◆ GetOptions()

◆ IncrementEntryMapping()

◆ Initialize()

◆ IsInitialized()

◆ LoadEntry()

◆ LoadEntryImpl()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ PrintStructure()

Example:

◆ PrintStructureImpl()

◆ RequestField() [1/2]

◆ RequestField() [2/2]

◆ SetEntryMapping()

Friends And Related Symbol Documentation

◆ RNTupleProcessor

Member Data Documentation

◆ fEntry

◆ fFieldIdxs

◆ fNEntries

◆ fNEntriesProcessed

◆ fNTupleSpec

◆ fOptions

◆ fPageSource