Logo ROOT  

Reference Guide
Loading...
Searching...
No Matches
RVisualizationHolder Class Reference
Graphics » GUI » Web Display » Web Widgets » Browsable object

Holder for RNTuple visualization data.

Author
Patryk Pilichowski
Date
2025
Warning
This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is welcome!

Definition at line 24 of file RVisualizationHolder.hxx.

Public Member Functions

 RVisualizationHolder (std::shared_ptr< ROOT::RNTupleReader > ntplReader, const std::string &fileName, const std::string &tupleName)
template<class T>
bool CanCastTo () const
auto Copy () const
 Clone container.
virtual void Forget ()
 Clear all pointers without performing cleanup.
template<class T>
const T * Get () const
 Returns direct object pointer cast to provided class.
template<class T>
T * get_object ()
 Returns plains pointer on object without ownership, only can be used for TObjects.
template<class T>
std::shared_ptr< T > get_shared ()
 Returns shared_ptr of contained object.
template<class T>
std::unique_ptr< T > get_unique ()
 Returns unique_ptr of contained object.
const TClass * GetClass () const override
 Returns class of contained object.
const std::string & GetFileName () const
std::shared_ptr< ROOT::RNTupleReader > GetNTupleReader () const
const void * GetObject () const override
 Returns direct (temporary) object pointer.
const std::string & GetTupleName () const
template<class T>
bool InheritsFrom () const

Protected Member Functions

virtual void * AccessObject ()
 Returns plain object pointer without care about ownership, should not be used often.
virtual RHolder * DoCopy () const
 Create copy of container, works only when pointer can be shared.
virtual void * GetShared () const
 Returns pointer on existing shared_ptr<T>.
virtual void * TakeObject ()
 Returns pointer with ownership, normally via unique_ptr<T>::release() or tobj->Clone().

Protected Attributes

std::string fFileName
std::shared_ptr< ROOT::RNTupleReader > fNtplReader
std::string fTupleName

#include </home/stephan/code/root-2/gui/browsable/src/RVisualizationHolder.hxx>

Inheritance diagram for RVisualizationHolder:
ROOT::Browsable::RHolder

Constructor & Destructor Documentation

◆ RVisualizationHolder()

RVisualizationHolder::RVisualizationHolder ( std::shared_ptr< ROOT::RNTupleReader > ntplReader,
const std::string & fileName,
const std::string & tupleName )
inline

Definition at line 31 of file RVisualizationHolder.hxx.

Member Function Documentation

◆ AccessObject()

virtual void * ROOT::Browsable::RHolder::AccessObject ( )
inlineprotectedvirtualinherited

Returns plain object pointer without care about ownership, should not be used often.

Reimplemented in ROOT::Browsable::RAnyObjectHolder, and ROOT::Browsable::TObjectHolder.

Definition at line 43 of file RHolder.hxx.

◆ CanCastTo()

template<class T>
bool ROOT::Browsable::RHolder::CanCastTo ( ) const
inlineinherited

Definition at line 67 of file RHolder.hxx.

◆ Copy()

auto ROOT::Browsable::RHolder::Copy ( ) const
inlineinherited

Clone container.

Trivial for shared_ptr and TObject holder, does not work for unique_ptr

Definition at line 85 of file RHolder.hxx.

◆ DoCopy()

virtual RHolder * ROOT::Browsable::RHolder::DoCopy ( ) const
inlineprotectedvirtualinherited

Create copy of container, works only when pointer can be shared.

Reimplemented in ROOT::Browsable::RAnyObjectHolder, ROOT::Browsable::RShared< T >, and ROOT::Browsable::TObjectHolder.

Definition at line 46 of file RHolder.hxx.

◆ Forget()

virtual void ROOT::Browsable::RHolder::Forget ( )
inlinevirtualinherited

Clear all pointers without performing cleanup.

Reimplemented in ROOT::Browsable::RAnyObjectHolder, and ROOT::Browsable::TObjectHolder.

Definition at line 58 of file RHolder.hxx.

◆ Get()

template<class T>
const T * ROOT::Browsable::RHolder::Get ( ) const
inlineinherited

Returns direct object pointer cast to provided class.

Definition at line 75 of file RHolder.hxx.

◆ get_object()

template<class T>
T * ROOT::Browsable::RHolder::get_object ( )
inlineinherited

Returns plains pointer on object without ownership, only can be used for TObjects.

Definition at line 121 of file RHolder.hxx.

◆ get_shared()

template<class T>
std::shared_ptr< T > ROOT::Browsable::RHolder::get_shared ( )
inlineinherited

Returns shared_ptr of contained object.

Definition at line 106 of file RHolder.hxx.

◆ get_unique()

template<class T>
std::unique_ptr< T > ROOT::Browsable::RHolder::get_unique ( )
inlineinherited

Returns unique_ptr of contained object.

Definition at line 89 of file RHolder.hxx.

◆ GetClass()

const TClass * RVisualizationHolder::GetClass ( ) const
inlineoverridevirtual

Returns class of contained object.

Implements ROOT::Browsable::RHolder.

Definition at line 37 of file RVisualizationHolder.hxx.

◆ GetFileName()

const std::string & RVisualizationHolder::GetFileName ( ) const
inline

Definition at line 43 of file RVisualizationHolder.hxx.

◆ GetNTupleReader()

std::shared_ptr< ROOT::RNTupleReader > RVisualizationHolder::GetNTupleReader ( ) const
inline

Definition at line 42 of file RVisualizationHolder.hxx.

◆ GetObject()

const void * RVisualizationHolder::GetObject ( ) const
inlineoverridevirtual

Returns direct (temporary) object pointer.

Implements ROOT::Browsable::RHolder.

Definition at line 40 of file RVisualizationHolder.hxx.

◆ GetShared()

virtual void * ROOT::Browsable::RHolder::GetShared ( ) const
inlineprotectedvirtualinherited

Returns pointer on existing shared_ptr<T>.

Reimplemented in ROOT::Browsable::RShared< T >.

Definition at line 37 of file RHolder.hxx.

◆ GetTupleName()

const std::string & RVisualizationHolder::GetTupleName ( ) const
inline

Definition at line 44 of file RVisualizationHolder.hxx.

◆ InheritsFrom()

template<class T>
bool ROOT::Browsable::RHolder::InheritsFrom ( ) const
inlineinherited

Definition at line 61 of file RHolder.hxx.

◆ TakeObject()

virtual void * ROOT::Browsable::RHolder::TakeObject ( )
inlineprotectedvirtualinherited

Returns pointer with ownership, normally via unique_ptr<T>::release() or tobj->Clone().

Reimplemented in ROOT::Browsable::RAnyObjectHolder, ROOT::Browsable::RUnique< T >, and ROOT::Browsable::TObjectHolder.

Definition at line 40 of file RHolder.hxx.

Member Data Documentation

◆ fFileName

std::string RVisualizationHolder::fFileName
protected

Definition at line 27 of file RVisualizationHolder.hxx.

◆ fNtplReader

std::shared_ptr<ROOT::RNTupleReader> RVisualizationHolder::fNtplReader
protected

Definition at line 26 of file RVisualizationHolder.hxx.

◆ fTupleName

std::string RVisualizationHolder::fTupleName
protected

Definition at line 28 of file RVisualizationHolder.hxx.

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