RFieldElement Class Reference

Browsing element representing of RField.

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

Public Member Functions
	RFieldElement (std::shared_ptr< ROOT::RNTupleReader > ntplReader, const std::string &parent_name, const ROOT::DescriptorId_t id)
	~RFieldElement () override=default
std::unique_ptr< RLevelIter >	GetChildsIter () override
	Create iterator for childs elements if any.
const TClass *	GetClass () const
	Return class of field - for a moment using RNTuple class as dummy.
EActionKind	GetDefaultAction () const override
	Get default action.
std::string	GetName () const override
	Name of RField.
std::unique_ptr< RHolder >	GetObject () override
	Access object.
std::string	GetTitle () const override
	Title of RField.
bool	IsCapable (EActionKind kind) const override
	Check if want to perform action.
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::unique_ptr< RItem >	CreateItem () const
	Returns item with element description.
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	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
ROOT::DescriptorId_t	fFieldId
std::shared_ptr< ROOT::RNTupleReader >	fNtplReader
std::string	fParentName

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 RFieldElement:

Constructor & Destructor Documentation

RFieldElement()

RFieldElement::RFieldElement ( std::shared_ptr< ROOT::RNTupleReader > ntplReader, const std::string & parent_name, const ROOT::DescriptorId_t id )

inline

Definition at line 45 of file RNTupleBrowseProvider.cxx.

~RFieldElement()

RFieldElement::~RFieldElement ( )

overridedefault

Member Function Documentation

GetChildsIter()

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

overridevirtual

Create iterator for childs elements if any.

Returns child iterator (if any)

Reimplemented from ROOT::Browsable::RElement.

Definition at line 211 of file RNTupleBrowseProvider.cxx.

GetClass()

const TClass * RFieldElement::GetClass ( ) const

inline

Return class of field - for a moment using RNTuple class as dummy.

Definition at line 69 of file RNTupleBrowseProvider.cxx.

GetDefaultAction()

EActionKind RFieldElement::GetDefaultAction ( ) const

inlineoverridevirtual

Get default action.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 76 of file RNTupleBrowseProvider.cxx.

GetName()

std::string RFieldElement::GetName ( ) const

inlineoverridevirtual

Name of RField.

Implements ROOT::Browsable::RElement.

Definition at line 54 of file RNTupleBrowseProvider.cxx.

GetObject()

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

inlineoverridevirtual

Access object.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 71 of file RNTupleBrowseProvider.cxx.

GetTitle()

std::string RFieldElement::GetTitle ( ) const

inlineoverridevirtual

Title of RField.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 60 of file RNTupleBrowseProvider.cxx.

IsCapable()

bool RFieldElement::IsCapable ( EActionKind action ) const

inlineoverridevirtual

Check if want to perform action.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 83 of file RNTupleBrowseProvider.cxx.

Member Data Documentation

fFieldId

ROOT::DescriptorId_t RFieldElement::fFieldId

protected

Definition at line 42 of file RNTupleBrowseProvider.cxx.

fNtplReader

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

protected

Definition at line 38 of file RNTupleBrowseProvider.cxx.

fParentName

std::string RFieldElement::fParentName

protected

Definition at line 40 of file RNTupleBrowseProvider.cxx.