Logo ROOT  
Reference Guide
TMethod Class Reference

Each ROOT class (see TClass) has a linked list of methods.

This class describes one single method (member function). The method info is obtained via the CINT api. See class TCling.

The method information is used a.o. by the THml class and by the TTree class.

Definition at line 38 of file TMethod.h.

Public Member Functions

 TMethod (const TMethod &org)
 Copy ctor. More...
 
 TMethod (MethodInfo_t *info=0, TClass *cl=0)
 Default TMethod ctor. More...
 
virtual ~TMethod ()
 Cleanup. More...
 
virtual TObjectClone (const char *newname="") const
 Clone method. More...
 
virtual TDataMemberFindDataMember ()
 Tries to guess DataMember from comment string and Method's name <==(only if 1 Argument!). More...
 
TClassGetClass () const
 
virtual const char * GetCommentString ()
 Returns a comment string from the class declaration. More...
 
virtual TListGetListOfMethodArgs ()
 Returns methodarg list and additionally updates fDataMember in TMethod by calling FindDataMember();. More...
 
virtual const char * Getter () const
 
virtual TMethodCallGetterMethod ()
 Return call environment for the getter method in case this is a *TOGGLE method (for the context menu). More...
 
EMenuItemKind IsMenuItem () const
 
virtual Bool_t IsValid ()
 Return true if this function object is pointing to a currently loaded function. More...
 
TMethodoperator= (const TMethod &rhs)
 Assignment operator. More...
 
virtual void SetMenuItem (EMenuItemKind menuItem)
 
virtual TMethodCallSetterMethod ()
 Return call environment for this method in case this is a *TOGGLE method which takes a single boolean or integer argument. More...
 
virtual Bool_t Update (MethodInfo_t *info)
 Update the TMethod to reflect the new info. More...
 
- Public Member Functions inherited from TFunction
 TFunction (const TFunction &orig)
 Copy operator. More...
 
 TFunction (MethodInfo_t *info=0)
 Default TFunction ctor. More...
 
virtual ~TFunction ()
 TFunction dtor deletes adopted CINT MethodInfo. More...
 
virtual TObjectClone (const char *newname="") const
 Clone method. More...
 
Long_t ExtraProperty () const
 Get property description word. For meaning of bits see EProperty. More...
 
DeclId_t GetDeclId () const
 
TListGetListOfMethodArgs ()
 Return list containing the TMethodArgs of a TFunction. More...
 
virtual const char * GetMangledName () const
 Returns the mangled name as defined by CINT, or 0 in case of error. More...
 
Int_t GetNargs () const
 Number of function arguments. More...
 
Int_t GetNargsOpt () const
 Number of function optional (default) arguments. More...
 
virtual const char * GetPrototype () const
 Returns the prototype of a function as defined by CINT, or 0 in case of error. More...
 
const char * GetReturnTypeName () const
 Get full type description of function return type, e,g.: "class TDirectory*". More...
 
std::string GetReturnTypeNormalizedName () const
 Get the normalized name of the return type. More...
 
const char * GetSignature ()
 Return signature of function. More...
 
voidInterfaceMethod () const
 Return pointer to the interface method. More...
 
virtual Bool_t IsValid ()
 Return true if this function object is pointing to a currently loaded function. More...
 
virtual void ls (Option_t *option="") const
 List TFunction name and title. More...
 
TFunctionoperator= (const TFunction &rhs)
 Assignment operator. More...
 
virtual void Print (Option_t *option="") const
 Print TFunction name and title. More...
 
Long_t Property () const
 Get property description word. For meaning of bits see EProperty. More...
 
virtual bool Update (MethodInfo_t *info)
 Update the TFunction to reflect the new info. More...
 
- Public Member Functions inherited from TDictionary
 TDictionary ()
 
 TDictionary (const char *name)
 
 TDictionary (const TDictionary &dict)
 
virtual ~TDictionary ()
 
void CreateAttributeMap ()
 
TDictAttributeMapGetAttributeMap () const
 
TDictionaryoperator= (const TDictionary &other)
 
virtual Long_t Property () const =0
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Private Member Functions

void CreateSignature ()
 Using the CINT method arg information create a complete signature string. More...
 
void SetMenuItem (const char *docstring)
 Set the menu item as prescribed in the doctstring. More...
 

Private Attributes

TClassfClass
 
TString fGetter
 
TMethodCallfGetterMethod
 
EMenuItemKind fMenuItem
 
TMethodCallfSetterMethod
 

Additional Inherited Members

- Public Types inherited from TDictionary
typedef const voidDeclId_t
 
enum class  EMemberSelection { kNoUsingDecls , kOnlyUsingDecls , kAlsoUsingDecls }
 Kinds of members to include in lists. More...
 
enum  ESTLType {
  kNone = ROOT::kNotSTL , kVector = ROOT::kSTLvector , kList = ROOT::kSTLlist , kForwardlist = ROOT::kSTLforwardlist ,
  kDeque = ROOT::kSTLdeque , kMap = ROOT::kSTLmap , kMultimap = ROOT::kSTLmultimap , kSet = ROOT::kSTLset ,
  kMultiset = ROOT::kSTLmultiset , kUnorderedSet = ROOT::kSTLunorderedset , kUnorderedMultiset = ROOT::kSTLunorderedmultiset , kUnorderedMap = ROOT::kSTLunorderedmap ,
  kUnorderedMultimap = ROOT::kSTLunorderedmultimap , kBitset = ROOT::kSTLbitset
}
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) ,
  kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from TDictionary
static TDictionaryGetDictionary (const char *name)
 
static TDictionaryGetDictionary (const std::type_info &typeinfo)
 
static bool WantsRegularMembers (EMemberSelection sel)
 
static bool WantsUsingDecls (EMemberSelection sel)
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = BIT(3) }
 
virtual void CreateSignature ()
 Using the CINT method arg information to create a complete signature string. More...
 
- Protected Member Functions inherited from TDictionary
Bool_t UpdateInterpreterStateMarker ()
 the Cling ID of the transaction that last updated the object More...
 
- 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). More...
 
void MakeZombie ()
 
- Protected Attributes inherited from TFunction
MethodInfo_t * fInfo
 
TString fMangledName
 
TListfMethodArgs
 
TString fSignature
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <TMethod.h>

Inheritance diagram for TMethod:
[legend]

Constructor & Destructor Documentation

◆ TMethod() [1/2]

TMethod::TMethod ( MethodInfo_t *  info = 0,
TClass cl = 0 
)

Default TMethod ctor.

TMethods are constructed in TClass. Comment strings are pre-parsed to find out whether the method is a context-menu item.

Definition at line 39 of file TMethod.cxx.

◆ TMethod() [2/2]

TMethod::TMethod ( const TMethod org)

Copy ctor.

Definition at line 54 of file TMethod.cxx.

◆ ~TMethod()

TMethod::~TMethod ( )
virtual

Cleanup.

Definition at line 86 of file TMethod.cxx.

Member Function Documentation

◆ Clone()

TObject * TMethod::Clone ( const char *  newname = "") const
virtual

Clone method.

Reimplemented from TFunction.

Definition at line 95 of file TMethod.cxx.

◆ CreateSignature()

void TMethod::CreateSignature ( )
privatevirtual

Using the CINT method arg information create a complete signature string.

Reimplemented from TFunction.

Definition at line 114 of file TMethod.cxx.

◆ FindDataMember()

TDataMember * TMethod::FindDataMember ( )
virtual

Tries to guess DataMember from comment string and Method's name <==(only if 1 Argument!).

If more then one argument=> returns pointer to the last argument. It also sets MethodArgs' pointers to point to specified data members.

The form of comment string defining arguments is: void XXX(Int_t x1, Float_t y2) //*ARGS={x1=>fX1,y2=>fY2} where fX1, fY2 are data fields in the same class. ("pointers" to data members)

Definition at line 132 of file TMethod.cxx.

◆ GetClass()

TClass * TMethod::GetClass ( ) const
inline

Definition at line 55 of file TMethod.h.

◆ GetCommentString()

const char * TMethod::GetCommentString ( )
virtual

Returns a comment string from the class declaration.

Definition at line 105 of file TMethod.cxx.

◆ GetListOfMethodArgs()

TList * TMethod::GetListOfMethodArgs ( )
virtual

Returns methodarg list and additionally updates fDataMember in TMethod by calling FindDataMember();.

Definition at line 306 of file TMethod.cxx.

◆ Getter()

virtual const char * TMethod::Getter ( ) const
inlinevirtual

Definition at line 59 of file TMethod.h.

◆ GetterMethod()

TMethodCall * TMethod::GetterMethod ( )
virtual

Return call environment for the getter method in case this is a *TOGGLE method (for the context menu).

Definition at line 263 of file TMethod.cxx.

◆ IsMenuItem()

EMenuItemKind TMethod::IsMenuItem ( ) const
inline

Definition at line 56 of file TMethod.h.

◆ IsValid()

Bool_t TMethod::IsValid ( )
virtual

Return true if this function object is pointing to a currently loaded function.

If a function is unloaded after the TMethod is created, the TMethod will be set to be invalid.

Reimplemented from TFunction.

Definition at line 276 of file TMethod.cxx.

◆ operator=()

TMethod & TMethod::operator= ( const TMethod rhs)

Assignment operator.

Definition at line 66 of file TMethod.cxx.

◆ SetMenuItem() [1/2]

void TMethod::SetMenuItem ( const char *  docstring)
private

Set the menu item as prescribed in the doctstring.

Definition at line 318 of file TMethod.cxx.

◆ SetMenuItem() [2/2]

virtual void TMethod::SetMenuItem ( EMenuItemKind  menuItem)
inlinevirtual

Definition at line 64 of file TMethod.h.

◆ SetterMethod()

TMethodCall * TMethod::SetterMethod ( )
virtual

Return call environment for this method in case this is a *TOGGLE method which takes a single boolean or integer argument.

Definition at line 294 of file TMethod.cxx.

◆ Update()

Bool_t TMethod::Update ( MethodInfo_t *  info)
virtual

Update the TMethod to reflect the new info.

This can be used to implement unloading (info == 0) and then reloading (info being the 'new' decl address).

Reimplemented from TFunction.

Definition at line 343 of file TMethod.cxx.

Member Data Documentation

◆ fClass

TClass* TMethod::fClass
private

Definition at line 41 of file TMethod.h.

◆ fGetter

TString TMethod::fGetter
private

Definition at line 43 of file TMethod.h.

◆ fGetterMethod

TMethodCall* TMethod::fGetterMethod
private

Definition at line 44 of file TMethod.h.

◆ fMenuItem

EMenuItemKind TMethod::fMenuItem
private

Definition at line 42 of file TMethod.h.

◆ fSetterMethod

TMethodCall* TMethod::fSetterMethod
private

Definition at line 45 of file TMethod.h.


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