Processor specialization for vertically combined (chained) RNTupleProcessors.

Definition at line 905 of file RNTupleProcessor.hxx.

Public Member Functions
	RNTupleChainProcessor (const RNTupleChainProcessor &)=delete

	RNTupleChainProcessor (RNTupleChainProcessor &&)=delete

	~RNTupleChainProcessor () override=default

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.

RNTupleChainProcessor &	operator= (const RNTupleChainProcessor &)=delete

RNTupleChainProcessor &	operator= (RNTupleChainProcessor &&)=delete

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

RNTupleProcessorOptionalPtr< 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 >
RNTupleProcessorOptionalPtr< 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 (RNTupleOpenSpec ntuple, const RNTupleProcessorOptions &opts=RNTupleProcessorOptions())
	Create an RNTupleProcessor for a single RNTuple.

static std::unique_ptr< RNTupleProcessor >	CreateChain (std::vector< RNTupleOpenSpec > 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
Internal::RNTupleProcessorEntry &	GetEntry ()
	Get a reference to the processor's internal entry.

const 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< 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
	RNTupleChainProcessor (std::vector< std::unique_ptr< RNTupleProcessor > > processors, const RNTupleProcessorOptions &opts)
	Construct a new RNTupleChainProcessor.

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

void	AddEntriesToJoinTable (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.

void	ConnectInnerProcessor (std::size_t processorNumber)
	Update the entry to reflect any missing fields in the current inner processor.

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< 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
std::size_t	fCurrentProcessorNumber = 0

std::vector< ROOT::NTupleSize_t >	fInnerNEntries

std::vector< std::unique_ptr< RNTupleProcessor > >	fInnerProcessors

ROOT::NTupleSize_t	fLastLoadedEntry = 0

Internal::RNTupleProcessorProvenance	fProvenance

Friends
class	RNTupleProcessor

#include <ROOT/RNTupleProcessor.hxx>

Inheritance diagram for ROOT::Experimental::RNTupleChainProcessor:

[legend]

Constructor & Destructor Documentation

◆ RNTupleChainProcessor() [1/3]

ROOT::Experimental::RNTupleChainProcessor::RNTupleChainProcessor	(	std::vector< std::unique_ptr< RNTupleProcessor > >	processors,
		const RNTupleProcessorOptions &	opts )

private

Construct a new RNTupleChainProcessor.

Parameters

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

RNTuples are processed in the order in which they are specified.

Definition at line 365 of file RNTupleProcessor.cxx.

◆ RNTupleChainProcessor() [2/3]

ROOT::Experimental::RNTupleChainProcessor::RNTupleChainProcessor ( const RNTupleChainProcessor & )

delete

◆ RNTupleChainProcessor() [3/3]

ROOT::Experimental::RNTupleChainProcessor::RNTupleChainProcessor ( RNTupleChainProcessor && )

delete

◆ ~RNTupleChainProcessor()

ROOT::Experimental::RNTupleChainProcessor::~RNTupleChainProcessor ( )

overridedefault

Member Function Documentation

◆ AddAllFieldsToEntry()

void ROOT::Experimental::RNTupleChainProcessor::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::Experimental::RNTupleProcessor.

Definition at line 454 of file RNTupleProcessor.cxx.

◆ AddEntriesToJoinTable()

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

finalprivatevirtual

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

See also: ROOT::Experimental::RNTupleProcessor::AddEntriesToJoinTable

Implements ROOT::Experimental::RNTupleProcessor.

Definition at line 525 of file RNTupleProcessor.cxx.

◆ AddFieldToEntry() [1/2]

ROOT::Experimental::Internal::RNTupleProcessorEntry::FieldIndex_t ROOT::Experimental::RNTupleChainProcessor::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::Experimental::RNTupleProcessor.

Definition at line 439 of file RNTupleProcessor.cxx.

◆ AddFieldToEntry() [2/2]

ROOT::Experimental::Internal::RNTupleProcessorEntry::FieldIndex_t ROOT::Experimental::RNTupleChainProcessor::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::Experimental::RNTupleProcessor.

Definition at line 447 of file RNTupleProcessor.cxx.

◆ begin()

RIterator ROOT::Experimental::RNTupleProcessor::begin ( )

inlineinherited

Definition at line 731 of file RNTupleProcessor.hxx.

◆ CanReadFieldFromDisk()

bool ROOT::Experimental::RNTupleChainProcessor::CanReadFieldFromDisk ( std::string_view fieldName )

inlinefinalprivatevirtual

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

See also: RNTupleProcessor::CanReadFieldFromDisk()

Implements ROOT::Experimental::RNTupleProcessor.

Definition at line 959 of file RNTupleProcessor.hxx.

◆ Connect()

void ROOT::Experimental::RNTupleChainProcessor::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.

See also: RNTupleProcessor::Connect()

Implements ROOT::Experimental::RNTupleProcessor.

Definition at line 409 of file RNTupleProcessor.cxx.

◆ ConnectInnerProcessor()

void ROOT::Experimental::RNTupleChainProcessor::ConnectInnerProcessor ( std::size_t processorNumber )

private

Update the entry to reflect any missing fields in the current inner processor.

Definition at line 426 of file RNTupleProcessor.cxx.

◆ Create()

std::unique_ptr< ROOT::Experimental::RNTupleProcessor > ROOT::Experimental::RNTupleProcessor::Create	(	RNTupleOpenSpec	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 46 of file RNTupleProcessor.cxx.

◆ CreateChain() [1/2]

std::unique_ptr< ROOT::Experimental::RNTupleProcessor > ROOT::Experimental::RNTupleProcessor::CreateChain	(	std::vector< RNTupleOpenSpec >	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 52 of file RNTupleProcessor.cxx.

◆ CreateChain() [2/2]

std::unique_ptr< ROOT::Experimental::RNTupleProcessor > ROOT::Experimental::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 69 of file RNTupleProcessor.cxx.

◆ Disconnect()

void ROOT::Experimental::RNTupleChainProcessor::Disconnect ( )

finalprivatevirtual

Disconnect the processor from associated physical storage.

Implements ROOT::Experimental::RNTupleProcessor.

Definition at line 419 of file RNTupleProcessor.cxx.

◆ end()

RIterator ROOT::Experimental::RNTupleProcessor::end ( )

inlineinherited

Definition at line 732 of file RNTupleProcessor.hxx.

◆ GetEntry() [1/2]

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

inlineprotectedinherited

Get a reference to the processor's internal entry.

Definition at line 487 of file RNTupleProcessor.hxx.

◆ GetEntry() [2/2]

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

inlineprotectedinherited

Get a reference to the processor's internal entry.

Definition at line 491 of file RNTupleProcessor.hxx.

◆ GetNEntries()

ROOT::NTupleSize_t ROOT::Experimental::RNTupleChainProcessor::GetNEntries ( )

finalprivatevirtual

Get the total number of entries in this processor.

Note: This requires opening all underlying RNTuples being processed in the chain, and could become costly!

Implements ROOT::Experimental::RNTupleProcessor.

Definition at line 391 of file RNTupleProcessor.cxx.

◆ GetNEntriesProcessed()

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

inlineinherited

Get the total number of entries processed so far.

Definition at line 582 of file RNTupleProcessor.hxx.

◆ GetOptions()

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

inlineinherited

Get the options used for this processor.

Definition at line 578 of file RNTupleProcessor.hxx.

◆ IncrementEntryMapping()

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

inlineprotectedinherited

Increment the local entry mapping by one.

Parameters

[in] mapping Entry mapping to increment

Definition at line 477 of file RNTupleProcessor.hxx.

◆ Initialize()

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

finalprivatevirtual

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

Implements ROOT::Experimental::RNTupleProcessor.

Definition at line 377 of file RNTupleProcessor.cxx.

◆ IsInitialized()

bool ROOT::Experimental::RNTupleProcessor::IsInitialized ( ) const

inlineprotectedinherited

Check if the processor already has been initialized.

Definition at line 450 of file RNTupleProcessor.hxx.

◆ LoadEntry()

void ROOT::Experimental::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 654 of file RNTupleProcessor.hxx.

◆ LoadEntryImpl()

void ROOT::Experimental::RNTupleChainProcessor::LoadEntryImpl ( const REntryMapping & mapping )

finalprivatevirtual

Load the entry identified by the entry mapping.

See also: ROOT::Experimental::RNTupleProcessor::LoadEntryImpl

Implements ROOT::Experimental::RNTupleProcessor.

Definition at line 514 of file RNTupleProcessor.cxx.

◆ operator=() [1/2]

RNTupleChainProcessor & ROOT::Experimental::RNTupleChainProcessor::operator= ( const RNTupleChainProcessor & )

delete

◆ operator=() [2/2]

RNTupleChainProcessor & ROOT::Experimental::RNTupleChainProcessor::operator= ( RNTupleChainProcessor && )

delete

◆ PrintStructure()

void ROOT::Experimental::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 674 of file RNTupleProcessor.hxx.

◆ PrintStructureImpl()

void ROOT::Experimental::RNTupleChainProcessor::PrintStructureImpl ( std::ostream & output ) const

finalprivatevirtual

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

See also: ROOT::Experimental::RNTupleProcessor::PrintStructureImpl

Implements ROOT::Experimental::RNTupleProcessor.

Definition at line 537 of file RNTupleProcessor.cxx.

◆ RequestField() [1/2]

RNTupleProcessorOptionalPtr< void > ROOT::Experimental::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 RNTupleProcessorOptionalPtr, 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 RNTupleProcessorOptionalPtr, to ensure that only valid data can be read.

Definition at line 643 of file RNTupleProcessor.hxx.

◆ RequestField() [2/2]

template<typename T >

RNTupleProcessorOptionalPtr< T > ROOT::Experimental::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 RNTupleProcessorOptionalPtr 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 RNTupleProcessorOptionalPtr, to ensure that only valid data can be read.

Definition at line 601 of file RNTupleProcessor.hxx.

◆ SetEntryMapping()

void ROOT::Experimental::RNTupleChainProcessor::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::Experimental::RNTupleProcessor::SetEntryMapping

Implements ROOT::Experimental::RNTupleProcessor.

Definition at line 461 of file RNTupleProcessor.cxx.

Friends And Related Symbol Documentation

◆ RNTupleProcessor

friend class RNTupleProcessor

friend

Definition at line 906 of file RNTupleProcessor.hxx.

Member Data Documentation

◆ fCurrentProcessorNumber

std::size_t ROOT::Experimental::RNTupleChainProcessor::fCurrentProcessorNumber = 0

private

Definition at line 913 of file RNTupleProcessor.hxx.

◆ fEntry

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

protectedinherited

Definition at line 435 of file RNTupleProcessor.hxx.

◆ fFieldIdxs

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

protectedinherited

Definition at line 436 of file RNTupleProcessor.hxx.

◆ fInnerNEntries

std::vector<ROOT::NTupleSize_t> ROOT::Experimental::RNTupleChainProcessor::fInnerNEntries

private

Definition at line 910 of file RNTupleProcessor.hxx.

◆ fInnerProcessors

std::vector<std::unique_ptr<RNTupleProcessor> > ROOT::Experimental::RNTupleChainProcessor::fInnerProcessors

private

Definition at line 909 of file RNTupleProcessor.hxx.

◆ fLastLoadedEntry

ROOT::NTupleSize_t ROOT::Experimental::RNTupleChainProcessor::fLastLoadedEntry = 0

private

Definition at line 912 of file RNTupleProcessor.hxx.

◆ fNEntries

ROOT::NTupleSize_t ROOT::Experimental::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 440 of file RNTupleProcessor.hxx.

◆ fNEntriesProcessed

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

protectedinherited

Definition at line 442 of file RNTupleProcessor.hxx.

◆ fOptions

RNTupleProcessorOptions ROOT::Experimental::RNTupleProcessor::fOptions

protectedinherited

Definition at line 433 of file RNTupleProcessor.hxx.

◆ fProvenance

Internal::RNTupleProcessorProvenance ROOT::Experimental::RNTupleChainProcessor::fProvenance

private

Definition at line 915 of file RNTupleProcessor.hxx.

Libraries for ROOT::Experimental::RNTupleChainProcessor:

[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

◆ RNTupleChainProcessor() [1/3]

◆ RNTupleChainProcessor() [2/3]

◆ RNTupleChainProcessor() [3/3]

◆ ~RNTupleChainProcessor()

Member Function Documentation

◆ AddAllFieldsToEntry()

◆ AddEntriesToJoinTable()

◆ AddFieldToEntry() [1/2]

◆ AddFieldToEntry() [2/2]

◆ begin()

◆ CanReadFieldFromDisk()

◆ Connect()

◆ ConnectInnerProcessor()

◆ Create()

◆ 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

◆ fCurrentProcessorNumber

◆ fEntry

◆ fFieldIdxs

◆ fInnerNEntries

◆ fInnerProcessors

◆ fLastLoadedEntry

◆ fNEntries

◆ fNEntriesProcessed

◆ fOptions

◆ fProvenance