RNTupleElement Class Reference

Browsing element representing of RNTuple.

Author

Sergey Linev S.Lin.nosp@m.ev@g.nosp@m.si.de

Date

2021-03-08

Warning

This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is welcome!

Definition at line 103 of file RNTupleBrowseProvider.cxx.

Public Member Functions
	RNTupleElement (const std::string &ntplName, const std::string &filename)
virtual	~RNTupleElement ()=default
std::unique_ptr< RItem >	CreateItem () const override
	Returns item with element description.
std::unique_ptr< RLevelIter >	GetChildsIter () override
	Create iterator for childs elements if any.
const TClass *	GetClass () const
std::string	GetName () const override
	Name of NTuple.
std::string	GetTitle () const override
	Title of NTuple.
bool	IsNull () const
	Returns true if no ntuple found.
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 EActionKind	GetDefaultAction () const
	Get default action.
virtual int	GetNumChilds ()
	Returns number of childs By default creates iterator and iterates over all items.
virtual std::unique_ptr< RHolder >	GetObject ()
	Access object.
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	IsFolder () const
	Check if element can have childs.
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::shared_ptr< ROOT::Experimental::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 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.

Inheritance diagram for RNTupleElement:

Constructor & Destructor Documentation

RNTupleElement()

RNTupleElement::RNTupleElement ( const std::string &  ntplName, const std::string &  filename  )

inline

Definition at line 108 of file RNTupleBrowseProvider.cxx.

~RNTupleElement()

virtual RNTupleElement::~RNTupleElement ( )

virtualdefault

Member Function Documentation

CreateItem()

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

inlineoverridevirtual

Returns item with element description.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 129 of file RNTupleBrowseProvider.cxx.

GetChildsIter()

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

overridevirtual

Create iterator for childs elements if any.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 230 of file RNTupleBrowseProvider.cxx.

GetClass()

const TClass * RNTupleElement::GetClass ( ) const

inline

Definition at line 127 of file RNTupleBrowseProvider.cxx.

GetName()

std::string RNTupleElement::GetName ( ) const

inlineoverridevirtual

Name of NTuple.

Implements ROOT::Browsable::RElement.

Definition at line 119 of file RNTupleBrowseProvider.cxx.

GetTitle()

std::string RNTupleElement::GetTitle ( ) const

inlineoverridevirtual

Title of NTuple.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 122 of file RNTupleBrowseProvider.cxx.

IsNull()

bool RNTupleElement::IsNull ( ) const

inline

Returns true if no ntuple found.

Definition at line 116 of file RNTupleBrowseProvider.cxx.

Member Data Documentation

fNtplReader

std::shared_ptr<ROOT::Experimental::RNTupleReader> RNTupleElement::fNtplReader

protected

Definition at line 105 of file RNTupleBrowseProvider.cxx.