Logo ROOT  
Reference Guide
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 37 of file RNTupleBrowseProvider.cxx.

Public Member Functions

 RFieldElement (std::shared_ptr< ROOT::Experimental::Detail::RPageSource > ntplSource, const std::string &parent_name, const ROOT::Experimental::DescriptorId_t id)
 
virtual ~RFieldElement ()=default
 
std::unique_ptr< RLevelIterGetChildsIter () override
 Create iterator for childs elements if any. More...
 
const TClassGetClass () const
 Return class of field - for a moment using RNTuple class as dummy. More...
 
EActionKind GetDefaultAction () const override
 Get default action. More...
 
std::string GetName () const override
 Name of RField. More...
 
std::unique_ptr< RHolderGetObject () override
 Access object. More...
 
std::string GetTitle () const override
 Title of RField. More...
 
bool IsCapable (EActionKind kind) const override
 Check if want to perform action. More...
 
- Public Member Functions inherited from ROOT::Experimental::Browsable::RElement
virtual ~RElement ()=default
 
virtual bool cd ()
 Select element as active. More...
 
virtual bool CheckValid ()
 Check if element still contains valid content. More...
 
virtual std::unique_ptr< RItemCreateItem () const
 Returns item with element description. More...
 
virtual std::unique_ptr< RLevelIterGetChildsIter ()
 Create iterator for childs elements if any. More...
 
virtual std::string GetContent (const std::string &="text")
 Returns element content, depends from kind. More...
 
virtual EActionKind GetDefaultAction () const
 Get default action. More...
 
virtual std::string GetName () const =0
 Name of browsable, must be provided in derived classes. More...
 
virtual int GetNumChilds ()
 Returns number of childs By default creates iterator and iterates over all items. More...
 
virtual std::unique_ptr< RHolderGetObject ()
 Access object. More...
 
virtual std::string GetTitle () const
 Title of browsable (optional) More...
 
virtual bool IsCapable (EActionKind action) const
 Check if want to perform action. More...
 
virtual bool IsExpandByDefault () const
 Should item representing element be expand by default. More...
 
virtual bool IsFolder () const
 Check if element can have childs. More...
 
virtual bool IsObject (void *)
 Check if element contains provided pointer. More...
 
virtual bool MatchName (const std::string &name) const
 Checks if element name match to provided value. More...
 

Protected Attributes

ROOT::Experimental::DescriptorId_t fFieldId
 
std::shared_ptr< ROOT::Experimental::Detail::RPageSourcefNtplSource
 
std::string fParentName
 

Additional Inherited Members

- Public Types inherited from ROOT::Experimental::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::Experimental::Browsable::RElement
static int ComparePaths (const RElementPath_t &path1, const RElementPath_t &path2)
 Compare two paths, Returns number of elements matches in both paths. More...
 
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. More...
 
static EContentKind GetContentKind (const std::string &kind)
 Find item with specified name Default implementation, should work for all. More...
 
static std::string GetPathAsString (const RElementPath_t &path)
 Converts element path back to string. More...
 
static std::shared_ptr< RElementGetSubElement (std::shared_ptr< RElement > &elem, const RElementPath_t &path)
 Returns sub element. More...
 
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. More...
 
Inheritance diagram for RFieldElement:
[legend]

Constructor & Destructor Documentation

◆ RFieldElement()

RFieldElement::RFieldElement ( std::shared_ptr< ROOT::Experimental::Detail::RPageSource ntplSource,
const std::string &  parent_name,
const ROOT::Experimental::DescriptorId_t  id 
)
inline

Definition at line 47 of file RNTupleBrowseProvider.cxx.

◆ ~RFieldElement()

virtual RFieldElement::~RFieldElement ( )
virtualdefault

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::Experimental::Browsable::RElement.

Definition at line 226 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 71 of file RNTupleBrowseProvider.cxx.

◆ GetDefaultAction()

EActionKind RFieldElement::GetDefaultAction ( ) const
inlineoverridevirtual

Get default action.

Reimplemented from ROOT::Experimental::Browsable::RElement.

Definition at line 78 of file RNTupleBrowseProvider.cxx.

◆ GetName()

std::string RFieldElement::GetName ( ) const
inlineoverridevirtual

Name of RField.

Implements ROOT::Experimental::Browsable::RElement.

Definition at line 55 of file RNTupleBrowseProvider.cxx.

◆ GetObject()

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

Access object.

Reimplemented from ROOT::Experimental::Browsable::RElement.

Definition at line 73 of file RNTupleBrowseProvider.cxx.

◆ GetTitle()

std::string RFieldElement::GetTitle ( ) const
inlineoverridevirtual

Title of RField.

Reimplemented from ROOT::Experimental::Browsable::RElement.

Definition at line 61 of file RNTupleBrowseProvider.cxx.

◆ IsCapable()

bool RFieldElement::IsCapable ( EActionKind  action) const
inlineoverridevirtual

Check if want to perform action.

Reimplemented from ROOT::Experimental::Browsable::RElement.

Definition at line 86 of file RNTupleBrowseProvider.cxx.

Member Data Documentation

◆ fFieldId

ROOT::Experimental::DescriptorId_t RFieldElement::fFieldId
protected

Definition at line 43 of file RNTupleBrowseProvider.cxx.

◆ fNtplSource

std::shared_ptr<ROOT::Experimental::Detail::RPageSource> RFieldElement::fNtplSource
protected

Definition at line 39 of file RNTupleBrowseProvider.cxx.

◆ fParentName

std::string RFieldElement::fParentName
protected

Definition at line 41 of file RNTupleBrowseProvider.cxx.


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