Logo ROOT  
Reference Guide
ROOT::Detail::RDF::RDefineBase Class Referenceabstract

Definition at line 34 of file RDefineBase.hxx.

Public Member Functions

 RDefineBase (std::string_view name, std::string_view type, unsigned int nSlots, const RDFInternal::RBookedDefines &defines, const std::map< std::string, std::vector< void * >> &DSValuePtrs, ROOT::RDF::RDataSource *ds)
 
virtual ~RDefineBase ()
 
virtual void FinaliseSlot (unsigned int slot)=0
 Clean-up operations to be performed at the end of a task. More...
 
unsigned int GetID () const
 Return the unique identifier of this RDefineBase. More...
 
std::string GetName () const
 
virtual const std::type_info & GetTypeId () const =0
 
std::string GetTypeName () const
 
virtual voidGetValuePtr (unsigned int slot)=0
 Return the (type-erased) address of the Define'd value for the given processing slot. More...
 
virtual void InitSlot (TTreeReader *r, unsigned int slot)=0
 
RDefineBaseoperator= (const RDefineBase &)=delete
 
RDefineBaseoperator= (RDefineBase &&)=delete
 
virtual void Update (unsigned int slot, Long64_t entry)=0
 Update the value at the address returned by GetValuePtr with the content corresponding to the given entry. More...
 

Static Protected Member Functions

static unsigned int GetNextID ()
 

Protected Attributes

ROOT::RDF::RDataSourcefDataSource
 non-owning ptr to the RDataSource, if any. Used to retrieve column readers. More...
 
RDFInternal::RBookedDefines fDefines
 
const std::map< std::string, std::vector< void * > > & fDSValuePtrs
 
const unsigned int fID = GetNextID()
 A unique ID that identifies this custom column. More...
 
std::deque< boolfIsInitialized
 
std::vector< Long64_tfLastCheckedEntry
 
const std::string fName
 The name of the custom column. More...
 
unsigned int fNChildren {0}
 number of nodes of the functional graph hanging from this object More...
 
const unsigned int fNSlots
 number of thread slots used by this node, inherited from parent node. More...
 
unsigned int fNStopsReceived {0}
 number of times that a children node signaled to stop processing entries. More...
 
const std::string fType
 The type of the custom column as a text string. More...
 

#include <ROOT/RDF/RDefineBase.hxx>

Inheritance diagram for ROOT::Detail::RDF::RDefineBase:
[legend]

Constructor & Destructor Documentation

◆ RDefineBase()

RDefineBase::RDefineBase ( std::string_view  name,
std::string_view  type,
unsigned int  nSlots,
const RDFInternal::RBookedDefines defines,
const std::map< std::string, std::vector< void * >> &  DSValuePtrs,
ROOT::RDF::RDataSource ds 
)

Definition at line 28 of file RDefineBase.cxx.

◆ ~RDefineBase()

RDefineBase::~RDefineBase ( )
virtual

Definition at line 37 of file RDefineBase.cxx.

Member Function Documentation

◆ FinaliseSlot()

virtual void ROOT::Detail::RDF::RDefineBase::FinaliseSlot ( unsigned int  slot)
pure virtual

Clean-up operations to be performed at the end of a task.

Implemented in ROOT::Detail::RDF::RJittedDefine, and ROOT::Detail::RDF::RDefine< F, ExtraArgsTag >.

◆ GetID()

unsigned int ROOT::Detail::RDF::RDefineBase::GetID ( ) const
inline

Return the unique identifier of this RDefineBase.

Definition at line 71 of file RDefineBase.hxx.

◆ GetName()

std::string RDefineBase::GetName ( ) const

Definition at line 39 of file RDefineBase.cxx.

◆ GetNextID()

unsigned int RDefineBase::GetNextID ( )
staticprotected

Definition at line 22 of file RDefineBase.cxx.

◆ GetTypeId()

virtual const std::type_info& ROOT::Detail::RDF::RDefineBase::GetTypeId ( ) const
pure virtual

◆ GetTypeName()

std::string RDefineBase::GetTypeName ( ) const

Definition at line 44 of file RDefineBase.cxx.

◆ GetValuePtr()

virtual void* ROOT::Detail::RDF::RDefineBase::GetValuePtr ( unsigned int  slot)
pure virtual

Return the (type-erased) address of the Define'd value for the given processing slot.

Implemented in ROOT::Detail::RDF::RJittedDefine, and ROOT::Detail::RDF::RDefine< F, ExtraArgsTag >.

◆ InitSlot()

virtual void ROOT::Detail::RDF::RDefineBase::InitSlot ( TTreeReader r,
unsigned int  slot 
)
pure virtual

◆ operator=() [1/2]

RDefineBase& ROOT::Detail::RDF::RDefineBase::operator= ( const RDefineBase )
delete

◆ operator=() [2/2]

RDefineBase& ROOT::Detail::RDF::RDefineBase::operator= ( RDefineBase &&  )
delete

◆ Update()

virtual void ROOT::Detail::RDF::RDefineBase::Update ( unsigned int  slot,
Long64_t  entry 
)
pure virtual

Update the value at the address returned by GetValuePtr with the content corresponding to the given entry.

Implemented in ROOT::Detail::RDF::RJittedDefine, and ROOT::Detail::RDF::RDefine< F, ExtraArgsTag >.

Member Data Documentation

◆ fDataSource

ROOT::RDF::RDataSource* ROOT::Detail::RDF::RDefineBase::fDataSource
protected

non-owning ptr to the RDataSource, if any. Used to retrieve column readers.

Definition at line 48 of file RDefineBase.hxx.

◆ fDefines

RDFInternal::RBookedDefines ROOT::Detail::RDF::RDefineBase::fDefines
protected

Definition at line 45 of file RDefineBase.hxx.

◆ fDSValuePtrs

const std::map<std::string, std::vector<void *> >& ROOT::Detail::RDF::RDefineBase::fDSValuePtrs
protected

Definition at line 47 of file RDefineBase.hxx.

◆ fID

const unsigned int ROOT::Detail::RDF::RDefineBase::fID = GetNextID()
protected

A unique ID that identifies this custom column.

Used e.g. to distinguish custom columns with the same name in different branches of the computation graph.

Definition at line 44 of file RDefineBase.hxx.

◆ fIsInitialized

std::deque<bool> ROOT::Detail::RDF::RDefineBase::fIsInitialized
protected

Definition at line 46 of file RDefineBase.hxx.

◆ fLastCheckedEntry

std::vector<Long64_t> ROOT::Detail::RDF::RDefineBase::fLastCheckedEntry
protected

Definition at line 41 of file RDefineBase.hxx.

◆ fName

const std::string ROOT::Detail::RDF::RDefineBase::fName
protected

The name of the custom column.

Definition at line 36 of file RDefineBase.hxx.

◆ fNChildren

unsigned int ROOT::Detail::RDF::RDefineBase::fNChildren {0}
protected

number of nodes of the functional graph hanging from this object

Definition at line 38 of file RDefineBase.hxx.

◆ fNSlots

const unsigned int ROOT::Detail::RDF::RDefineBase::fNSlots
protected

number of thread slots used by this node, inherited from parent node.

Definition at line 40 of file RDefineBase.hxx.

◆ fNStopsReceived

unsigned int ROOT::Detail::RDF::RDefineBase::fNStopsReceived {0}
protected

number of times that a children node signaled to stop processing entries.

Definition at line 39 of file RDefineBase.hxx.

◆ fType

const std::string ROOT::Detail::RDF::RDefineBase::fType
protected

The type of the custom column as a text string.

Definition at line 37 of file RDefineBase.hxx.

Libraries for ROOT::Detail::RDF::RDefineBase:
[legend]

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