Detailed Description

Optimised list in which named objects can only be placed once.

Created by KVClassFactory on Thu Dec 3 15:49:33 2009 Author: John Frankland,,,

Use this list when you need to check as each object is added that it is not already in the list (assuming that objects are the same if they have the same name), in order to avoid the same object being added several times.

Using a standard TList or KVList, implementing such a check can become very time-consuming as the list becomes longer, because for each new object we add we have to perform a sequential scan of all objects in the list and check the name of each one. However, using a KVHashList based on object names, the number of objects to check is kept small, even as the list becomes very long, thanks to automatic rehashing of the list.

By default, if an object with the same name is already in the list, the 'new' object is not added (no warning, no error).

If option 'replace' is used, then adding an object with the same name as an existing object will replace the previous object with the new one.

In addition, if the list owns its objects and 'replace' is used, the previous object will be deleted as well as being replaced.

After calling Add(TObject*), you can call method ObjectAdded() to know if the object was effectively added to the list or not.

EXAMPLES

TNamed* a = new TNamed("A1", "an object");
TNamed* b = new TNamed("B1", "another object");
TNamed* c = a;
TNamed* d = new TNamed("A1", "an object with the same name as another");
 
=== Example 0 - normal TList
 
TList aList;
aList.Add(a);
aList.Add(b);
aList.Add(c);
aList.Add(d);
aList.ls();
OBJ: TList  TList Doubly linked list : 0
 OBJ: TNamed   A1 an object : 0 at: 0x6c21770
 OBJ: TNamed   B1 another object : 0 at: 0x6c0fc40
 OBJ: TNamed   A1 an object : 0 at: 0x6c21770
 OBJ: TNamed   A1 an object with the same name as another : 0 at: 0x6c0acf0
 
=== Example 1 - unique name list, no replace
 
KVUniqueNameList UNlist1;
UNlist1.Add(a);
UNlist1.Add(b);
UNlist1.Add(c);
UNlist1.Add(d);
UNlist1.ls();
OBJ: KVUniqueNameList   KVUniqueNameList  Optimised list in which objects can only be placed once : 0
 OBJ: TNamed   A1 an object : 0 at: 0x6c21770
 OBJ: TNamed   B1 another object : 0 at: 0x6c0fc40//
 
=== Example 2 - unique name list, with replace
 
KVUniqueNameList UNlist2(kTRUE);
UNlist2.Add(a);
UNlist2.Add(b);
UNlist2.Add(c);
UNlist2.Add(d);
UNlist2.ls();
OBJ: KVUniqueNameList   KVUniqueNameList  Optimised list in which objects can only be placed once : 0
 OBJ: TNamed   B1 another object : 0 at: 0x6c0fc40
 OBJ: TNamed   A1 an object with the same name as another : 0 at: 0x6c0acf0
 
=== Example 3 - unique name list which owns its objects, with replace
 
KVUniqueNameList UNlist3(kTRUE);
UNlist3.Add(a);
UNlist3.Add(b);
UNlist3.Add(d);
UNlist3.ls();
OBJ: KVUniqueNameList   KVUniqueNameList  Optimised list in which objects can only be placed once : 0
 OBJ: TNamed   B1 another object : 0 at: 0x6c0fc40
 OBJ: TNamed   A1 an object with the same name as another : 0 at: 0x6c0acf0
 
a->ls();
 
     Break *** segmentation violation  (1st object "A1" has been deleted)

N.B.: in the last example we do NOT do UNlist3.Add(c) which would have deleted the object pointed to by both a and c, and then tried to add this deleted object back in to the list

Definition at line 101 of file KVUniqueNameList.h.

#include <KVUniqueNameList.h>

Inheritance diagram for KVUniqueNameList:

[legend]

Public Member Functions
	KVUniqueNameList (Bool_t R=kFALSE)
	Default constructor. More...

virtual	~KVUniqueNameList ()
	Destructor. More...

virtual void	Add (TObject *obj)

virtual void	AddAfter (const TObject after, TObject obj)

virtual void	AddAt (TObject *obj, Int_t idx)

virtual void	AddBefore (const TObject before, TObject obj)

virtual void	AddFirst (TObject *obj)

virtual void	AddLast (TObject *obj)

Bool_t	ObjectAdded () const

void	ReplaceObjects (Bool_t yes=kTRUE)

Public Member Functions inherited from KVHashList
	KVHashList (Int_t capacity=TCollection::kInitHashTableCapacity, Int_t rehash=2)

virtual	~KVHashList ()
	Destructor. More...

Float_t	AverageCollisions () const

template<typename T >
Bool_t	ContainsObjectWithName (const T &o)

const TList *	GetListForObject (const char *name) const

const TList *	GetListForObject (const TObject *obj) const

void	Rehash (Int_t newCapacity=0)

void	Sort (Bool_t order=kSortAscending)

Public Member Functions inherited from KVSeqCollection
	KVSeqCollection ()
	Default constructor. More...

	KVSeqCollection (const Char_t *collection_classname)

	KVSeqCollection (const KVSeqCollection &)

virtual	~KVSeqCollection ()

virtual TObject *	After (const TObject *obj) const

virtual TObject *	At (Int_t idx) const

virtual TObject *	Before (const TObject *obj) const

virtual void	Clear (Option_t *option="")

const Char_t *	CollectionClassName () const

virtual void	Copy (TObject &obj) const

virtual void	Delete (Option_t *option="")

virtual void	Execute (const char method, const char params, Int_t *error=0)

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)

virtual TObject *	FindObject (const char *name) const

virtual TObject *	FindObject (const TObject *obj) const

virtual TObject *	FindObjectAny (const Char_t att, const Char_t keys, Bool_t contains_all=kFALSE, Bool_t case_sensitive=kTRUE) const

TObject *	FindObjectByClass (const Char_t *) const
	Return (first) object in embedded list with given class. More...

TObject *	FindObjectByClass (const TClass *) const
	Return (first) object in embedded list with given class. More...

virtual TObject *	FindObjectByLabel (const Char_t *) const

virtual TObject *	FindObjectByName (const Char_t *name) const

virtual TObject *	FindObjectByNumber (UInt_t num) const

virtual TObject *	FindObjectByTitle (const Char_t *) const
	Will return object with given title (value of TObject::GetTitle() method). More...

virtual TObject *	FindObjectByType (const Char_t *) const

virtual TObject *	FindObjectWithMethod (const Char_t retvalue, const Char_t method) const

virtual TObject *	FindObjectWithNameAndType (const Char_t name, const Char_t type) const

virtual TObject *	First () const

template<typename T >
T *	get_object (const TString &name) const

TSeqCollection *	GetCollection () const

virtual TObject **	GetObjectRef (const TObject *obj) const
	Return reference to object. More...

virtual Int_t	GetSize () const

KVSeqCollection *	GetSubListWithClass (const Char_t *class_name) const

KVSeqCollection *	GetSubListWithClass (const TClass *_class) const

KVSeqCollection *	GetSubListWithLabel (const Char_t *retvalue) const

KVSeqCollection *	GetSubListWithMethod (const Char_t retvalue, const Char_t method) const

KVSeqCollection *	GetSubListWithName (const Char_t *retvalue) const

KVSeqCollection *	GetSubListWithType (const Char_t *retvalue) const

virtual Bool_t	IsCleanup () const

virtual Bool_t	IsSendingModifiedSignals () const

virtual Bool_t	IsSortable () const

virtual Bool_t	IsSorted () const

virtual TObject *	Last () const

virtual TIterator *	MakeIterator (Bool_t dir=kIterForward) const
	Make and return iterator for the list. More...

virtual void	Modified ()

KVSeqCollection &	operator= (const KVSeqCollection &)

virtual void	RecursiveRemove (TObject *obj)

virtual TObject *	Remove (TObject *obj)
	Remove object from list. More...

virtual void	SendModifiedSignals (Bool_t yes=kTRUE)

virtual void	SetCleanup (Bool_t enable=kTRUE)

virtual void	SetOwner (Bool_t enable=kTRUE)

Private Member Functions
Bool_t	checkObjInList (TObject *obj)

Private Attributes
Bool_t	fLastCheck
	return value of last call to checkobj More...

Bool_t	fReplace
	if kTRUE, objects with same name are replaced More...

Additional Inherited Members
Static Public Member Functions inherited from KVSeqCollection
static KVSeqCollection *	MakeListFromFile (TFile *file)

static KVSeqCollection *	MakeListFromFileWithClass (TFile file, const Char_t class_name)

static KVSeqCollection *	MakeListFromFileWithClass (TFile file, const TClass _class)

static KVSeqCollection *	MakeListFromFileWithMethod (TFile file, const Char_t retvalue, const Char_t *method)

static void	RehashCleanupList ()

Constructor & Destructor Documentation

◆ KVUniqueNameList()

KVUniqueNameList::KVUniqueNameList ( Bool_t R = kFALSE )

Default constructor.

Definition at line 14 of file KVUniqueNameList.cpp.

◆ ~KVUniqueNameList()

KVUniqueNameList::~KVUniqueNameList ( )

virtual

Destructor.

Definition at line 25 of file KVUniqueNameList.cpp.

Member Function Documentation

◆ Add()

virtual void KVUniqueNameList::Add ( TObject * obj )

inlinevirtual

Add an object to the list if it is not already in it (no object with same name in list)

Reimplemented from KVSeqCollection.

Reimplemented in KVGVList, and KVPartitionList.

Definition at line 145 of file KVUniqueNameList.h.

◆ AddAfter()

virtual void KVUniqueNameList::AddAfter	(	const TObject *	after,
		TObject *	obj
	)

inlinevirtual

Add an object to the list if it is not already in it (no object with same name in list)

Reimplemented from KVSeqCollection.

Reimplemented in KVPartitionList.

Definition at line 131 of file KVUniqueNameList.h.

◆ AddAt()

virtual void KVUniqueNameList::AddAt	(	TObject *	obj,
		Int_t	idx
	)

inlinevirtual

Add an object to the list if it is not already in it (no object with same name in list)

Reimplemented from KVSeqCollection.

Reimplemented in KVPartitionList.

Definition at line 124 of file KVUniqueNameList.h.

◆ AddBefore()

virtual void KVUniqueNameList::AddBefore	(	const TObject *	before,
		TObject *	obj
	)

inlinevirtual

Add an object to the list if it is not already in it (no object with same name in list)

Reimplemented from KVSeqCollection.

Reimplemented in KVPartitionList.

Definition at line 138 of file KVUniqueNameList.h.

◆ AddFirst()

virtual void KVUniqueNameList::AddFirst ( TObject * obj )

inlinevirtual

Add an object to the list if it is not already in it (no object with same name in list)

Reimplemented from KVSeqCollection.

Reimplemented in KVGVList, and KVPartitionList.

Definition at line 110 of file KVUniqueNameList.h.

◆ AddLast()

virtual void KVUniqueNameList::AddLast ( TObject * obj )

inlinevirtual

Add an object to the list if it is not already in it (no object with same name in list)

Reimplemented from KVSeqCollection.

Reimplemented in KVPartitionList.

Definition at line 117 of file KVUniqueNameList.h.

◆ checkObjInList()

Bool_t KVUniqueNameList::checkObjInList ( TObject * obj )

private

Return kTRUE if 'obj' can be added to list. If fReplace==kFALSE, there must be no object in the list with same name as obj->GetName(). If fReplace==kTRUE the previous object is removed from the list. If IsOwner()==kTRUE the previous object is removed AND deleted. In the latter two cases the new object can always be added (returns kTRUE)

Definition at line 40 of file KVUniqueNameList.cpp.

◆ ObjectAdded()

Bool_t KVUniqueNameList::ObjectAdded ( ) const

inline

returns kTRUE if the last (immediately previous) attempt ot add an object to the list was successful

Definition at line 153 of file KVUniqueNameList.h.

◆ ReplaceObjects()

void KVUniqueNameList::ReplaceObjects ( Bool_t yes = kTRUE )

inline

Definition at line 162 of file KVUniqueNameList.h.

Member Data Documentation

◆ fLastCheck

Bool_t KVUniqueNameList::fLastCheck

mutableprivate

return value of last call to checkobj

Definition at line 103 of file KVUniqueNameList.h.

◆ fReplace

Bool_t KVUniqueNameList::fReplace

private

if kTRUE, objects with same name are replaced

Definition at line 102 of file KVUniqueNameList.h.

Detailed Description

EXAMPLES

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVUniqueNameList()

◆ ~KVUniqueNameList()

Member Function Documentation

◆ Add()

◆ AddAfter()

◆ AddAt()

◆ AddBefore()

◆ AddFirst()

◆ AddLast()

◆ checkObjInList()

◆ ObjectAdded()

◆ ReplaceObjects()

Member Data Documentation

◆ fLastCheck

◆ fReplace