Logo ROOT   6.18/05
Reference Guide
TClonesArray.h
Go to the documentation of this file.
1// @(#)root/cont:$Id$
2// Author: Rene Brun 11/02/96
3
4/*************************************************************************
5 * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
11
12#ifndef ROOT_TClonesArray
13#define ROOT_TClonesArray
14
15
16//////////////////////////////////////////////////////////////////////////
17// //
18// TClonesArray //
19// //
20// An array of clone TObjects. The array expands automatically when //
21// adding elements (shrinking can be done explicitly). //
22// //
23//////////////////////////////////////////////////////////////////////////
24
25#include "Rtypes.h"
26
27#include "TObjArray.h"
28
29class TClass;
30
31
32class TClonesArray : public TObjArray {
33
34protected:
35 TClass *fClass; //!Pointer to the class of the elements
36 TObjArray *fKeep; //!Saved copies of pointers to objects
37
38public:
40 kBypassStreamer = BIT(12), // Class Streamer not called (default)
41 kForgetBits = BIT(15) // Do not create branches for fBits, fUniqueID
42 };
43
45 TClonesArray(const char *classname, Int_t size = 1000, Bool_t call_dtor = kFALSE);
46 TClonesArray(const TClass *cl, Int_t size = 1000, Bool_t call_dtor = kFALSE);
47 TClonesArray(const TClonesArray& tc);
48 virtual ~TClonesArray();
50 virtual void Compress();
51 virtual void Clear(Option_t *option="");
52 virtual void Delete(Option_t *option="");
53 virtual void Expand(Int_t newSize);
54 virtual void ExpandCreate(Int_t n);
55 virtual void ExpandCreateFast(Int_t n);
56 TClass *GetClass() const { return fClass; }
57 virtual void SetOwner(Bool_t enable = kTRUE);
58
59 void AddFirst(TObject *) { MayNotUse("AddFirst"); }
60 void AddLast(TObject *) { MayNotUse("AddLast"); }
61 void AddAt(TObject *, Int_t) { MayNotUse("AddAt"); }
62 void AddAtAndExpand(TObject *, Int_t) { MayNotUse("AddAtAndExpand"); }
63 Int_t AddAtFree(TObject *) { MayNotUse("AddAtFree"); return 0; }
64 void AddAfter(const TObject *, TObject *) { MayNotUse("AddAfter"); }
65 void AddBefore(const TObject *, TObject *) { MayNotUse("AddBefore"); }
66 void BypassStreamer(Bool_t bypass=kTRUE);
69 TObject *ConstructedAt(Int_t idx, Option_t *clear_options);
70 void SetClass(const char *classname,Int_t size=1000);
71 void SetClass(const TClass *cl,Int_t size=1000);
72
74 void AbsorbObjects(TClonesArray *tc, Int_t idx1, Int_t idx2);
75 void MultiSort(Int_t nTCs, TClonesArray** tcs, Int_t upto = kMaxInt);
76 virtual TObject *RemoveAt(Int_t idx);
77 virtual TObject *Remove(TObject *obj);
78 virtual void RemoveRange(Int_t idx1, Int_t idx2);
79 virtual void Sort(Int_t upto = kMaxInt);
80
81 TObject *New(Int_t idx);
82 TObject *AddrAt(Int_t idx);
84 TObject *operator[](Int_t idx) const;
85
86 ClassDef(TClonesArray,4) //An array of clone objects
87};
88
90{
91 return operator[](idx);
92}
93
94#endif
int Int_t
Definition: RtypesCore.h:41
const Int_t kMaxInt
Definition: RtypesCore.h:99
const Bool_t kFALSE
Definition: RtypesCore.h:88
bool Bool_t
Definition: RtypesCore.h:59
const Bool_t kTRUE
Definition: RtypesCore.h:87
const char Option_t
Definition: RtypesCore.h:62
#define ClassDef(name, id)
Definition: Rtypes.h:326
#define BIT(n)
Definition: Rtypes.h:83
TClass instances represent classes, structs and namespaces in the ROOT type system.
Definition: TClass.h:75
An array of clone (identical) objects.
Definition: TClonesArray.h:32
virtual void Delete(Option_t *option="")
Clear the clones array.
TObjArray * fKeep
Pointer to the class of the elements.
Definition: TClonesArray.h:36
void AddBefore(const TObject *, TObject *)
Add object in the slot before object before.
Definition: TClonesArray.h:65
virtual void Expand(Int_t newSize)
Expand or shrink the array to newSize elements.
void BypassStreamer(Bool_t bypass=kTRUE)
When the kBypassStreamer bit is set, the automatically generated Streamer can call directly TClass::W...
virtual ~TClonesArray()
Delete a clones array.
virtual void Compress()
Remove empty slots from array.
virtual void SetOwner(Bool_t enable=kTRUE)
A TClonesArray is always the owner of the object it contains.
Int_t AddAtFree(TObject *)
Return the position of the new object.
Definition: TClonesArray.h:63
void AbsorbObjects(TClonesArray *tc)
Directly move the object pointers from tc without cloning (copying).
virtual void ExpandCreateFast(Int_t n)
Expand or shrink the array to n elements and create the clone objects by calling their default ctor.
void AddLast(TObject *)
Add object in the next empty slot in the array.
Definition: TClonesArray.h:60
TClass * GetClass() const
Definition: TClonesArray.h:56
TObject * AddrAt(Int_t idx)
Definition: TClonesArray.h:89
void SetClass(const char *classname, Int_t size=1000)
see TClonesArray::SetClass(const TClass*)
virtual void RemoveRange(Int_t idx1, Int_t idx2)
Remove objects from index idx1 to idx2 included.
Bool_t CanBypassStreamer() const
Definition: TClonesArray.h:67
TClass * fClass
Definition: TClonesArray.h:35
TClonesArray & operator=(const TClonesArray &tc)
Assignment operator.
void AddAt(TObject *, Int_t)
Add object at position ids.
Definition: TClonesArray.h:61
void AddAtAndExpand(TObject *, Int_t)
Add object at position idx.
Definition: TClonesArray.h:62
void AddFirst(TObject *)
Add object in the first slot of the array.
Definition: TClonesArray.h:59
void AddAfter(const TObject *, TObject *)
Add object in the slot after object after.
Definition: TClonesArray.h:64
virtual TObject * RemoveAt(Int_t idx)
Remove object at index idx.
virtual void Clear(Option_t *option="")
Clear the clones array.
TObject * ConstructedAt(Int_t idx)
Get an object at index 'idx' that is guaranteed to have been constructed.
virtual TObject * Remove(TObject *obj)
Remove object from array.
virtual void ExpandCreate(Int_t n)
Expand or shrink the array to n elements and create the clone objects by calling their default ctor.
TClonesArray()
Default Constructor.
virtual void Sort(Int_t upto=kMaxInt)
If objects in array are sortable (i.e.
TObject *& operator[](Int_t idx)
Return pointer to reserved area in which a new object of clones class can be constructed.
TObject * New(Int_t idx)
Create an object of type fClass with the default ctor at the specified index.
void MultiSort(Int_t nTCs, TClonesArray **tcs, Int_t upto=kMaxInt)
Sort multiple TClonesArrays simultaneously with this array.
An array of TObjects.
Definition: TObjArray.h:37
Mother of all ROOT objects.
Definition: TObject.h:37
R__ALWAYS_INLINE Bool_t TestBit(UInt_t f) const
Definition: TObject.h:172
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 clas...
Definition: TObject.cxx:933
EStatusBits
Definition: TObject.h:57
const Int_t n
Definition: legend1.C:16