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

Global functions class (global functions are obtained from CINT).

This class describes one single global function. The TROOT class contains a list of all currently defined global functions (accessible via TROOT::GetListOfGlobalFunctions()).

Definition at line 30 of file TFunction.h.

Public Member Functions

 TFunction (const TFunction &orig)
 Copy operator.
 
 TFunction (MethodInfo_t *info=nullptr)
 Default TFunction ctor.
 
virtual ~TFunction ()
 TFunction dtor deletes adopted CINT MethodInfo.
 
TObjectClone (const char *newname="") const override
 Clone method.
 
Long_t ExtraProperty () const
 Get property description word. For meaning of bits see EProperty.
 
DeclId_t GetDeclId () const
 
TListGetListOfMethodArgs ()
 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.
 
TClassIsA () const override
 
virtual Bool_t IsValid ()
 Return true if this function object is pointing to a currently loaded function.
 
void ls (Option_t *option="") const override
 List TFunction name and title.
 
TFunctionoperator= (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 Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual bool Update (MethodInfo_t *info)
 Update the TFunction to reflect the new info.
 
- 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)
 
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 ("").
 
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.
 
TClassIsA () const override
 
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 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 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 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_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).
 
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)
 Operator delete [].
 
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 Public Member Functions inherited from TDictionary
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static TDictionaryGetDictionary (const char *name)
 Retrieve the type (class, fundamental type, typedef etc) named "name".
 
static TDictionaryGetDictionary (const std::type_info &typeinfo)
 
static bool WantsRegularMembers (EMemberSelection sel)
 
static bool WantsUsingDecls (EMemberSelection sel)
 
- 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

virtual void CreateSignature ()
 Using the CINT method arg information to create a complete signature string.
 
- 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

MethodInfo_t * fInfo
 
TString fMangledName
 
TListfMethodArgs
 
TString fSignature
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Friends

class TCling
 
class TMethodCall
 

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

#include <TFunction.h>

Inheritance diagram for TFunction:
[legend]

Constructor & Destructor Documentation

◆ TFunction() [1/2]

TFunction::TFunction ( MethodInfo_t *  info = nullptr)

Default TFunction ctor.

TFunctions are constructed in TROOT via a call to TCling::UpdateListOfGlobalFunctions().

Definition at line 35 of file TFunction.cxx.

◆ TFunction() [2/2]

TFunction::TFunction ( const TFunction orig)

Copy operator.

Definition at line 52 of file TFunction.cxx.

◆ ~TFunction()

TFunction::~TFunction ( )
virtual

TFunction dtor deletes adopted CINT MethodInfo.

Definition at line 90 of file TFunction.cxx.

Member Function Documentation

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 68 of file TFunction.h.

◆ Clone()

TObject * TFunction::Clone ( const char *  newname = "") const
overridevirtual

Clone method.

Reimplemented from TObject.

Reimplemented in TMethod.

Definition at line 101 of file TFunction.cxx.

◆ CreateSignature()

void TFunction::CreateSignature ( )
protectedvirtual

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

Reimplemented in TMethod.

Definition at line 112 of file TFunction.cxx.

◆ DeclFileName()

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

Definition at line 68 of file TFunction.h.

◆ ExtraProperty()

Long_t TFunction::ExtraProperty ( ) const

Get property description word. For meaning of bits see EProperty.

Definition at line 202 of file TFunction.cxx.

◆ GetDeclId()

TDictionary::DeclId_t TFunction::GetDeclId ( ) const

Definition at line 210 of file TFunction.cxx.

◆ GetListOfMethodArgs()

TList * TFunction::GetListOfMethodArgs ( )

Return list containing the TMethodArgs of a TFunction.

Definition at line 135 of file TFunction.cxx.

◆ GetMangledName()

const char * TFunction::GetMangledName ( ) const
virtual

Returns the mangled name as defined by CINT, or 0 in case of error.

Definition at line 252 of file TFunction.cxx.

◆ GetNargs()

Int_t TFunction::GetNargs ( ) const

Number of function arguments.

Definition at line 174 of file TFunction.cxx.

◆ GetNargsOpt()

Int_t TFunction::GetNargsOpt ( ) const

Number of function optional (default) arguments.

Definition at line 184 of file TFunction.cxx.

◆ GetPrototype()

const char * TFunction::GetPrototype ( ) const
virtual

Returns the prototype of a function as defined by CINT, or 0 in case of error.

Definition at line 261 of file TFunction.cxx.

◆ GetReturnTypeName()

const char * TFunction::GetReturnTypeName ( ) const

Get full type description of function return type, e,g.: "class TDirectory*".

Definition at line 150 of file TFunction.cxx.

◆ GetReturnTypeNormalizedName()

std::string TFunction::GetReturnTypeNormalizedName ( ) const

Get the normalized name of the return type.

A normalized name is fully qualified and has all typedef desugared except for the 'special' typedef which include Double32_t, Float16_t, [U]Long64_t and std::string. It also has std:: removed [This is subject to change].

Definition at line 164 of file TFunction.cxx.

◆ GetSignature()

const char * TFunction::GetSignature ( )

Return signature of function.

Definition at line 122 of file TFunction.cxx.

◆ InterfaceMethod()

void * TFunction::InterfaceMethod ( ) const

Return pointer to the interface method.

Using this pointer we can find which TFunction belongs to a CINT MethodInfo object. Both need to have the same InterfaceMethod pointer.

Definition at line 221 of file TFunction.cxx.

◆ IsA()

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

Reimplemented from TDictionary.

Reimplemented in TMethod.

Definition at line 68 of file TFunction.h.

◆ IsValid()

Bool_t TFunction::IsValid ( )
virtual

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

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

Reimplemented in TMethod.

Definition at line 232 of file TFunction.cxx.

◆ ls()

void TFunction::ls ( Option_t option = "") const
overridevirtual

List TFunction name and title.

Reimplemented from TObject.

Definition at line 273 of file TFunction.cxx.

◆ operator=()

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

Assignment operator.

Definition at line 66 of file TFunction.cxx.

◆ Print()

void TFunction::Print ( Option_t option = "") const
overridevirtual

Print TFunction name and title.

Reimplemented from TObject.

Definition at line 283 of file TFunction.cxx.

◆ Property()

Long_t TFunction::Property ( ) const
overridevirtual

Get property description word. For meaning of bits see EProperty.

Implements TDictionary.

Definition at line 193 of file TFunction.cxx.

◆ Streamer()

void TFunction::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TDictionary.

Reimplemented in TMethod.

◆ StreamerNVirtual()

void TFunction::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 68 of file TFunction.h.

◆ Update()

Bool_t TFunction::Update ( MethodInfo_t *  info)
virtual

Update the TFunction to reflect the new info.

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

Reimplemented in TMethod.

Definition at line 294 of file TFunction.cxx.

Friends And Related Symbol Documentation

◆ TCling

friend class TCling
friend

Definition at line 32 of file TFunction.h.

◆ TMethodCall

friend class TMethodCall
friend

Definition at line 33 of file TFunction.h.

Member Data Documentation

◆ fInfo

MethodInfo_t* TFunction::fInfo
protected

Definition at line 36 of file TFunction.h.

◆ fMangledName

TString TFunction::fMangledName
protected

Definition at line 37 of file TFunction.h.

◆ fMethodArgs

TList* TFunction::fMethodArgs
protected

Definition at line 39 of file TFunction.h.

◆ fSignature

TString TFunction::fSignature
protected

Definition at line 38 of file TFunction.h.

  • core/meta/inc/TFunction.h
  • core/meta/src/TFunction.cxx