Logo ROOT  
Reference Guide
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 28 of file TFunction.h.

Public Member Functions

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

Protected Member Functions

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

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

#include <TFunction.h>

Inheritance diagram for TFunction:
[legend]

Constructor & Destructor Documentation

◆ TFunction() [1/2]

TFunction::TFunction ( MethodInfo_t *  info = 0)

Default TFunction ctor.

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

Definition at line 34 of file TFunction.cxx.

◆ TFunction() [2/2]

TFunction::TFunction ( const TFunction orig)

Copy operator.

Definition at line 48 of file TFunction.cxx.

◆ ~TFunction()

TFunction::~TFunction ( )
virtual

TFunction dtor deletes adopted CINT MethodInfo.

Definition at line 84 of file TFunction.cxx.

Member Function Documentation

◆ Clone()

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

Clone method.

Reimplemented from TNamed.

Reimplemented in TMethod.

Definition at line 96 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 106 of file TFunction.cxx.

◆ ExtraProperty()

Long_t TFunction::ExtraProperty ( ) const

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

Definition at line 191 of file TFunction.cxx.

◆ GetDeclId()

TDictionary::DeclId_t TFunction::GetDeclId ( ) const

Definition at line 198 of file TFunction.cxx.

◆ GetListOfMethodArgs()

TList * TFunction::GetListOfMethodArgs ( )

Return list containing the TMethodArgs of a TFunction.

Definition at line 126 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 236 of file TFunction.cxx.

◆ GetNargs()

Int_t TFunction::GetNargs ( ) const

Number of function arguments.

Definition at line 164 of file TFunction.cxx.

◆ GetNargsOpt()

Int_t TFunction::GetNargsOpt ( ) const

Number of function optional (default) arguments.

Definition at line 174 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 245 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 140 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 154 of file TFunction.cxx.

◆ GetSignature()

const char * TFunction::GetSignature ( )

Return signature of function.

Definition at line 115 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 208 of file TFunction.cxx.

◆ 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 218 of file TFunction.cxx.

◆ ls()

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

List TFunction name and title.

Reimplemented from TNamed.

Definition at line 257 of file TFunction.cxx.

◆ operator=()

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

Assignment operator.

Definition at line 62 of file TFunction.cxx.

◆ Print()

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

Print TFunction name and title.

Reimplemented from TNamed.

Definition at line 267 of file TFunction.cxx.

◆ Property()

Long_t TFunction::Property ( ) const
virtual

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

Implements TDictionary.

Definition at line 183 of file TFunction.cxx.

◆ 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 278 of file TFunction.cxx.

Friends And Related Function Documentation

◆ TCling

friend class TCling
friend

Definition at line 30 of file TFunction.h.

◆ TMethodCall

friend class TMethodCall
friend

Definition at line 31 of file TFunction.h.

Member Data Documentation

◆ fInfo

MethodInfo_t* TFunction::fInfo
protected

Definition at line 34 of file TFunction.h.

◆ fMangledName

TString TFunction::fMangledName
protected

Definition at line 35 of file TFunction.h.

◆ fMethodArgs

TList* TFunction::fMethodArgs
protected

Definition at line 37 of file TFunction.h.

◆ fSignature

TString TFunction::fSignature
protected

Definition at line 36 of file TFunction.h.


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