RVisualizationElement Class Reference

Browsing element representing visualization folder for RNTuple.

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 104 of file RNTupleBrowseProvider.cxx.

Public Member Functions
	RVisualizationElement (std::shared_ptr< ROOT::RNTupleReader > ntplReader, const std::string &fileName="")
	~RVisualizationElement () override=default
std::unique_ptr< RItem >	CreateItem () const override
	Create item with visualization folder icon.
std::unique_ptr< RLevelIter >	GetChildsIter () override
	Create iterator for visualization children.
const TClass *	GetClass () const
	Return class of RNTuple for consistency.
EActionKind	GetDefaultAction () const override
	Default action is none for folder.
std::string	GetName () const override
	Name of visualization folder.
std::unique_ptr< RHolder >	GetObject () override
	No direct object for folder.
std::string	GetTitle () const override
	Title of visualization folder.
bool	IsFolder () const override
	This is a folder.
void	SetFileName (const std::string &fileName)
	Set filename for child elements.
Public Member Functions inherited from ROOT::Browsable::RElement
virtual	~RElement ()=default
virtual bool	cd ()
	Select element as active.
virtual bool	CheckValid ()
	Check if element still contains valid content.
virtual std::string	GetContent (const std::string &="text")
	Returns element content, depends from kind.
virtual int	GetNumChilds ()
	Returns number of childs By default creates iterator and iterates over all items.
virtual bool	IsCapable (EActionKind action) const
	Check if want to perform action.
virtual bool	IsExpandByDefault () const
	Should item representing element be expand by default.
virtual bool	IsObject (void *)
	Check if element contains provided pointer.
virtual bool	MatchName (const std::string &name) const
	Checks if element name match to provided value.

Protected Attributes
std::string	fFileName
std::shared_ptr< ROOT::RNTupleReader >	fNtplReader

Additional Inherited Members
Public Types inherited from ROOT::Browsable::RElement
enum	EActionKind {   kActNone , kActBrowse , kActEdit , kActImage ,   kActDraw6 , kActDraw7 , kActCanvas , kActTree ,   kActGeom }
	Possible actions on double-click. More...
enum	EContentKind {   kNone , kText , kImage , kPng ,   kJpeg , kJson , kFileName }
Static Public Member Functions inherited from ROOT::Browsable::RElement
static int	ComparePaths (const RElementPath_t &path1, const RElementPath_t &path2)
	Compare two paths, Returns number of elements matches in both paths.
static int	ExtractItemIndex (std::string &name)
	Extract index from name Index coded by client with ###<indx>$$$ suffix Such coding used by browser to identify element by index.
static EContentKind	GetContentKind (const std::string &kind)
	Find item with specified name Default implementation, should work for all.
static std::string	GetPathAsString (const RElementPath_t &path)
	Converts element path back to string.
static std::shared_ptr< RElement >	GetSubElement (std::shared_ptr< RElement > &elem, const RElementPath_t &path)
	Returns sub element.
static bool	IsLastKeyCycle ()
	Is only last cycle from the list of keys is shown.
static RElementPath_t	ParsePath (const std::string &str)
	Parse string path to produce RElementPath_t One should avoid to use string pathes as much as possible.
static void	SetLastKeyCycle (bool on=true)
	Set flag to show only last cycle from the list of keys.

Inheritance diagram for RVisualizationElement:

Constructor & Destructor Documentation

RVisualizationElement()

RVisualizationElement::RVisualizationElement ( std::shared_ptr< ROOT::RNTupleReader > ntplReader, const std::string & fileName = "" )

inline

Definition at line 110 of file RNTupleBrowseProvider.cxx.

~RVisualizationElement()

RVisualizationElement::~RVisualizationElement ( )

overridedefault

Member Function Documentation

CreateItem()

std::unique_ptr< RItem > RVisualizationElement::CreateItem ( ) const

inlineoverridevirtual

Create item with visualization folder icon.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 136 of file RNTupleBrowseProvider.cxx.

GetChildsIter()

std::unique_ptr< RLevelIter > RVisualizationElement::GetChildsIter ( )

overridevirtual

Create iterator for visualization children.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 206 of file RNTupleBrowseProvider.cxx.

GetClass()

const TClass * RVisualizationElement::GetClass ( ) const

inline

Return class of RNTuple for consistency.

Definition at line 127 of file RNTupleBrowseProvider.cxx.

GetDefaultAction()

EActionKind RVisualizationElement::GetDefaultAction ( ) const

inlineoverridevirtual

Default action is none for folder.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 133 of file RNTupleBrowseProvider.cxx.

GetName()

std::string RVisualizationElement::GetName ( ) const

inlineoverridevirtual

Name of visualization folder.

Implements ROOT::Browsable::RElement.

Definition at line 118 of file RNTupleBrowseProvider.cxx.

GetObject()

std::unique_ptr< RHolder > RVisualizationElement::GetObject ( )

inlineoverridevirtual

No direct object for folder.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 130 of file RNTupleBrowseProvider.cxx.

GetTitle()

std::string RVisualizationElement::GetTitle ( ) const

inlineoverridevirtual

Title of visualization folder.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 121 of file RNTupleBrowseProvider.cxx.

IsFolder()

bool RVisualizationElement::IsFolder ( ) const

inlineoverridevirtual

This is a folder.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 144 of file RNTupleBrowseProvider.cxx.

SetFileName()

void RVisualizationElement::SetFileName ( const std::string & fileName )

inline

Set filename for child elements.

Definition at line 147 of file RNTupleBrowseProvider.cxx.

Member Data Documentation

fFileName

std::string RVisualizationElement::fFileName

protected

Definition at line 107 of file RNTupleBrowseProvider.cxx.

fNtplReader

std::shared_ptr<ROOT::RNTupleReader> RVisualizationElement::fNtplReader

protected

Definition at line 106 of file RNTupleBrowseProvider.cxx.