Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RooRefCountList Class Reference

A RooRefCountList is a RooLinkedList that keeps a reference counter with each added node.

Multiple Add()s of the same object will increase the counter instead of adding multiple copies. Remove() decrements the reference count until zero, when the object is actually removed.

Definition at line 21 of file RooRefCountList.h.

Public Member Functions

 RooRefCountList ()
 Default constructor construct lists with initial hash table size of 17.
 
virtual ~RooRefCountList ()
 
virtual void Add (TObject *arg)
 
virtual void Add (TObject *obj, Int_t count)
 Add object to list with given reference count increment List takes ownership of object.
 
Int_t refCount (TObject *obj) const
 Return reference count associated with 'obj'.
 
virtual Bool_t Remove (TObject *obj)
 Remove object from list and if reference count reaches zero delete object itself as well.
 
virtual Bool_t RemoveAll (TObject *obj)
 Remove object from list and delete object itself regardless of reference count.
 
- Public Member Functions inherited from RooLinkedList
 RooLinkedList (const RooLinkedList &other)
 Copy constructor.
 
 RooLinkedList (Int_t htsize=0)
 
virtual ~RooLinkedList ()
 Destructor.
 
TObjectAt (int index) const
 Return object stored in sequential position given by index.
 
RooLinkedListIterImpl begin () const
 
void Clear (Option_t *o=0)
 Remove all elements from collection.
 
virtual TObjectClone (const char *=0) const
 Make a clone of an object using the Streamer facility.
 
void Delete (Option_t *o=0)
 Remove all elements in collection and delete all elements NB: Collection does not own elements, this function should be used judiciously by caller.
 
bool empty () const
 
RooLinkedListIterImpl end () const
 
TObjectfind (const char *name) const
 Return pointer to object with given name in collection.
 
RooAbsArgfindArg (const RooAbsArg *) const
 Return pointer to object with given name in collection.
 
TObjectFindObject (const char *name) const
 Return pointer to obejct with given name.
 
TObjectFindObject (const TObject *obj) const
 Find object in list.
 
TObjectFirst () const
 
RooFIter fwdIterator () const
 Create a one-time-use forward iterator for this list.
 
Int_t getHashTableSize () const
 
const char * GetName () const
 Returns name of object.
 
Int_t GetSize () const
 
ULong_t Hash () const
 Return hash value for this object.
 
Int_t IndexOf (const char *name) const
 Return position of given object in list.
 
Int_t IndexOf (const TObject *arg) const
 Return position of given object in list.
 
RooLinkedListIter iterator (Bool_t forward=kTRUE) const
 Create an iterator for this list.
 
TIteratorMakeIterator (Bool_t forward=kTRUE) const
 Create a TIterator for this list.
 
RooLinkedListoperator= (const RooLinkedList &other)
 Assignment operator, copy contents from 'other'.
 
void Print (const char *opt) const
 Print contents of list, defers to Print() function of contained objects.
 
RooLinkedListIterImpl rbegin () const
 
virtual void RecursiveRemove (TObject *obj)
 If one of the TObject we have a referenced to is deleted, remove the reference.
 
RooLinkedListIterImpl rend () const
 
Bool_t Replace (const TObject *oldArg, const TObject *newArg)
 Replace object 'oldArg' in collection with new object 'newArg'.
 
void setHashTableSize (Int_t size)
 Change the threshold for hash-table use to given size.
 
void SetName (const char *name)
 
std::size_t size () const
 
void Sort (Bool_t ascend=kTRUE)
 
void useNptr (Bool_t flag)
 
- 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 Int_t Compare (const TObject *obj) const
 Compare abstract method.
 
virtual void Copy (TObject &object) const
 Copy this to obj.
 
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 for instance with: gROOT->SetSelectedPad(gPad).
 
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=0)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 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 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 const char * GetTitle () const
 Returns title of object.
 
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
 
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.
 
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.
 
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 [].
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator 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.
 
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.
 
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=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Additional Inherited Members

- 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)
}
 
- Static Public Member Functions inherited from TObject
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 Types inherited from RooLinkedList
using HashTableByLink = std::unordered_map< TObject const *, TObject const * >
 
using HashTableByName = std::unordered_map< std::string, TObject const * >
 Link to last element of list.
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = BIT(3) }
 
- Protected Member Functions inherited from RooLinkedList
RooLinkedListElemcreateElement (TObject *obj, RooLinkedListElem *elem=0)
 cout << "RooLinkedList::createElem(" << this << ") obj = " << obj << " elem = " << elem << endl ;
 
void deleteElement (RooLinkedListElem *)
 
RooLinkedListElemfindLink (const TObject *arg) const
 Find the element link containing the given 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 ()
 
- Protected Attributes inherited from RooLinkedList
RooLinkedListElem_first
 
Int_t _hashThresh
 
std::unique_ptr< HashTableByLink_htableLink
 Hash table by name.
 
std::unique_ptr< HashTableByName_htableName
 
RooLinkedListElem_last
 Link to first element of list.
 
TString _name
 Hash table by link pointer.
 
Int_t _size
 
Bool_t _useNptr
 

#include <RooRefCountList.h>

Inheritance diagram for RooRefCountList:
[legend]

Constructor & Destructor Documentation

◆ RooRefCountList()

RooRefCountList::RooRefCountList ( )

Default constructor construct lists with initial hash table size of 17.

Definition at line 45 of file RooRefCountList.cxx.

◆ ~RooRefCountList()

virtual RooRefCountList::~RooRefCountList ( )
inlinevirtual

Definition at line 24 of file RooRefCountList.h.

Member Function Documentation

◆ Add() [1/2]

virtual void RooRefCountList::Add ( TObject arg)
inlinevirtual

Reimplemented from RooLinkedList.

Definition at line 26 of file RooRefCountList.h.

◆ Add() [2/2]

void RooRefCountList::Add ( TObject obj,
Int_t  count 
)
virtual

Add object to list with given reference count increment List takes ownership of object.

Reimplemented from RooLinkedList.

Definition at line 56 of file RooRefCountList.cxx.

◆ refCount()

Int_t RooRefCountList::refCount ( TObject obj) const

Return reference count associated with 'obj'.

Definition at line 111 of file RooRefCountList.cxx.

◆ Remove()

Bool_t RooRefCountList::Remove ( TObject obj)
virtual

Remove object from list and if reference count reaches zero delete object itself as well.

Reimplemented from RooLinkedList.

Definition at line 80 of file RooRefCountList.cxx.

◆ RemoveAll()

Bool_t RooRefCountList::RemoveAll ( TObject obj)
virtual

Remove object from list and delete object itself regardless of reference count.

Definition at line 101 of file RooRefCountList.cxx.

Libraries for RooRefCountList:

The documentation for this class was generated from the following files: