Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TDictionary Class Referenceabstract

This class defines an abstract interface that must be implemented by all classes that contain dictionary information.

The dictionary is defined by the following classes:

TDataType (typedef definitions)
TGlobal (global variables)
TGlobalFunc (global functions)
TClass (classes)
TBaseClass (base classes)
TDataMember (class datamembers)
TMethod (class methods)
TMethodArg (method arguments)
Each class (see TClass) has a linked list of its base class(es).
Definition TBaseClass.h:33
TClass instances represent classes, structs and namespaces in the ROOT type system.
Definition TClass.h:81
All ROOT classes may have RTTI (run time type identification) support added.
Definition TDataMember.h:31
Basic data type descriptor (datatype information is obtained from CINT).
Definition TDataType.h:44
Global variables class (global variables are obtained from CINT).
Definition TGlobal.h:28
Each ROOT method (see TMethod) has a linked list of its arguments.
Definition TMethodArg.h:36
Each ROOT class (see TClass) has a linked list of methods.
Definition TMethod.h:38

All the above classes implement the TDictionary abstract interface. Note: the indentation shows aggregation not inheritance.

TMethodCall (method call environment)
Method or function calling interface.
Definition TMethodCall.h:37

Definition at line 168 of file TDictionary.h.

Public Types

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

Public Member Functions

 TDictionary ()
 
 TDictionary (const char *name)
 
 TDictionary (const TDictionary &dict)
 
virtual ~TDictionary ()
 
void CreateAttributeMap ()
 
TDictAttributeMapGetAttributeMap () const
 
TClassIsA () const override
 
TDictionaryoperator= (const TDictionary &other)
 
virtual Long_t Property () const =0
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
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 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

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

Private Attributes

TDictAttributeMapfAttributeMap {nullptr}
 
ULong64_t fUpdatingTransactionCount {0}
 

Additional Inherited Members

- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <TDictionary.h>

Inheritance diagram for TDictionary:
[legend]

Member Typedef Documentation

◆ DeclId_t

typedef const void* TDictionary::DeclId_t

Definition at line 224 of file TDictionary.h.

Member Enumeration Documentation

◆ EMemberSelection

enum class TDictionary::EMemberSelection
strong

Kinds of members to include in lists.

Enumerator
kNoUsingDecls 
kOnlyUsingDecls 
kAlsoUsingDecls 

Definition at line 216 of file TDictionary.h.

◆ ESTLType

Enumerator
kNone 
kVector 
kList 
kForwardlist 
kDeque 
kMap 
kMultimap 
kSet 
kMultiset 
kUnorderedSet 
kUnorderedMultiset 
kUnorderedMap 
kUnorderedMultimap 
kBitset 

Definition at line 198 of file TDictionary.h.

Constructor & Destructor Documentation

◆ TDictionary() [1/3]

TDictionary::TDictionary ( )
inline

Definition at line 178 of file TDictionary.h.

◆ TDictionary() [2/3]

TDictionary::TDictionary ( const char *  name)
inline

Definition at line 179 of file TDictionary.h.

◆ TDictionary() [3/3]

TDictionary::TDictionary ( const TDictionary dict)

Definition at line 48 of file TDictionary.cxx.

◆ ~TDictionary()

TDictionary::~TDictionary ( )
virtual

Definition at line 57 of file TDictionary.cxx.

Member Function Documentation

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 225 of file TDictionary.h.

◆ CreateAttributeMap()

void TDictionary::CreateAttributeMap ( )

Definition at line 76 of file TDictionary.cxx.

◆ DeclFileName()

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

Definition at line 225 of file TDictionary.h.

◆ GetAttributeMap()

TDictAttributeMap * TDictionary::GetAttributeMap ( ) const
inline

Definition at line 186 of file TDictionary.h.

◆ GetDictionary() [1/2]

TDictionary * TDictionary::GetDictionary ( const char *  name)
static

Retrieve the type (class, fundamental type, typedef etc) named "name".

Returned object is either a TClass or TDataType. Returns nullptr if the type is unknown.

Definition at line 90 of file TDictionary.cxx.

◆ GetDictionary() [2/2]

TDictionary * TDictionary::GetDictionary ( const std::type_info &  typeinfo)
static

Definition at line 110 of file TDictionary.cxx.

◆ IsA()

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

Reimplemented from TObject.

Reimplemented in TQClass, TEnum, TEnumConstant, TFunction, TFunctionTemplate, TGlobal, TMethod, and TMethodArg.

Definition at line 225 of file TDictionary.h.

◆ operator=()

TDictionary & TDictionary::operator= ( const TDictionary other)

Definition at line 63 of file TDictionary.cxx.

◆ Property()

virtual Long_t TDictionary::Property ( ) const
pure virtual

◆ Streamer()

void TDictionary::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

Reimplemented in TQClass, TEnum, TEnumConstant, TFunction, TFunctionTemplate, TGlobal, TMethod, and TMethodArg.

◆ StreamerNVirtual()

void TDictionary::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 225 of file TDictionary.h.

◆ UpdateInterpreterStateMarker()

Bool_t TDictionary::UpdateInterpreterStateMarker ( )
protected

the Cling ID of the transaction that last updated the object

Definition at line 124 of file TDictionary.cxx.

◆ WantsRegularMembers()

static bool TDictionary::WantsRegularMembers ( EMemberSelection  sel)
inlinestatic

Definition at line 221 of file TDictionary.h.

◆ WantsUsingDecls()

static bool TDictionary::WantsUsingDecls ( EMemberSelection  sel)
inlinestatic

Definition at line 222 of file TDictionary.h.

Member Data Documentation

◆ fAttributeMap

TDictAttributeMap* TDictionary::fAttributeMap {nullptr}
private

Definition at line 171 of file TDictionary.h.

◆ fUpdatingTransactionCount

ULong64_t TDictionary::fUpdatingTransactionCount {0}
private

Definition at line 172 of file TDictionary.h.

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