Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TMethodBrowsable Class Reference

This helper object allows the browsing of methods of objects stored in branches.

They will be depicted by a leaf (or a branch, in case the method returns an object) with a red exclamation mark. Only a subset of all methods will be shown in the browser (see IsMethodBrowsable for the criteria a method has to satisfy).

Obviously, methods are only available if the library is loaded which contains the dictionary for the class to be browsed!

If a branch contains a collection, TMethodBrowsable tries to find out what the contained element is (it will only create methods for the contained elements, but never for the collection). If it fails to extract the type of the contained elements, or if there is no guarantee that the type has any other common denominator than TObject (e.g. in the case of a TObjArray, which can hold any object deriving from TObject) no methods will be added.

Definition at line 103 of file TBranchBrowsable.h.

Public Member Functions

 ~TMethodBrowsable () override
 
const char * GetIconName () const override
 return our special icons
 
TClassIsA () const override
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TVirtualBranchBrowsable
 ~TVirtualBranchBrowsable () override
 Destructor. Delete our leaves.
 
void Browse (TBrowser *b) override
 Calls TTree::Draw on the method if return type is not a class; otherwise expands returned object's "folder".
 
const TBranchGetBranch () const
 return the parent branch (might be many levels up)
 
TClassGetClassType () const
 return the type of this browsable object
 
const char * GetIconName () const override
 return icon shown when browsing a TVirtualBranchBrowsable
 
TListGetLeaves () const
 Return list of leaves. If not set up yet we'll create them.
 
const TVirtualBranchBrowsableGetParent () const
 return the parent TVirtualBranchBrowsable
 
void GetScope (TString &scope) const
 Returns the full name for TTree::Draw to draw *this.
 
TClassIsA () const override
 
bool IsFolder () const override
 check whether we have sub-elements
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
bool TypeIsPointer () const
 return whether the type of this browsable object is a pointer
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor.
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor.
 
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
 
void Copy (TObject &named) const override
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
const char * GetName () const override
 Returns name of object.
 
const char * GetTitle () const override
 Returns title of object.
 
ULong_t Hash () const override
 Return hash value for this object.
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
void Print (Option_t *option="") const override
 Print TNamed name and title.
 
virtual void SetName (const char *name)
 Set the name of the TNamed.
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *vp)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Int_t GetBrowsables (TList &list, const TBranch *branch, const TVirtualBranchBrowsable *parent=nullptr)
 This methods fills list with TMethodBrowsables for the branch's or parent's class and its base classes, and returns the number of added elements.
 
static bool IsMethodBrowsable (const TMethod *m)
 A TMethod is browsable if it is const, public and not pure virtual, if does not have any parameter without default value, and if it has a (non-void) return value.
 
static void Register ()
 Wrapper for the registration method.
 
static void Unregister ()
 Wrapper for the registration method.
 
- Static Public Member Functions inherited from TVirtualBranchBrowsable
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Int_t FillListOfBrowsables (TList &list, const TBranch *branch, const TVirtualBranchBrowsable *parent=nullptr)
 Askes all registered generators to fill their browsables into the list.
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 

Protected Member Functions

 TMethodBrowsable (const TBranch *branch, TMethod *m, const TVirtualBranchBrowsable *parent=nullptr)
 Constructor.
 
- Protected Member Functions inherited from TVirtualBranchBrowsable
 TVirtualBranchBrowsable (const TBranch *b, TClass *type, bool typeIsPointer, const TVirtualBranchBrowsable *parent=nullptr)
 Constructor setting all members according to parameters.
 
void SetType (TClass *type)
 sets the type of this browsable object
 
void SetTypeIsPointer (bool set=true)
 sets whether the type of this browsable object is a pointer
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
 
void MakeZombie ()
 

Static Protected Member Functions

static void GetBrowsableMethodsForClass (TClass *cl, TList &list)
 Given a class, this methods fills list with TMethodBrowsables for the class and its base classes, and returns the number of added elements.
 
- Static Protected Member Functions inherited from TVirtualBranchBrowsable
static TClassGetCollectionContainedType (const TBranch *b, const TVirtualBranchBrowsable *parent, TClass *&contained)
 Check whether the branch (or the parent) contains a collection.
 
static std::list< MethodCreateListOfBrowsables_t > & GetRegisteredGenerators ()
 returns the list of registered generator methods
 
static void RegisterGenerator (MethodCreateListOfBrowsables_t generator)
 Adds a generator to be called when browsing branches.
 
static void UnregisterGenerator (MethodCreateListOfBrowsables_t generator)
 Removes a generator from the list of generators to be called when browsing branches.
 

Private Attributes

TMethodfMethod {nullptr}
 

Additional Inherited Members

- Public Types inherited from TVirtualBranchBrowsable
typedef Int_t(* MethodCreateListOfBrowsables_t) (TList &, const TBranch *branch, const TVirtualBranchBrowsable *parent)
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <TBranchBrowsable.h>

Inheritance diagram for TMethodBrowsable:
[legend]

Constructor & Destructor Documentation

◆ ~TMethodBrowsable()

TMethodBrowsable::~TMethodBrowsable ( )
inlineoverride

Definition at line 105 of file TBranchBrowsable.h.

◆ TMethodBrowsable()

TMethodBrowsable::TMethodBrowsable ( const TBranch branch,
TMethod m,
const TVirtualBranchBrowsable parent = nullptr 
)
protected

Constructor.

Links a TBranchElement to a TMethod, allowing the TBrowser to browse simple methods.

The c'tor sets the name for a method "Class::Method(params) const" to "Method(params)", title to TMethod::GetPrototype

Definition at line 409 of file TBranchBrowsable.cxx.

Member Function Documentation

◆ Class()

static TClass * TMethodBrowsable::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TMethodBrowsable::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TMethodBrowsable::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 128 of file TBranchBrowsable.h.

◆ DeclFileName()

static const char * TMethodBrowsable::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 128 of file TBranchBrowsable.h.

◆ GetBrowsableMethodsForClass()

void TMethodBrowsable::GetBrowsableMethodsForClass ( TClass cl,
TList li 
)
staticprotected

Given a class, this methods fills list with TMethodBrowsables for the class and its base classes, and returns the number of added elements.

If called from a TBranch::Browse overload, "branch" should be set to the calling TBranch, otherwise "parent" should be set to the TVirtualBranchBrowsable being browsed, and branch should be the branch of the parent.

Definition at line 444 of file TBranchBrowsable.cxx.

◆ GetBrowsables()

Int_t TMethodBrowsable::GetBrowsables ( TList li,
const TBranch branch,
const TVirtualBranchBrowsable parent = nullptr 
)
static

This methods fills list with TMethodBrowsables for the branch's or parent's class and its base classes, and returns the number of added elements.

If called from a TBranch::Browse overload, "branch" should be set to the calling TBranch, otherwise "parent" should be set to the TVirtualBranchBrowsable being browsed.

Definition at line 501 of file TBranchBrowsable.cxx.

◆ GetIconName()

const char * TMethodBrowsable::GetIconName ( ) const
inlineoverridevirtual

return our special icons

Reimplemented from TObject.

Definition at line 111 of file TBranchBrowsable.h.

◆ IsA()

TClass * TMethodBrowsable::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 128 of file TBranchBrowsable.h.

◆ IsMethodBrowsable()

bool TMethodBrowsable::IsMethodBrowsable ( const TMethod m)
static

A TMethod is browsable if it is const, public and not pure virtual, if does not have any parameter without default value, and if it has a (non-void) return value.

A method called *, Get*, or get* will not be browsable if there is a persistent data member called f*, _*, or m*, as data member access is faster than method access. Examples: if one of fX, _X, or mX is a persistent data member, the methods GetX(), getX(), and X() will not be browsable.

Definition at line 530 of file TBranchBrowsable.cxx.

◆ Register()

void TMethodBrowsable::Register ( )
static

Wrapper for the registration method.

Needed against MSVC, which assigned different addr to the same method, depending on what translation unit you're in...

Definition at line 585 of file TBranchBrowsable.cxx.

◆ Streamer()

void TMethodBrowsable::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TMethodBrowsable::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 128 of file TBranchBrowsable.h.

◆ Unregister()

void TMethodBrowsable::Unregister ( )
static

Wrapper for the registration method.

Needed against MSVC, which assigned different addr to the same method, depending on what translation unit you're in...

Definition at line 595 of file TBranchBrowsable.cxx.

Member Data Documentation

◆ fMethod

TMethod* TMethodBrowsable::fMethod {nullptr}
private

Definition at line 127 of file TBranchBrowsable.h.

Libraries for TMethodBrowsable:

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