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.

	TMethod (MethodInfo_t info=nullptr, TClass cl=nullptr)
	Default TMethod ctor.

virtual	~TMethod ()
	Cleanup.

TObject *	Clone (const char *newname="") const override
	Clone method.

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

TClass *	GetClass () const

virtual const char *	GetCommentString ()
	Returns a comment string from the class declaration.

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

virtual const char *	Getter () const

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

TClass *	IsA () const override

EMenuItemKind	IsMenuItem () const

Bool_t	IsValid () override
	Return true if this function object is pointing to a currently loaded function.

TMethod &	operator= (const TMethod &rhs)
	Assignment operator.

virtual void	SetMenuItem (EMenuItemKind menuItem)

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

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Bool_t	Update (MethodInfo_t *info) override
	Update the TMethod to reflect the new info.

Public Member Functions inherited from TFunction
	TFunction (const TFunction &orig)
	Copy operator.

	TFunction (MethodInfo_t *info=nullptr)
	Default TFunction ctor.

virtual	~TFunction ()
	TFunction dtor deletes adopted CINT MethodInfo.

Long_t	ExtraProperty () const
	Get property description word. For meaning of bits see EProperty.

DeclId_t	GetDeclId () const

TList *	GetListOfMethodArgs ()
	Return list containing the TMethodArgs of a TFunction.

virtual const char *	GetMangledName () const
	Returns the mangled name as defined by CINT, or 0 in case of error.

Int_t	GetNargs () const
	Number of function arguments.

Int_t	GetNargsOpt () const
	Number of function optional (default) arguments.

virtual const char *	GetPrototype () const
	Returns the prototype of a function as defined by CINT, or 0 in case of error.

const char *	GetReturnTypeName () const
	Get full type description of function return type, e,g.: "class TDirectory*".

std::string	GetReturnTypeNormalizedName () const
	Get the normalized name of the return type.

const char *	GetSignature ()
	Return signature of function.

void *	InterfaceMethod () const
	Return pointer to the interface method.

void	ls (Option_t *option="") const override
	List TFunction name and title.

TFunction &	operator= (const TFunction &rhs)
	Assignment operator.

void	Print (Option_t *option="") const override
	Print TFunction name and title.

Long_t	Property () const override
	Get property description word. For meaning of bits see EProperty.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TDictionary
	TDictionary ()

	TDictionary (const char *name)

	TDictionary (const TDictionary &dict)

virtual	~TDictionary ()

void	CreateAttributeMap ()

TDictAttributeMap *	GetAttributeMap () const

TDictionary &	operator= (const TDictionary &other)

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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 ("").

TObject *	Clone (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.

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List TNamed name and title.

TNamed &	operator= (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	Streamer (TBuffer &) override
	Stream an object of class 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.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

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 TObject *	DrawClone (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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () 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).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

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)

TObject &	operator= (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 TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TFunction
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TDictionary
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static TDictionary *	GetDictionary (const char *name)
	Retrieve the type (class, fundamental type, typedef etc) named "name".

static TDictionary *	GetDictionary (const std::type_info &typeinfo)

static bool	WantsRegularMembers (EMemberSelection sel)

static bool	WantsUsingDecls (EMemberSelection sel)

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

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.

Private Member Functions
void	CreateSignature () override
	Using the CINT method arg information create a complete signature string.

void	SetMenuItem (const char *docstring)
	Set the menu item as prescribed in the doctstring.

Private Attributes
TClass *	fClass

TString	fGetter

TMethodCall *	fGetterMethod

EMenuItemKind	fMenuItem

TMethodCall *	fSetterMethod

Additional Inherited Members
Public Types inherited from TDictionary
typedef const void *	DeclId_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 = (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 Member Functions inherited from TDictionary
Bool_t	UpdateInterpreterStateMarker ()
	the Cling ID of the transaction that last updated the object

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 ()

Protected Attributes inherited from TFunction
MethodInfo_t *	fInfo

TString	fMangledName

TList *	fMethodArgs

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 = `nullptr`,
		TClass *	cl = `nullptr`
	)

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 41 of file TMethod.cxx.

◆ TMethod() [2/2]

TMethod::TMethod ( const TMethod & org )

Copy ctor.

Definition at line 56 of file TMethod.cxx.

◆ ~TMethod()

TMethod::~TMethod ( )

virtual

Cleanup.

Definition at line 88 of file TMethod.cxx.

Member Function Documentation

◆ Class()

static TClass * TMethod::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TMethod::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TMethod::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 68 of file TMethod.h.

◆ Clone()

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

overridevirtual

Clone method.

Reimplemented from TFunction.

Definition at line 97 of file TMethod.cxx.

◆ CreateSignature()

void TMethod::CreateSignature ( )

overrideprivatevirtual

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

Reimplemented from TFunction.

Definition at line 116 of file TMethod.cxx.

◆ DeclFileName()

static const char * TMethod::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 68 of file TMethod.h.

◆ 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 134 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 107 of file TMethod.cxx.

◆ GetListOfMethodArgs()

TList * TMethod::GetListOfMethodArgs ( )

virtual

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

Definition at line 307 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 264 of file TMethod.cxx.

◆ IsA()

TClass * TMethod::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TFunction.

Definition at line 68 of file TMethod.h.

◆ IsMenuItem()

EMenuItemKind TMethod::IsMenuItem ( ) const

inline

Definition at line 56 of file TMethod.h.

◆ IsValid()

Bool_t TMethod::IsValid ( )

overridevirtual

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 277 of file TMethod.cxx.

◆ operator=()

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

Assignment operator.

Definition at line 68 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 319 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 295 of file TMethod.cxx.

◆ Streamer()

void TMethod::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TFunction.

◆ StreamerNVirtual()

void TMethod::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 68 of file TMethod.h.

◆ Update()

Bool_t TMethod::Update ( MethodInfo_t * info )

overridevirtual

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 344 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.

Libraries for TMethod:

[legend]

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

core/meta/inc/TMethod.h
core/meta/src/TMethod.cxx

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TMethod() [1/2]

◆ TMethod() [2/2]

◆ ~TMethod()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Clone()

◆ CreateSignature()

◆ DeclFileName()

◆ FindDataMember()

◆ GetClass()

◆ GetCommentString()

◆ GetListOfMethodArgs()

◆ Getter()

◆ GetterMethod()

◆ IsA()

◆ IsMenuItem()

◆ IsValid()

◆ operator=()

◆ SetMenuItem() [1/2]

◆ SetMenuItem() [2/2]

◆ SetterMethod()

◆ Streamer()

◆ StreamerNVirtual()

◆ Update()

Member Data Documentation

◆ fClass

◆ fGetter

◆ fGetterMethod

◆ fMenuItem

◆ fSetterMethod