 |
ROOT
6.06/09
Reference Guide
|
|
ROOT
6.06/09
Reference Guide
|
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 (MethodInfo_t *info=0) | |
| TFunction (const TFunction &orig) | |
| Copy operator. More... | |
| TFunction & | operator= (const TFunction &rhs) |
| Assignment operator. More... | |
| virtual | ~TFunction () |
| TFunction dtor deletes adopted CINT MethodInfo. More... | |
| virtual TObject * | Clone (const char *newname="") const |
| Clone method. More... | |
| virtual const char * | GetMangledName () const |
| Returns the mangled name as defined by CINT, or 0 in case of error. 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 * | GetSignature () |
| Return signature of function. 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... | |
| TList * | GetListOfMethodArgs () |
| Return list containing the TMethodArgs of a TFunction. More... | |
| Int_t | GetNargs () const |
| Number of function arguments. More... | |
| Int_t | GetNargsOpt () const |
| Number of function optional (default) arguments. More... | |
| DeclId_t | GetDeclId () const |
| void * | InterfaceMethod () 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 | 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... | |
| Long_t | ExtraProperty () 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... | |
| virtual void | ls (Option_t *option="") const |
| List TFunction name and title. More... | |
 Public Member Functions inherited from TDictionary | |
| TDictionary () | |
| TDictionary (const char *name) | |
| TDictionary (const TDictionary &dict) | |
| virtual | ~TDictionary () |
| TDictionary & | operator= (const TDictionary &other) |
| void | CreateAttributeMap () |
| TDictAttributeMap * | GetAttributeMap () const |
| Public Member Functions inherited from TNamed | |
| TNamed () | |
| TNamed (const char *name, const char *title) | |
| TNamed (const TString &name, const TString &title) | |
| TNamed (const TNamed &named) | |
| TNamed & | operator= (const TNamed &rhs) |
| TNamed assignment operator. More... | |
| virtual | ~TNamed () |
| virtual void | Clear (Option_t *option="") |
| Set name and title to empty strings (""). 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 | SetName (const char *name) |
| Change (i.e. More... | |
| virtual void | SetNameTitle (const char *name, const char *title) |
| Change (i.e. set) all the TNamed parameters (name and title). More... | |
| virtual void | SetTitle (const char *title="") |
| Change (i.e. 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 (const TObject &object) | |
| TObject copy ctor. More... | |
| TObject & | operator= (const TObject &rhs) |
| TObject assignment operator. More... | |
| virtual | ~TObject () |
| TObject destructor. 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... | |
| virtual const char * | ClassName () const |
| Returns name of class to which the object belongs. 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 TObject * | DrawClone (Option_t *option="") const |
| Draw a clone of this object in the current pad. More... | |
| virtual void | Dump () const |
| Dump contents of object on stdout. 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 TObject * | FindObject (const char *name) const |
| Must be redefined in derived classes. More... | |
| virtual TObject * | FindObject (const TObject *obj) const |
| Must be redefined in derived classes. More... | |
| virtual Option_t * | GetDrawOption () const |
| Get option used by the graphics system to draw this object. More... | |
| virtual UInt_t | GetUniqueID () const |
| Return the unique object id. More... | |
| virtual const char * | GetIconName () const |
| Returns mime type name of object. More... | |
| virtual Option_t * | GetOption () const |
| virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
| Returns string containing info about the object at position (px,py). More... | |
| virtual Bool_t | HandleTimer (TTimer *timer) |
| Execute action in response of a timer timing out. 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... | |
| virtual Bool_t | IsFolder () const |
| Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More... | |
| virtual Bool_t | IsEqual (const TObject *obj) const |
| Default equal comparison (objects are equal if they have the same address in memory). More... | |
| Bool_t | IsOnHeap () const |
| Bool_t | IsZombie () const |
| virtual Bool_t | Notify () |
| This method must be overridden to handle object notification. 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 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... | |
| 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... | |
| 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 | UseCurrentStyle () |
| Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. 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... | |
| void * | operator new (size_t sz) |
| void * | operator new[] (size_t sz) |
| void * | operator new (size_t sz, void *vp) |
| void * | operator new[] (size_t sz, void *vp) |
| void | operator delete (void *ptr) |
| Operator delete. More... | |
| void | operator delete[] (void *ptr) |
| Operator delete []. More... | |
| void | SetBit (UInt_t f, Bool_t set) |
| Set or unset the user status bits as specified in f. More... | |
| void | SetBit (UInt_t f) |
| void | ResetBit (UInt_t f) |
| Bool_t | TestBit (UInt_t f) const |
| Int_t | TestBits (UInt_t f) const |
| void | InvertBit (UInt_t f) |
| virtual void | Info (const char *method, const char *msgfmt,...) const |
| Issue info message. More... | |
| virtual void | Warning (const char *method, const char *msgfmt,...) const |
| Issue warning message. More... | |
| virtual void | Error (const char *method, const char *msgfmt,...) const |
| Issue error message. More... | |
| virtual void | SysError (const char *method, const char *msgfmt,...) const |
| Issue system error message. More... | |
| virtual void | Fatal (const char *method, const char *msgfmt,...) const |
| Issue fatal error message. 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... | |
| 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... | |
| void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
| Use this method to declare a method obsolete. 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 | |
| void | MakeZombie () |
| virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
| Interface to ErrorHandler (protected). More... | |
Protected Attributes | |
| MethodInfo_t * | fInfo |
| TString | fMangledName |
| TString | fSignature |
| TList * | fMethodArgs |
| Protected Attributes inherited from TNamed | |
| TString | fName |
| TString | fTitle |
Friends | |
| class | TCling |
| class | TMethodCall |
Additional Inherited Members | |
| Public Types inherited from TDictionary | |
| 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 } |
| typedef const void * | DeclId_t |
| Public Types inherited from TObject | |
| enum | EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) } |
| enum | { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff } |
| enum | { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) } |
| Static Public Member Functions inherited from TDictionary | |
| static TDictionary * | GetDictionary (const char *name) |
| static TDictionary * | GetDictionary (const type_info &typeinfo) |
| Static Public Member Functions inherited from TObject | |
| static Long_t | GetDtorOnly () |
| Return destructor only flag. More... | |
| static void | SetDtorOnly (void *obj) |
| Set destructor only flag. More... | |
| static Bool_t | GetObjectStat () |
| Get status of object stat flag. More... | |
| static void | SetObjectStat (Bool_t stat) |
| Turn on/off tracking of objects in the TObjectTable. More... | |
#include <TFunction.h>
Inheritance diagram for TFunction: Collaboration diagram for TFunction:| TFunction::TFunction | ( | MethodInfo_t * | info = 0 | ) |
Referenced by Clone().
| TFunction::TFunction | ( | const TFunction & | orig | ) |
Copy operator.
Definition at line 48 of file TFunction.cxx.
|
virtual |
TFunction dtor deletes adopted CINT MethodInfo.
Definition at line 84 of file TFunction.cxx.
|
virtual |
Clone method.
Reimplemented from TNamed.
Reimplemented in TMethod.
Definition at line 96 of file TFunction.cxx.
|
protectedvirtual |
Using the CINT method arg information to create a complete signature string.
Reimplemented in TMethod.
Definition at line 106 of file TFunction.cxx.
Referenced by TMethod::CreateSignature(), and GetSignature().
| Long_t TFunction::ExtraProperty | ( | ) | const |
Get property description word. For meaning of bits see EProperty.
Definition at line 191 of file TFunction.cxx.
Referenced by Cppyy::GetMethodResultType(), and Cppyy::IsConstructor().
| TDictionary::DeclId_t TFunction::GetDeclId | ( | ) | const |
Definition at line 198 of file TFunction.cxx.
Referenced by TListOfFunctions::GetListForObjectNonConst(), TListOfFunctions::MapObject(), TListOfFunctions::Unload(), and TListOfFunctions::UnmapObject().
| TList * TFunction::GetListOfMethodArgs | ( | ) |
Return list containing the TMethodArgs of a TFunction.
Definition at line 126 of file TFunction.cxx.
Referenced by TMethod::GetListOfMethodArgs(), Cppyy::GetMethodArgDefault(), Cppyy::GetMethodArgName(), Cppyy::GetMethodArgType(), TProofServ::HandleCache(), TProof::LoadPackageOnClient(), and TRootSniffer::ProduceExe().
|
virtual |
Returns the mangled name as defined by CINT, or 0 in case of error.
Definition at line 236 of file TFunction.cxx.
Referenced by TListOfFunctions::Get().
| Int_t TFunction::GetNargs | ( | ) | const |
Number of function arguments.
Definition at line 164 of file TFunction.cxx.
Referenced by TQObject::CheckConnectArgs(), TPluginHandler::CheckForExecPlugin(), TTabCom::Complete(), TClass::GetMenuItems(), Cppyy::GetMethodReqArgs(), GetNargsOpt(), TProofServ::HandleCache(), TMethodBrowsable::IsMethodBrowsable(), TProof::LoadPackageOnClient(), and TFormula::ProcessFormula().
| Int_t TFunction::GetNargsOpt | ( | ) | const |
Number of function optional (default) arguments.
Definition at line 174 of file TFunction.cxx.
Referenced by TQObject::CheckConnectArgs(), TPluginHandler::CheckForExecPlugin(), Cppyy::GetMethodReqArgs(), TMethodBrowsable::IsMethodBrowsable(), and TFormula::ProcessFormula().
|
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.
Referenced by ClassImp(), ls(), TRootSniffer::ProduceExe(), and TMethodBrowsable::TMethodBrowsable().
| 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.
Referenced by TDocParser::AddClassMethodsRecursively(), TFormLeafInfoMethod::GetClass(), TTabCom::Hook(), TMethodBrowsable::IsMethodBrowsable(), TClassDocOutput::ListFunctions(), TTreeFormula::ParseWithLeaf(), TClassTree::ScanClasses(), TFormLeafInfoMethod::TFormLeafInfoMethod(), and TMethodBrowsable::TMethodBrowsable().
| 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.
Referenced by Cppyy::GetMethodResultType(), TRootSniffer::ProduceExe(), and PyROOT::Pythonize().
| const char * TFunction::GetSignature | ( | ) |
Return signature of function.
Definition at line 115 of file TFunction.cxx.
Referenced by TGuiBldDragManager::AddDialogMethods(), TTabCom::Hook(), and TMethodCall::Init().
| 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.
Referenced by TClass::GetClassMethod(), and R__CreateBuffer().
|
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.
List TFunction name and title.
Reimplemented from TNamed.
Definition at line 257 of file TFunction.cxx.
Assignment operator.
Definition at line 62 of file TFunction.cxx.
Referenced by TMethod::operator=().
Print TFunction name and title.
Reimplemented from TNamed.
Definition at line 267 of file TFunction.cxx.
|
virtual |
Get property description word. For meaning of bits see EProperty.
Implements TDictionary.
Definition at line 183 of file TFunction.cxx.
Referenced by TDocParser::AddClassMethodsRecursively(), TClassDocOutput::CreateDotClassChartInhMem(), TMethod::CreateSignature(), TXMLPlayer::ElementGetter(), TXMLPlayer::ElementSetter(), Cppyy::IsConstMethod(), TMethodBrowsable::IsMethodBrowsable(), Cppyy::IsPublicMethod(), Cppyy::IsStaticMethod(), TClassDocOutput::ListFunctions(), TViewPubFunctionsIter::Next(), TPluginHandler::SetupCallEnv(), TFormLeafInfoMethod::TFormLeafInfoMethod(), TClassDocOutput::WriteMethod(), and TDocParser::WriteMethod().
|
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.
Referenced by TListOfFunctions::Get(), IsValid(), and TMethod::Update().
|
friend |
Definition at line 32 of file TFunction.h.
|
friend |
Definition at line 33 of file TFunction.h.
Referenced by TMethod::GetterMethod(), and TMethod::SetterMethod().
|
protected |
Definition at line 36 of file TFunction.h.
Referenced by CreateSignature(), TCling::Execute(), TCling::ExecuteWithArgsAndReturn(), ExtraProperty(), TMethod::GetCommentString(), GetDeclId(), GetListOfMethodArgs(), GetNargs(), GetNargsOpt(), GetPrototype(), GetReturnTypeName(), GetReturnTypeNormalizedName(), GetSignature(), InterfaceMethod(), TMethod::IsValid(), IsValid(), operator=(), Property(), TFunction(), Update(), TMethod::Update(), and ~TFunction().
|
protected |
Definition at line 37 of file TFunction.h.
Referenced by GetMangledName(), operator=(), TFunction(), and Update().
|
protected |
Definition at line 39 of file TFunction.h.
Referenced by TMethod::FindDataMember(), GetListOfMethodArgs(), TMethod::GetListOfMethodArgs(), GetNargs(), operator=(), TFunction(), Update(), and ~TFunction().
|
protected |
Definition at line 38 of file TFunction.h.
Referenced by CreateSignature(), TMethod::CreateSignature(), and GetSignature().
ROOT 6.06/09 - Reference Guide Generated on Sun Dec 10 2017 22:28:03 using Doxygen 1.8.9.
