 |
ROOT
6.06/09
Reference Guide
|
|
ROOT
6.06/09
Reference Guide
|
Each ROOT method (see TMethod) has a linked list of its arguments.
This class describes one single method argument. The method argument info is obtained via the CINT api. See class TCling.
The method argument information is used a.o. in the TContextMenu and THtml classes.
Definition at line 33 of file TMethodArg.h.
Public Member Functions | |
| TMethodArg (MethodArgInfo_t *info=0, TFunction *method=0) | |
| virtual | ~TMethodArg () |
| TMethodArg dtor deletes adopted CINT MethodArgInfo object. More... | |
| const char * | GetDefault () const |
| Get default value of method argument. More... | |
| TFunction * | GetMethod () const |
| const char * | GetTypeName () const |
| Get type of method argument, e.g. More... | |
| const char * | GetFullTypeName () const |
| Get full type description of method argument, e.g.: "class TDirectory*". More... | |
| std::string | GetTypeNormalizedName () const |
| Get the normalized name of the return type. More... | |
| Long_t | Property () const |
| Get property description word. For meaning of bits see EProperty. More... | |
| TDataMember * | GetDataMember () const |
| Returns TDataMember pointed by this methodarg. More... | |
| TList * | GetOptions () const |
| Returns list of possible options - according to pointed datamember. More... | |
| void | Update (MethodArgInfo_t *info) |
| Update fInfo (to 0 for unloading and non-zero for reloading). 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 TObject * | Clone (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 | 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 void | ls (Option_t *option="") const |
| List TNamed name and title. More... | |
| virtual void | Print (Option_t *option="") const |
| Print TNamed name and title. 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... | |
Private Member Functions | |
| TMethodArg (const TMethodArg &) | |
| TMethodArg & | operator= (const TMethodArg &) |
Private Attributes | |
| MethodArgInfo_t * | fInfo |
| TFunction * | fMethod |
| TDataMember * | fDataMember |
Friends | |
| class | TMethod |
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... | |
| 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 inherited from TNamed | |
| TString | fName |
| TString | fTitle |
#include <TMethodArg.h>
Inheritance diagram for TMethodArg: Collaboration diagram for TMethodArg:
|
private |
| TMethodArg::TMethodArg | ( | MethodArgInfo_t * | info = 0, |
| TFunction * | method = 0 |
||
| ) |
|
virtual |
TMethodArg dtor deletes adopted CINT MethodArgInfo object.
Definition at line 50 of file TMethodArg.cxx.
| TDataMember * TMethodArg::GetDataMember | ( | ) | const |
Returns TDataMember pointed by this methodarg.
If you want to specify list of options or current value for your MethodArg (i.e. it is used as initial values in argument-asking dialogs popped up from context-meny),you can get this value from one of data members of the class.
The only restriction is, that this DataMember object must have its Getter/Setter methods set-up correctly - for details look at TDataMember. To learn how to specify the data member to which the argument should "point", look at TMethod. This is TMethod which sets up fDataMember, so it could work correctly.
Definition at line 121 of file TMethodArg.cxx.
Referenced by TQCanvasMenu::Dialog().
| const char * TMethodArg::GetDefault | ( | ) | const |
Get default value of method argument.
Definition at line 58 of file TMethodArg.cxx.
Referenced by TQCanvasMenu::CreateArgumentTitle(), TContextMenu::CreateArgumentTitle(), CreateArgumentTitle(), TQCanvasMenu::Dialog(), TCling::Execute(), Cppyy::GetMethodArgDefault(), TRootSniffer::ProduceExe(), and TClassDocOutput::WriteMethod().
| const char * TMethodArg::GetFullTypeName | ( | ) | const |
Get full type description of method argument, e.g.: "class TDirectory*".
Definition at line 75 of file TMethodArg.cxx.
Referenced by TCling::Execute(), TClass::MakeCustomMenuList(), TRootSniffer::ProduceExe(), and TClassDocOutput::WriteMethod().
|
inline |
Definition at line 49 of file TMethodArg.h.
| TList * TMethodArg::GetOptions | ( | ) | const |
Returns list of possible options - according to pointed datamember.
If there is no datamember field assigned to this methodarg - returns 0.
Definition at line 103 of file TMethodArg.cxx.
| const char * TMethodArg::GetTypeName | ( | ) | const |
Get type of method argument, e.g.
: "class TDirectory*" -> "TDirectory" Result needs to be used or copied immediately.
Definition at line 67 of file TMethodArg.cxx.
Referenced by TQCanvasMenu::Dialog(), and TClassTree::ScanClasses().
| std::string TMethodArg::GetTypeNormalizedName | ( | ) | 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 86 of file TMethodArg.cxx.
Referenced by GetCallFunc(), and Cppyy::GetMethodArgType().
|
private |
|
virtual |
Get property description word. For meaning of bits see EProperty.
Implements TDictionary.
Definition at line 94 of file TMethodArg.cxx.
| void TMethodArg::Update | ( | MethodArgInfo_t * | info | ) |
Update fInfo (to 0 for unloading and non-zero for reloading).
This takes ownership of 'info'
Definition at line 130 of file TMethodArg.cxx.
Referenced by TFunction::Update().
|
friend |
Definition at line 35 of file TMethodArg.h.
|
private |
Definition at line 43 of file TMethodArg.h.
Referenced by TMethod::FindDataMember(), GetDataMember(), and GetOptions().
|
private |
Definition at line 41 of file TMethodArg.h.
Referenced by GetDefault(), GetFullTypeName(), GetTypeName(), GetTypeNormalizedName(), Property(), Update(), and ~TMethodArg().
|
private |
Definition at line 42 of file TMethodArg.h.
Referenced by GetMethod().
ROOT 6.06/09 - Reference Guide Generated on Sun Dec 10 2017 22:28:29 using Doxygen 1.8.9.
