RTreeMapElement Class Reference

Browsing element representing TreeMap visualization 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 39 of file RNTupleBrowseProvider.cxx.

Public Member Functions
	RTreeMapElement (std::shared_ptr< ROOT::RNTupleReader > ntplReader, const std::string &fileName="")
	~RTreeMapElement () override=default
std::unique_ptr< RItem >	CreateItem () const override
	Create item with TreeMap icon.
std::unique_ptr< RLevelIter >	GetChildsIter () override
	No children for TreeMap visualization.
const TClass *	GetClass () const
	Return class of RNTuple for consistency.
EActionKind	GetDefaultAction () const override
	Default action is to draw the treemap.
std::string	GetName () const override
	Name of TreeMap visualization.
std::unique_ptr< RHolder >	GetObject () override
	Return holder with visualization data.
std::string	GetTitle () const override
	Title of TreeMap visualization.
bool	IsCapable (EActionKind kind) const override
	Check if visualization is capable of being drawn.
bool	IsFolder () const override
	Not expandable by default.
void	SetFileName (const std::string &fileName)
	Set filename for treemap creation.
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	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 RTreeMapElement:

Constructor & Destructor Documentation

RTreeMapElement()

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

inline

Definition at line 45 of file RNTupleBrowseProvider.cxx.

~RTreeMapElement()

RTreeMapElement::~RTreeMapElement ( )

overridedefault

Member Function Documentation

CreateItem()

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

inlineoverridevirtual

Create item with TreeMap icon.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 80 of file RNTupleBrowseProvider.cxx.

GetChildsIter()

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

inlineoverridevirtual

No children for TreeMap visualization.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 59 of file RNTupleBrowseProvider.cxx.

GetClass()

const TClass * RTreeMapElement::GetClass ( ) const

inline

Return class of RNTuple for consistency.

Definition at line 62 of file RNTupleBrowseProvider.cxx.

GetDefaultAction()

EActionKind RTreeMapElement::GetDefaultAction ( ) const

inlineoverridevirtual

Default action is to draw the treemap.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 71 of file RNTupleBrowseProvider.cxx.

GetName()

std::string RTreeMapElement::GetName ( ) const

inlineoverridevirtual

Name of TreeMap visualization.

Implements ROOT::Browsable::RElement.

Definition at line 53 of file RNTupleBrowseProvider.cxx.

GetObject()

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

inlineoverridevirtual

Return holder with visualization data.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 65 of file RNTupleBrowseProvider.cxx.

GetTitle()

std::string RTreeMapElement::GetTitle ( ) const

inlineoverridevirtual

Title of TreeMap visualization.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 56 of file RNTupleBrowseProvider.cxx.

IsCapable()

bool RTreeMapElement::IsCapable ( EActionKind kind ) const

inlineoverridevirtual

Check if visualization is capable of being drawn.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 74 of file RNTupleBrowseProvider.cxx.

IsFolder()

bool RTreeMapElement::IsFolder ( ) const

inlineoverridevirtual

Not expandable by default.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 88 of file RNTupleBrowseProvider.cxx.

SetFileName()

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

inline

Set filename for treemap creation.

Definition at line 91 of file RNTupleBrowseProvider.cxx.

Member Data Documentation

fFileName

std::string RTreeMapElement::fFileName

protected

Definition at line 42 of file RNTupleBrowseProvider.cxx.

fNtplReader

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

protected

Definition at line 41 of file RNTupleBrowseProvider.cxx.