TMap implements an associative array of (key,value) pairs using a THashTable for efficient retrieval (therefore TMap does not conserve the order of the entries).
The hash value is calculated using the value returned by the keys Hash() function and the key comparison is done via the IsEqual() function. Both key and value must inherit from TObject.
Public Types | |
typedef TMapIter | Iterator_t |
Public Types inherited from TCollection | |
enum | { kInitCapacity = 16 , kInitHashTableCapacity = 17 } |
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) } |
Public Member Functions | |
TMap (Int_t capacity=TCollection::kInitHashTableCapacity, Int_t rehash=0) | |
TMap ctor. See THashTable for a description of the arguments. More... | |
virtual | ~TMap () |
TMap dtor. More... | |
void | Add (TObject *key, TObject *value) |
Add a (key,value) pair to the map. More... | |
void | Add (TObject *obj) |
This function may not be used (but we need to provide it since it is a pure virtual in TCollection). More... | |
Float_t | AverageCollisions () const |
Return the ratio of entries vs occupied slots. More... | |
Int_t | Capacity () const |
Return number of slots in the hashtable. More... | |
void | Clear (Option_t *option="") |
Remove all (key,value) pairs from the map. More... | |
Int_t | Collisions (const char *keyname) const |
Returns the number of collisions for a key with a certain name (i.e. More... | |
Int_t | Collisions (TObject *key) const |
Returns the number of collisions for a key (i.e. More... | |
void | Delete (Option_t *option="") |
Remove all (key,value) pairs from the map AND delete the keys when they are allocated on the heap. More... | |
void | DeleteAll () |
Remove all (key,value) pairs from the map AND delete the keys AND values when they are allocated on the heap. More... | |
Bool_t | DeleteEntry (TObject *key) |
Remove (key,value) pair with key from the map. More... | |
void | DeleteKeys () |
void | DeleteValues () |
Remove all (key,value) pairs from the map AND delete the values when they are allocated on the heap. More... | |
TObject * | FindObject (const char *keyname) const |
Check if a (key,value) pair exists with keyname as name of the key. More... | |
TObject * | FindObject (const TObject *key) const |
Check if a (key,value) pair exists with key as key. More... | |
TObject ** | GetObjectRef (const TObject *obj) const |
const THashTable * | GetTable () const |
TObject * | GetValue (const char *keyname) const |
Returns a pointer to the value associated with keyname as name of the key. More... | |
TObject * | GetValue (const TObject *key) const |
Returns a pointer to the value associated with key. More... | |
Bool_t | IsOwnerValue () const |
TIterator * | MakeIterator (Bool_t dir=kIterForward) const |
Create an iterator for TMap. More... | |
TObject * | operator() (const char *keyname) const |
TObject * | operator() (const TObject *key) const |
void | Rehash (Int_t newCapacity, Bool_t checkObjValidity=kTRUE) |
Rehash the underlaying THashTable (see THashTable::Rehash()). More... | |
TObject * | Remove (TObject *key) |
Remove the (key,value) pair with key from the map. More... | |
TPair * | RemoveEntry (TObject *key) |
Remove (key,value) pair with key from the map. More... | |
virtual void | SetOwnerKeyValue (Bool_t ownkeys=kTRUE, Bool_t ownvals=kTRUE) |
Set ownership for keys and values. More... | |
virtual void | SetOwnerValue (Bool_t enable=kTRUE) |
Set whether this map is the owner (enable==true) of its values. More... | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) |
Write all objects in this map. More... | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const |
Write all objects in this map. More... | |
Public Member Functions inherited from TCollection | |
virtual | ~TCollection () |
TNamed destructor. More... | |
virtual void | Add (TObject *obj)=0 |
virtual void | AddAll (const TCollection *col) |
Add all objects from collection col to this collection. More... | |
void | AddVector (TObject *obj1,...) |
Add all arguments to the collection. More... | |
Bool_t | AssertClass (TClass *cl) const |
Make sure all objects in this collection inherit from class cl. More... | |
TIter | begin () const |
void | Browse (TBrowser *b) |
Browse this collection (called by TBrowser). More... | |
Int_t | Capacity () const |
virtual void | Clear (Option_t *option="")=0 |
virtual TObject * | Clone (const char *newname="") const |
Make a clone of an collection using the Streamer facility. More... | |
Int_t | Compare (const TObject *obj) const |
Compare two TCollection objects. More... | |
Bool_t | Contains (const char *name) const |
Bool_t | Contains (const TObject *obj) const |
virtual void | Delete (Option_t *option="")=0 |
Delete this object. More... | |
virtual void | Draw (Option_t *option="") |
Draw all objects in this collection. More... | |
virtual void | Dump () const |
Dump all objects in this collection. More... | |
TIter | end () const |
virtual TObject * | FindObject (const char *name) const |
Find an object in this collection using its name. More... | |
virtual TObject * | FindObject (const TObject *obj) const |
Find an object in this collection using the object's IsEqual() member function. More... | |
virtual Int_t | GetEntries () const |
virtual const char * | GetName () const |
Return name of this collection. More... | |
virtual TObject ** | GetObjectRef (const TObject *obj) const =0 |
virtual Int_t | GetSize () const |
Return the capacity of the collection, i.e. More... | |
virtual Int_t | GrowBy (Int_t delta) const |
Increase the collection's capacity by delta slots. More... | |
ULong_t | Hash () const |
Return hash value for this object. More... | |
Bool_t | IsArgNull (const char *where, const TObject *obj) const |
Returns true if object is a null pointer. More... | |
virtual Bool_t | IsEmpty () const |
virtual Bool_t | IsFolder () const |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More... | |
Bool_t | IsOwner () const |
Bool_t | IsSortable () const |
R__ALWAYS_INLINE Bool_t | IsUsingRWLock () const |
virtual void | ls (Option_t *option="") const |
List (ls) all objects in this collection. More... | |
virtual TIterator * | MakeIterator (Bool_t dir=kIterForward) const =0 |
virtual TIterator * | MakeReverseIterator () const |
virtual Bool_t | Notify () |
'Notify' all objects in this collection. More... | |
TObject * | operator() (const char *name) const |
Find an object in this collection by name. More... | |
virtual void | Paint (Option_t *option="") |
Paint all objects in this collection. More... | |
virtual void | Print (Option_t *option, const char *wildcard, Int_t recurse=1) const |
Print the collection header and its elements that match the wildcard. More... | |
virtual void | Print (Option_t *option, Int_t recurse) const |
Print the collection header and its elements. More... | |
virtual void | Print (Option_t *option, TPRegexp ®exp, Int_t recurse=1) const |
Print the collection header and its elements that match the regexp. More... | |
virtual void | Print (Option_t *option="") const |
Default print for collections, calls Print(option, 1). More... | |
virtual void | RecursiveRemove (TObject *obj) |
Remove object from this collection and recursively remove the object from all other objects (and collections). More... | |
virtual TObject * | Remove (TObject *obj)=0 |
void | RemoveAll () |
virtual void | RemoveAll (TCollection *col) |
Remove all objects in collection col from this collection. More... | |
void | SetCurrentCollection () |
Set this collection to be the globally accesible collection. More... | |
void | SetName (const char *name) |
virtual void | SetOwner (Bool_t enable=kTRUE) |
Set whether this collection is the owner (enable==true) of its content. More... | |
virtual bool | UseRWLock () |
Set this collection to use a RW lock upon access, making it thread safe. More... | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) |
Write all objects in this collection. More... | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const |
Write all objects in this collection. 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 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 Types | |
enum | EStatusBits { kIsOwnerValue = BIT(15) } |
Protected Types inherited from TCollection | |
enum | EStatusBits { kIsOwner = BIT(14) , kUseRWLock = BIT(16) } |
Protected Member Functions | |
virtual void | PrintCollectionEntry (TObject *entry, Option_t *option, Int_t recurse) const |
Print the collection entry. More... | |
Protected Member Functions inherited from TCollection | |
TCollection () | |
virtual const char * | GetCollectionEntryName (TObject *entry) const |
For given collection entry return the string that is used to identify the object and, potentially, perform wildcard/regexp filtering on. More... | |
virtual void | PrintCollectionEntry (TObject *entry, Option_t *option, Int_t recurse) const |
Print the collection entry. More... | |
virtual void | PrintCollectionHeader (Option_t *option) const |
Print the collection header. 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 () |
Private Member Functions | |
TMap (const TMap &map) | |
TMap & | operator= (const TMap &map) |
Private Attributes | |
THashTable * | fTable |
Friends | |
class | TMapIter |
Additional Inherited Members | |
Static Public Member Functions inherited from TCollection | |
static void | EmptyGarbageCollection () |
Do the garbage collection. More... | |
static void | GarbageCollect (TObject *obj) |
Add to the list of things to be cleaned up. More... | |
static TCollection * | GetCurrentCollection () |
Return the globally accessible collection. More... | |
static void | StartGarbageCollection () |
Set up for garbage collection. More... | |
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 Attributes inherited from TCollection | |
TString | fName |
Int_t | fSize |
#include <TMap.h>
typedef TMapIter TMap::Iterator_t |
|
protected |
|
private |
TMap::TMap | ( | Int_t | capacity = TCollection::kInitHashTableCapacity , |
Int_t | rehash = 0 |
||
) |
TMap ctor. See THashTable for a description of the arguments.
|
virtual |
TMap dtor.
Objects are not deleted unless the TMap is the owner (set via SetOwner()).
This function may not be used (but we need to provide it since it is a pure virtual in TCollection).
Use Add(key,value) instead.
Implements TCollection.
Float_t TMap::AverageCollisions | ( | ) | const |
Int_t TMap::Capacity | ( | ) | const |
Remove all (key,value) pairs from the map.
The keys/values are deleted depending on the state of key-ownership (SetOwner()) and value-ownership (SetOwnerValue()).
To delete these objects regardless of the ownership state use:
Implements TCollection.
Int_t TMap::Collisions | ( | const char * | keyname | ) | const |
Remove all (key,value) pairs from the map AND delete the keys when they are allocated on the heap.
Implements TCollection.
void TMap::DeleteAll | ( | ) |
void TMap::DeleteValues | ( | ) |
|
virtual |
Check if a (key,value) pair exists with keyname as name of the key.
Returns a TPair* (need to downcast from TObject). Use Key() and Value() to get the pointers to the key and value, respectively. Returns 0 if not found.
Reimplemented from TCollection.
Check if a (key,value) pair exists with key as key.
Returns a TPair* (need to downcast from TObject). Use Key() and Value() to get the pointers to the key and value, respectively. Returns 0 if not found.
Reimplemented from TCollection.
Implements TCollection.
|
inline |
TObject * TMap::GetValue | ( | const char * | keyname | ) | const |
|
virtual |
|
inline |
|
protectedvirtual |
Print the collection entry.
Reimplemented from TCollection.
Rehash the underlaying THashTable (see THashTable::Rehash()).
Remove the (key,value) pair with key from the map.
Returns the key object or 0 in case key was not found. If map is the owner of values, the value is deleted.
Implements TCollection.
Set whether this map is the owner (enable==true) of its values.
If it is the owner of its contents, these objects will be deleted whenever the collection itself is deleted. The objects might also be deleted or destructed when Clear is called (depending on the collection).
Write all objects in this map.
By default all objects in the collection are written individually (each object gets its own key). Note, this is recursive, i.e. objects in collections in the collection are also written individually. To write all objects using a single key specify a name and set option to TObject::kSingleKey (i.e. 1).
Reimplemented from TCollection.
Write all objects in this map.
By default all objects in the collection are written individually (each object gets its own key). Note, this is recursive, i.e. objects in collections in the collection are also written individually. To write all objects using a single key specify a name and set option to TObject::kSingleKey (i.e. 1).
Reimplemented from TCollection.
|
private |