Logo ROOT   6.12/07
Reference Guide
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TSeqCollection Class Referenceabstract

Sequenceable collection abstract base class.

TSeqCollection's have an ordering relation, i.e. there is a first and last element.

Definition at line 28 of file TSeqCollection.h.

Public Member Functions

virtual ~TSeqCollection ()
 
virtual void Add (TObject *obj)
 
virtual void AddAfter (const TObject *after, TObject *obj)=0
 
virtual void AddAt (TObject *obj, Int_t idx)=0
 
virtual void AddBefore (const TObject *before, TObject *obj)=0
 
virtual void AddFirst (TObject *obj)=0
 
virtual void AddLast (TObject *obj)=0
 
virtual TObjectAfter (const TObject *obj) const =0
 
virtual TObjectAt (Int_t idx) const =0
 
virtual TObjectBefore (const TObject *obj) const =0
 
virtual TObjectFirst () const =0
 
virtual Int_t GetLast () const
 Returns index of last object in collection. More...
 
virtual Int_t IndexOf (const TObject *obj) const
 Return index of object in collection. More...
 
virtual Bool_t IsSorted () const
 
virtual TObjectLast () const =0
 
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 TObjectRemoveAt (Int_t idx)
 
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 void Clear (Option_t *option="")=0
 
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 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 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 TObject ** GetObjectRef (const TObject *obj) const =0
 
virtual Int_t GetSize () const
 
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 TIteratorMakeIterator (Bool_t dir=kIterForward) const =0
 
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 TObjectRemove (TObject *obj)=0
 
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 ()
 Checked and record whether for 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...
 

Static Public Member Functions

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 Member Functions

 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

Bool_t fSorted
 
- Protected Attributes inherited from TCollection
TString fName
 
Int_t fSize
 

Additional Inherited Members

- 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)
}
 
- Protected Types inherited from TCollection
enum  EStatusBits { kIsOwner = BIT(14), kUseRWLock = BIT(16) }
 

#include <TSeqCollection.h>

Inheritance diagram for TSeqCollection:
[legend]

Constructor & Destructor Documentation

◆ TSeqCollection()

TSeqCollection::TSeqCollection ( )
inlineprotected

Definition at line 33 of file TSeqCollection.h.

◆ ~TSeqCollection()

virtual TSeqCollection::~TSeqCollection ( )
inlinevirtual

Definition at line 37 of file TSeqCollection.h.

Member Function Documentation

◆ Add()

virtual void TSeqCollection::Add ( TObject obj)
inlinevirtual

Implements TCollection.

Reimplemented in TQUndoManager, TQCommand, TList, TBtree, TRefArray, TObjArray, and TSortedList.

Definition at line 38 of file TSeqCollection.h.

◆ AddAfter()

virtual void TSeqCollection::AddAfter ( const TObject after,
TObject obj 
)
pure virtual

◆ AddAt()

virtual void TSeqCollection::AddAt ( TObject obj,
Int_t  idx 
)
pure virtual

◆ AddBefore()

virtual void TSeqCollection::AddBefore ( const TObject before,
TObject obj 
)
pure virtual

◆ AddFirst()

virtual void TSeqCollection::AddFirst ( TObject obj)
pure virtual

◆ AddLast()

virtual void TSeqCollection::AddLast ( TObject obj)
pure virtual

◆ After()

virtual TObject* TSeqCollection::After ( const TObject obj) const
pure virtual

◆ At()

virtual TObject* TSeqCollection::At ( Int_t  idx) const
pure virtual

◆ Before()

virtual TObject* TSeqCollection::Before ( const TObject obj) const
pure virtual

◆ Changed()

virtual void TSeqCollection::Changed ( )
inlineprotectedvirtual

Definition at line 34 of file TSeqCollection.h.

◆ First()

virtual TObject* TSeqCollection::First ( ) const
pure virtual

◆ GetLast()

Int_t TSeqCollection::GetLast ( ) const
virtual

Returns index of last object in collection.

Returns -1 when no objects in collection.

Reimplemented in TListOfFunctions, TRefArray, TObjArray, and TListOfEnumsWithLock.

Definition at line 47 of file TSeqCollection.cxx.

◆ IndexOf()

Int_t TSeqCollection::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 in TRefArray, TObjArray, TListOfFunctions, TOrdCollection, and TListOfEnumsWithLock.

Definition at line 30 of file TSeqCollection.cxx.

◆ IsSorted()

virtual Bool_t TSeqCollection::IsSorted ( ) const
inlinevirtual

Reimplemented in TSortedList.

Definition at line 58 of file TSeqCollection.h.

◆ Last()

virtual TObject* TSeqCollection::Last ( ) const
pure virtual

◆ LastIndex()

Int_t TSeqCollection::LastIndex ( ) const
inline

Definition at line 55 of file TSeqCollection.h.

◆ Merge()

Long64_t TSeqCollection::Merge ( TCollection list)

Merge this collection with all collections coming in the input list.

The input list must contain other collections of objects compatible with the ones in this collection and ordered in the same manner. For example, if this collection contains a TH1 object and a tree, all collections in the input list have to contain a histogram and a tree. In case the list contains collections, the objects in the input lists must also be collections with the same structure and number of objects. If some objects inside the collection are instances of a class that do not have a Merge function (like TObjString), rather than merging, a copy of each instance (via a call to Clone) is appended to the output.

Example

this list
____________ ---------------------|
| A (TH1F) | __________ | L1 (TSeqCollection)|- [A1, B1(C1,D1,E1)]
| B (TList)|-| C (TTree)| | L1 (TSeqCollection)|- [A2, B2(C2,D2,E2)]
|__________| | D (TH1F) | | ... |- [...]
| E (TH1F) | |____________________|
|__________|

Definition at line 185 of file TSeqCollection.cxx.

◆ ObjCompare()

Int_t TSeqCollection::ObjCompare ( TObject a,
TObject b 
)
static

Compare to objects in the collection. Use member Compare() of object a.

Definition at line 56 of file TSeqCollection.cxx.

◆ QSort() [1/3]

void TSeqCollection::QSort ( TObject **  a,
Int_t  first,
Int_t  last 
)
static

Sort array of TObject pointers using a quicksort algorithm.

The algorithm used is a non stable sort (i.e. already sorted elements might switch/change places). Uses ObjCompare() to compare objects.

Definition at line 70 of file TSeqCollection.cxx.

◆ QSort() [2/3]

static void TSeqCollection::QSort ( TObject **  a,
TObject **  b,
Int_t  first,
Int_t  last 
)
inlinestatic

Definition at line 64 of file TSeqCollection.h.

◆ QSort() [3/3]

void TSeqCollection::QSort ( TObject **  a,
Int_t  nBs,
TObject ***  b,
Int_t  first,
Int_t  last 
)
static

Sort array a of TObject pointers using a quicksort algorithm.

Arrays b will be sorted just like a (a determines the sort). Argument nBs is the number of TObject** arrays in b. The algorithm used is a non stable sort (i.e. already sorted elements might switch/change places). Uses ObjCompare() to compare objects.

Definition at line 118 of file TSeqCollection.cxx.

◆ RemoveAfter()

virtual void TSeqCollection::RemoveAfter ( TObject after)
inlinevirtual

Definition at line 47 of file TSeqCollection.h.

◆ RemoveAt()

virtual TObject* TSeqCollection::RemoveAt ( Int_t  idx)
inlinevirtual

Reimplemented in TRefArray, TObjArray, TClonesArray, and TOrdCollection.

Definition at line 46 of file TSeqCollection.h.

◆ RemoveBefore()

virtual void TSeqCollection::RemoveBefore ( TObject before)
inlinevirtual

Definition at line 48 of file TSeqCollection.h.

◆ RemoveFirst()

virtual void TSeqCollection::RemoveFirst ( )
inlinevirtual

Definition at line 44 of file TSeqCollection.h.

◆ RemoveLast()

virtual void TSeqCollection::RemoveLast ( )
inlinevirtual

Reimplemented in TList.

Definition at line 45 of file TSeqCollection.h.

◆ UnSort()

void TSeqCollection::UnSort ( )
inline

Definition at line 59 of file TSeqCollection.h.

Member Data Documentation

◆ fSorted

Bool_t TSeqCollection::fSorted
protected

Definition at line 31 of file TSeqCollection.h.

Libraries for TSeqCollection:
[legend]

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