Logo ROOT   6.17/01
Reference Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
TOrdCollection Class Reference

Ordered collection.

An ordered collection has TList insertion semantics but is implemented using an array of TObject*'s. It uses less space than a TList (since there is no need for the prev and next pointers), but it is more costly to insert objects (since it has to create a gap by copying object pointers). TOrdCollection is better than TList when objects are only added at the end of the collection since no copying needs to be done.

Definition at line 32 of file TOrdCollection.h.

Public Types

enum  { kDefaultCapacity = 1, kMinExpand = 8, kShrinkFactor = 2 }
 
typedef TOrdCollectionIter 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

 TOrdCollection (Int_t capacity=kDefaultCapacity)
 Create an ordered collection. More...
 
 ~TOrdCollection ()
 Delete the collection. More...
 
void AddAfter (const TObject *after, TObject *obj)
 Insert object after object after in the collection. More...
 
void AddAt (TObject *obj, Int_t idx)
 Insert object at position idx in the collection. More...
 
void AddBefore (const TObject *before, TObject *obj)
 Insert object before object before in the collection. More...
 
void AddFirst (TObject *obj)
 Insert object at beginning of collection. More...
 
void AddLast (TObject *obj)
 Add object at the end of the collection. More...
 
TObjectAfter (const TObject *obj) const
 Return the object after object obj. More...
 
TObjectAt (Int_t idx) const
 Returns the object at position idx. Returns 0 if idx is out of range. More...
 
TObjectBefore (const TObject *obj) const
 Returns the object before object obj. More...
 
Int_t BinarySearch (TObject *obj)
 Find object using a binary search. More...
 
void Clear (Option_t *option="")
 Remove all objects from the collection. More...
 
void Delete (Option_t *option="")
 Remove all objects from the collection AND delete all heap based objects. More...
 
TObjectFirst () const
 Return the first object in the collection. More...
 
TObject ** GetObjectRef (const TObject *obj) const
 return address of pointer obj More...
 
Int_t IndexOf (const TObject *obj) const
 Return index of object in collection. More...
 
TObjectLast () const
 Return the last object in the collection. More...
 
TIteratorMakeIterator (Bool_t dir=kIterForward) const
 Return an ordered collection iterator. More...
 
void PutAt (TObject *obj, Int_t idx)
 Put object at index idx. Overwrites what was at idx before. More...
 
TObjectRemove (TObject *obj)
 Remove object from collection. More...
 
TObjectRemoveAt (Int_t idx)
 Remove object at index idx. More...
 
void Sort ()
 If objects in collection are sortable (i.e. More...
 
- Public Member Functions inherited from TSeqCollection
virtual ~TSeqCollection ()
 
virtual void Add (TObject *obj)
 
virtual Int_t GetLast () const
 Returns index of last object in collection. More...
 
virtual Bool_t IsSorted () const
 
Int_t LastIndex () const
 
Long64_t Merge (TCollection *list)
 Merge this collection with all collections coming in the input list. More...
 
virtual void RemoveAfter (TObject *after)
 
virtual void RemoveBefore (TObject *before)
 
virtual void RemoveFirst ()
 
virtual void RemoveLast ()
 
void UnSort ()
 
- Public Member Functions inherited from TCollection
virtual ~TCollection ()
 TNamed destructor. More...
 
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 TObjectClone (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 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 TObjectFindObject (const char *name) const
 Find an object in this collection using its name. More...
 
virtual TObjectFindObject (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 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 TIteratorMakeReverseIterator () const
 
virtual Bool_t Notify ()
 'Notify' all objects in this collection. More...
 
TObjectoperator() (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
 Default print for collections, calls Print(option, 1). 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, 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, TPRegexp &regexp, Int_t recurse=1) const
 Print the collection header and its elements that match the regexp. More...
 
virtual void RecursiveRemove (TObject *obj)
 Remove object from this collection and recursively remove the object from all other objects (and collections). More...
 
virtual void RemoveAll (TCollection *col)
 Remove all objects in collection col from this collection. More...
 
void RemoveAll ()
 
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...
 
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 Copy (TObject &object) const
 Copy this to obj. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). 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 Option_tGetDrawOption () 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 char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () 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...
 
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...
 
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). 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...
 
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. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. 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, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
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...
 

Private Member Functions

 TOrdCollection (const TOrdCollection &)
 
Bool_t IllegalIndex (const char *method, Int_t idx) const
 Return true when index out of bounds and print error. More...
 
void Init (Int_t capacity)
 Initialize ordered collection. More...
 
Int_t LogIndex (Int_t idx) const
 
Bool_t LowWaterMark () const
 
void MoveGapTo (Int_t newGapStart)
 Move gap to new position. More...
 
TOrdCollectionoperator= (const TOrdCollection &)
 
Int_t PhysIndex (Int_t idx) const
 
void SetCapacity (Int_t newCapacity)
 Set/change ordered collection capacity. More...
 

Private Attributes

Int_t fCapacity
 
TObject ** fCont
 
Int_t fGapSize
 
Int_t fGapStart
 

Friends

class TOrdCollectionIter
 

Additional Inherited Members

- Static Public Member Functions inherited from TSeqCollection
static Int_t ObjCompare (TObject *a, TObject *b)
 Compare to objects in the collection. Use member Compare() of object a. More...
 
static void QSort (TObject **a, Int_t first, Int_t last)
 Sort array of TObject pointers using a quicksort algorithm. More...
 
static void QSort (TObject **a, TObject **b, Int_t first, Int_t last)
 
static void QSort (TObject **a, Int_t nBs, TObject ***b, Int_t first, Int_t last)
 Sort array a of TObject pointers using a quicksort algorithm. More...
 
- 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 TCollectionGetCurrentCollection ()
 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 Types inherited from TCollection
enum  EStatusBits { kIsOwner = BIT(14), kUseRWLock = BIT(16) }
 
- Protected Member Functions inherited from TSeqCollection
 TSeqCollection ()
 
virtual void Changed ()
 
- 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 ()
 
- Protected Attributes inherited from TSeqCollection
Bool_t fSorted
 
- Protected Attributes inherited from TCollection
TString fName
 
Int_t fSize
 

#include <TOrdCollection.h>

Inheritance diagram for TOrdCollection:
[legend]

Member Typedef Documentation

Definition at line 56 of file TOrdCollection.h.

Member Enumeration Documentation

anonymous enum
Enumerator
kDefaultCapacity 
kMinExpand 
kShrinkFactor 

Definition at line 54 of file TOrdCollection.h.

Constructor & Destructor Documentation

TOrdCollection::TOrdCollection ( const TOrdCollection )
private
TOrdCollection::TOrdCollection ( Int_t  capacity = kDefaultCapacity)

Create an ordered collection.

Definition at line 32 of file TOrdCollection.cxx.

TOrdCollection::~TOrdCollection ( )

Delete the collection.

Objects are not deleted unless the TOrdCollection is the owner (set via SetOwner()).

Definition at line 46 of file TOrdCollection.cxx.

Member Function Documentation

void TOrdCollection::AddAfter ( const TObject after,
TObject obj 
)
virtual

Insert object after object after in the collection.

Implements TSeqCollection.

Definition at line 129 of file TOrdCollection.cxx.

void TOrdCollection::AddAt ( TObject obj,
Int_t  idx 
)
virtual

Insert object at position idx in the collection.

Implements TSeqCollection.

Definition at line 59 of file TOrdCollection.cxx.

void TOrdCollection::AddBefore ( const TObject before,
TObject obj 
)
virtual

Insert object before object before in the collection.

Implements TSeqCollection.

Definition at line 108 of file TOrdCollection.cxx.

void TOrdCollection::AddFirst ( TObject obj)
virtual

Insert object at beginning of collection.

Implements TSeqCollection.

Definition at line 92 of file TOrdCollection.cxx.

void TOrdCollection::AddLast ( TObject obj)
virtual

Add object at the end of the collection.

Implements TSeqCollection.

Definition at line 100 of file TOrdCollection.cxx.

TObject * TOrdCollection::After ( const TObject obj) const
virtual

Return the object after object obj.

Returns 0 if obj is last in collection.

Implements TSeqCollection.

Definition at line 147 of file TOrdCollection.cxx.

TObject * TOrdCollection::At ( Int_t  idx) const
virtual

Returns the object at position idx. Returns 0 if idx is out of range.

Implements TSeqCollection.

Definition at line 160 of file TOrdCollection.cxx.

TObject * TOrdCollection::Before ( const TObject obj) const
virtual

Returns the object before object obj.

Returns 0 if obj is first in collection.

Implements TSeqCollection.

Definition at line 170 of file TOrdCollection.cxx.

Int_t TOrdCollection::BinarySearch ( TObject obj)

Find object using a binary search.

Collection must first have been sorted.

Definition at line 415 of file TOrdCollection.cxx.

void TOrdCollection::Clear ( Option_t option = "")
virtual

Remove all objects from the collection.

Does not delete the objects unless the TOrdCollection is the owner (set via SetOwner()).

Implements TCollection.

Definition at line 184 of file TOrdCollection.cxx.

void TOrdCollection::Delete ( Option_t option = "")
virtual

Remove all objects from the collection AND delete all heap based objects.

Implements TCollection.

Definition at line 199 of file TOrdCollection.cxx.

TObject * TOrdCollection::First ( ) const
virtual

Return the first object in the collection.

Returns 0 when collection is empty.

Implements TSeqCollection.

Definition at line 216 of file TOrdCollection.cxx.

TObject ** TOrdCollection::GetObjectRef ( const TObject obj) const
virtual

return address of pointer obj

Implements TCollection.

Definition at line 224 of file TOrdCollection.cxx.

Bool_t TOrdCollection::IllegalIndex ( const char *  method,
Int_t  idx 
) const
private

Return true when index out of bounds and print error.

Definition at line 242 of file TOrdCollection.cxx.

Int_t TOrdCollection::IndexOf ( const TObject obj) const
virtual

Return index of object in collection.

Returns -1 when object not found. Uses member IsEqual() to find object.

Reimplemented from TSeqCollection.

Definition at line 255 of file TOrdCollection.cxx.

void TOrdCollection::Init ( Int_t  capacity)
private

Initialize ordered collection.

Definition at line 267 of file TOrdCollection.cxx.

TObject * TOrdCollection::Last ( ) const
virtual

Return the last object in the collection.

Returns 0 when collection is empty.

Implements TSeqCollection.

Definition at line 234 of file TOrdCollection.cxx.

Int_t TOrdCollection::LogIndex ( Int_t  idx) const
inlineprivate

Definition at line 137 of file TOrdCollection.h.

Bool_t TOrdCollection::LowWaterMark ( ) const
inlineprivate

Definition at line 129 of file TOrdCollection.h.

TIterator * TOrdCollection::MakeIterator ( Bool_t  dir = kIterForward) const
virtual

Return an ordered collection iterator.

Implements TCollection.

Definition at line 280 of file TOrdCollection.cxx.

void TOrdCollection::MoveGapTo ( Int_t  start)
private

Move gap to new position.

Gap needs to be moved when objects are inserted not at the end.

Definition at line 289 of file TOrdCollection.cxx.

TOrdCollection& TOrdCollection::operator= ( const TOrdCollection )
private
Int_t TOrdCollection::PhysIndex ( Int_t  idx) const
inlineprivate

Definition at line 134 of file TOrdCollection.h.

void TOrdCollection::PutAt ( TObject obj,
Int_t  idx 
)

Put object at index idx. Overwrites what was at idx before.

Definition at line 315 of file TOrdCollection.cxx.

TObject * TOrdCollection::Remove ( TObject obj)
virtual

Remove object from collection.

Implements TCollection.

Definition at line 365 of file TOrdCollection.cxx.

TObject * TOrdCollection::RemoveAt ( Int_t  idx)
virtual

Remove object at index idx.

Reimplemented from TSeqCollection.

Definition at line 328 of file TOrdCollection.cxx.

void TOrdCollection::SetCapacity ( Int_t  newCapacity)
private

Set/change ordered collection capacity.

Definition at line 378 of file TOrdCollection.cxx.

void TOrdCollection::Sort ( )

If objects in collection are sortable (i.e.

IsSortable() returns true for all objects) then sort collection.

Definition at line 397 of file TOrdCollection.cxx.

Friends And Related Function Documentation

friend class TOrdCollectionIter
friend

Definition at line 34 of file TOrdCollection.h.

Member Data Documentation

Int_t TOrdCollection::fCapacity
private

Definition at line 38 of file TOrdCollection.h.

TObject** TOrdCollection::fCont
private

Definition at line 37 of file TOrdCollection.h.

Int_t TOrdCollection::fGapSize
private

Definition at line 40 of file TOrdCollection.h.

Int_t TOrdCollection::fGapStart
private

Definition at line 39 of file TOrdCollection.h.

Libraries for TOrdCollection:
[legend]

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