![]() |
ROOT 6.16/01 Reference Guide |
All ROOT classes may have RTTI (run time type identification) support added.
The data is stored in so called DICTIONARY (look at TDictionary). Information about a class is stored in TClass. This information may be obtained via the cling api - see class TCling. TClass has a list of TDataMember objects providing information about all data members of described class.
TDataMember provides information about name of data member, its type, and comment field string. It also tries to find the TMethodCall objects responsible for getting/setting a value of it, and gives you pointers to these methods. This gives you a unique possibility to access protected and private (!) data members if only methods for doing that are defined.
These methods could either be specified in a comment field, or found out automatically by ROOT: here's an example: suppose you have a class definition:
Look at the data member name and method names: a data member name has a prefix letter (f) and has a base name X1 . The methods for getting and setting this value have names which consist of string Get/Set and the same base name. This convention of naming data fields and methods which access them allows TDataMember find this methods by itself completely automatically. To make this description complete, one should know, that names that are automatically recognized may be also: for data fields: either fXXX or fIsXXX; and for getter function GetXXX() or IsXXX() [where XXX is base name].
As an example of using it let's analyse a few lines which get and set a fEditable field in TCanvas:
This trick is widely used in ROOT TContextMenu and dialogs for obtaining current values and put them as initial values in dialog fields.
If you don't want to follow the convention of naming used by ROOT you still could benefit from Getter/Setter method support: the solution is to instruct ROOT what the names of these routines are. The way to do it is putting this information in a comment string to a data field in your class declaration:
However, this getting/setting functions are not the only feature of this class. The next point is providing lists of possible settings for the concerned data member. The idea is to have a list of possible options for this data member, with strings identifying them. This is used in dialogs with parameters to set - for details see TMethodArg, TRootContextMenu, TContextMenu. This list not only specifies the allowed value, but also provides strings naming the options. Options are managed via TList of TOptionListItem objects. This list is also created automatically: if a data type is an enum type, the list will have items describing every enum value, and named according to enum name. If type is Bool_t, two options "On" and "Off" with values 0 and 1 are created. For other types you need to instruct ROOT about possible options. The way to do it is the same as in case of specifying getter/setter method: a comment string to a data field in Your header file with class definition. The most general format of this string is:
While parsing this string ROOT firstly looks for command-tokens: GetMethod, SetMethod, Items; They must be preceded by string OPTIONS= , enclosed by {} and separated by semicolons ";". All command token should have a form TOKEN=VALUE. All tokens are optional. The names of getter and setter method must be enclosed by double-quote marks (") . Specifications of Items is slightly more complicated: you need to put token ITEMS= and then enclose all options in curly brackets "()". You separate options by comas ",". Each option item may have one of the following forms: @code IntegerValue = "Text Label" EnumValue = "Text Label" "TextValue" = Text Label"
One can specify values as Integers or Enums - when data field is an Integer, Float or Enum type; as texts - for char (more precisely: Option_t).
As mentioned above - this information are mainly used by contextmenu, but also in Dump() and Inspect() methods and by the THtml class.
Definition at line 31 of file TDataMember.h.
Public Member Functions | |
TDataMember (DataMemberInfo_t *info=0, TClass *cl=0) | |
Default TDataMember ctor. More... | |
virtual | ~TDataMember () |
TDataMember dtor deletes adopted CINT DataMemberInfo object. More... | |
Int_t | GetArrayDim () const |
Return number of array dimensions. More... | |
const char * | GetArrayIndex () const |
If the data member is pointer and has a valid array size in its comments GetArrayIndex returns a string pointing to it; otherwise it returns an empty string. More... | |
TClass * | GetClass () const |
TDataType * | GetDataType () const |
DeclId_t | GetDeclId () const |
const char * | GetFullTypeName () const |
Get full type description of data member, e,g.: "class TDirectory*". More... | |
Int_t | GetMaxIndex (Int_t dim) const |
Return maximum index for array dimension "dim". More... | |
Long_t | GetOffset () const |
Get offset from "this". More... | |
Long_t | GetOffsetCint () const |
Get offset from "this" using the information in CINT only. More... | |
TList * | GetOptions () const |
Returns list of options - list of TOptionListItems. More... | |
TMethodCall * | GetterMethod (TClass *cl=0) |
Return a TMethodCall method responsible for getting the value of data member. More... | |
const char * | GetTrueTypeName () const |
Get full type description of data member, e,g.: "class TDirectory*". More... | |
const char * | GetTypeName () const |
Get type of data member, e,g.: "class TDirectory*" -> "TDirectory". More... | |
Int_t | GetUnitSize () const |
Get the sizeof the underlying type of the data member (i.e. More... | |
Bool_t | IsaPointer () const |
Return true if data member is a pointer. More... | |
Bool_t | IsBasic () const |
Return true if data member is a basic type, e.g. char, int, long... More... | |
Bool_t | IsEnum () const |
Return true if data member is an enum. More... | |
Bool_t | IsPersistent () const |
Int_t | IsSTLContainer () |
The return type is defined in TDictionary (kVector, kList, etc.) More... | |
Bool_t | IsValid () |
Return true if this data member object is pointing to a currently loaded data member. More... | |
Long_t | Property () const |
Get property description word. For meaning of bits see EProperty. More... | |
void | SetClass (TClass *cl) |
TMethodCall * | SetterMethod (TClass *cl) |
Return a TMethodCall method responsible for setting the value of data member. More... | |
virtual bool | Update (DataMemberInfo_t *info) |
Update the TFunction to reflect the new info. More... | |
![]() | |
TDictionary () | |
TDictionary (const char *name) | |
TDictionary (const TDictionary &dict) | |
virtual | ~TDictionary () |
void | CreateAttributeMap () |
TDictAttributeMap * | GetAttributeMap () const |
TDictionary & | operator= (const TDictionary &other) |
virtual Long_t | Property () const =0 |
![]() | |
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 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 | ls (Option_t *option="") const |
List TNamed name and title. More... | |
TNamed & | operator= (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... | |
![]() | |
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 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 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 TObject * | DrawClone (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 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 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_t * | GetOption () 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... | |
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. 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 | |
TDataMember (const TDataMember &) | |
copy constructor More... | |
TDataMember & | operator= (const TDataMember &) |
assignment operator More... | |
![]() | |
Bool_t | UpdateInterpreterStateMarker () |
the Cling ID of the transaction that last updated the object More... | |
![]() | |
virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
Interface to ErrorHandler (protected). More... | |
void | MakeZombie () |
Private Types | |
enum | EStatusBits { kObjIsPersistent = BIT(2) } |
Private Member Functions | |
void | Init (bool afterReading) |
Routines called by the constructor and Update to reset the member's information. More... | |
Private Attributes | |
Int_t | fArrayDim |
TString | fArrayIndex |
Int_t * | fArrayMaxIndex |
TClass * | fClass |
pointer to CINT data member info More... | |
TDataType * | fDataType |
pointer to the class More... | |
TString | fFullTypeName |
DataMemberInfo_t * | fInfo |
Long_t | fOffset |
pointer to data basic type descriptor More... | |
TList * | fOptions |
method which sets value; More... | |
Long_t | fProperty |
Int_t | fSTLCont |
TString | fTrueTypeName |
TString | fTypeName |
TMethodCall * | fValueGetter |
TMethodCall * | fValueSetter |
method that returns a value; More... | |
Additional Inherited Members | |
![]() | |
typedef const void * | DeclId_t |
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 } |
![]() | |
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 TDictionary * | GetDictionary (const char *name) |
static TDictionary * | GetDictionary (const std::type_info &typeinfo) |
![]() | |
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... | |
![]() | |
TString | fName |
TString | fTitle |
#include <TDataMember.h>
|
private |
Enumerator | |
---|---|
kObjIsPersistent |
Definition at line 34 of file TDataMember.h.
|
protected |
copy constructor
Definition at line 470 of file TDataMember.cxx.
TDataMember::TDataMember | ( | DataMemberInfo_t * | info = 0 , |
TClass * | cl = 0 |
||
) |
Default TDataMember ctor.
TDataMembers are constructed in TClass via a call to TCling::CreateListOfDataMembers(). It parses the comment string, initializes optionlist and getter/setter methods.
Definition at line 169 of file TDataMember.cxx.
|
virtual |
TDataMember dtor deletes adopted CINT DataMemberInfo object.
Definition at line 530 of file TDataMember.cxx.
Int_t TDataMember::GetArrayDim | ( | ) | const |
Return number of array dimensions.
Definition at line 545 of file TDataMember.cxx.
const char * TDataMember::GetArrayIndex | ( | ) | const |
If the data member is pointer and has a valid array size in its comments GetArrayIndex returns a string pointing to it; otherwise it returns an empty string.
Definition at line 567 of file TDataMember.cxx.
|
inline |
Definition at line 73 of file TDataMember.h.
|
inline |
Definition at line 74 of file TDataMember.h.
TDictionary::DeclId_t TDataMember::GetDeclId | ( | ) | const |
Definition at line 582 of file TDataMember.cxx.
const char * TDataMember::GetFullTypeName | ( | ) | const |
Get full type description of data member, e,g.: "class TDirectory*".
Definition at line 613 of file TDataMember.cxx.
Return maximum index for array dimension "dim".
Definition at line 591 of file TDataMember.cxx.
Long_t TDataMember::GetOffset | ( | ) | const |
Get offset from "this".
Definition at line 631 of file TDataMember.cxx.
Long_t TDataMember::GetOffsetCint | ( | ) | const |
Get offset from "this" using the information in CINT only.
Definition at line 680 of file TDataMember.cxx.
TList * TDataMember::GetOptions | ( | ) | const |
Returns list of options - list of TOptionListItems.
Definition at line 801 of file TDataMember.cxx.
TMethodCall * TDataMember::GetterMethod | ( | TClass * | cl = 0 | ) |
Return a TMethodCall method responsible for getting the value of data member.
The cl argument specifies the class of the object which will be used to call this method (in case of multiple inheritance TMethodCall needs to know this to calculate the proper offset).
Definition at line 813 of file TDataMember.cxx.
const char * TDataMember::GetTrueTypeName | ( | ) | const |
Get full type description of data member, e,g.: "class TDirectory*".
Definition at line 623 of file TDataMember.cxx.
const char * TDataMember::GetTypeName | ( | ) | const |
Get type of data member, e,g.: "class TDirectory*" -> "TDirectory".
Definition at line 604 of file TDataMember.cxx.
Int_t TDataMember::GetUnitSize | ( | ) | const |
Get the sizeof the underlying type of the data member (i.e.
if the member is an array sizeof(member)/length)
Definition at line 695 of file TDataMember.cxx.
|
private |
Routines called by the constructor and Update to reset the member's information.
afterReading is set when initializing after reading through Streamer().
Definition at line 192 of file TDataMember.cxx.
Bool_t TDataMember::IsaPointer | ( | ) | const |
Return true if data member is a pointer.
Definition at line 730 of file TDataMember.cxx.
Bool_t TDataMember::IsBasic | ( | ) | const |
Return true if data member is a basic type, e.g. char, int, long...
Definition at line 712 of file TDataMember.cxx.
Bool_t TDataMember::IsEnum | ( | ) | const |
Return true if data member is an enum.
Definition at line 721 of file TDataMember.cxx.
|
inline |
Definition at line 89 of file TDataMember.h.
int TDataMember::IsSTLContainer | ( | ) |
The return type is defined in TDictionary (kVector, kList, etc.)
Definition at line 739 of file TDataMember.cxx.
Bool_t TDataMember::IsValid | ( | ) |
Return true if this data member object is pointing to a currently loaded data member.
If a function is unloaded after the TDataMember is created, the TDataMember will be set to be invalid.
Definition at line 752 of file TDataMember.cxx.
|
protected |
assignment operator
Definition at line 495 of file TDataMember.cxx.
|
virtual |
Get property description word. For meaning of bits see EProperty.
Implements TDictionary.
Definition at line 776 of file TDataMember.cxx.
Definition at line 93 of file TDataMember.h.
TMethodCall * TDataMember::SetterMethod | ( | TClass * | cl | ) |
Return a TMethodCall method responsible for setting the value of data member.
The cl argument specifies the class of the object which will be used to call this method (in case of multiple inheritance TMethodCall needs to know this to calculate the proper offset).
Definition at line 857 of file TDataMember.cxx.
|
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).
Definition at line 900 of file TDataMember.cxx.
|
private |
Definition at line 45 of file TDataMember.h.
|
private |
Definition at line 47 of file TDataMember.h.
|
private |
Definition at line 46 of file TDataMember.h.
|
private |
pointer to CINT data member info
Definition at line 39 of file TDataMember.h.
|
private |
pointer to the class
Definition at line 40 of file TDataMember.h.
|
private |
Definition at line 50 of file TDataMember.h.
|
private |
Definition at line 38 of file TDataMember.h.
|
private |
pointer to data basic type descriptor
Definition at line 42 of file TDataMember.h.
|
private |
method which sets value;
Definition at line 58 of file TDataMember.h.
|
private |
Definition at line 44 of file TDataMember.h.
|
private |
Definition at line 43 of file TDataMember.h.
|
private |
Definition at line 51 of file TDataMember.h.
|
private |
Definition at line 49 of file TDataMember.h.
|
private |
Definition at line 56 of file TDataMember.h.
|
private |
method that returns a value;
Definition at line 57 of file TDataMember.h.