ROOT  6.07/01
Reference Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TChainIndex Class Reference

A Chain Index.

A Chain Index with majorname and minorname. It uses tree indices of all the trees in the chain instead of building a new index. The index values from the first tree should be less then all the index values from the second tree, and so on. If a tree in the chain doesn't have an index the index will be created and kept inside this chain index.

Definition at line 41 of file TChainIndex.h.

Classes

class  TChainIndexEntry
 Holds a description of indices of trees in the chain. More...
 

Public Member Functions

 TChainIndex ()
 
 TChainIndex (const TTree *T, const char *majorname, const char *minorname)
 Normal constructor for TChainIndex. More...
 
virtual ~TChainIndex ()
 The destructor. More...
 
virtual void Append (const TVirtualIndex *, Bool_t delaySort=kFALSE)
 Add an index to this chain. More...
 
virtual Long64_t GetEntryNumberFriend (const TTree *parent)
 See TTreeIndex::GetEntryNumberFriend for description. More...
 
virtual Long64_t GetEntryNumberWithIndex (Long64_t major, Long64_t minor) const
 Returns the entry number with given index values. More...
 
virtual Long64_t GetEntryNumberWithBestIndex (Long64_t major, Long64_t minor) const
 See TTreeIndex::GetEntryNumberWithBestIndex for details. More...
 
const char * GetMajorName () const
 
const char * GetMinorName () const
 
virtual Long64_t GetN () const
 
virtual TTreeFormulaGetMajorFormulaParent (const TTree *parent)
 Return a pointer to the TreeFormula corresponding to the majorname in parent tree T. More...
 
virtual TTreeFormulaGetMinorFormulaParent (const TTree *parent)
 Return a pointer to the TreeFormula corresponding to the minorname in parent tree T. More...
 
virtual void UpdateFormulaLeaves (const TTree *parent)
 Updates the parent formulae. More...
 
virtual void SetTree (const TTree *T)
 See TTreeIndex::SetTree. More...
 
- Public Member Functions inherited from TVirtualIndex
 TVirtualIndex ()
 pointer to Tree More...
 
virtual ~TVirtualIndex ()
 
virtual TTreeGetTree () const
 
 ClassDef (TVirtualIndex, 1)
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual ~TNamed ()
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void SetName (const char *name)
 Change (i.e. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Change (i.e. set) all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Change (i.e. set) the title of the TNamed. More...
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. 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 pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. 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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. 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...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. 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...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
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...
 
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 UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. 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)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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...
 
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...
 

Protected Member Functions

std::pair< TVirtualIndex *, Int_tGetSubTreeIndex (Long64_t major, Long64_t minor) const
 Returns a TVirtualIndex for a tree which holds the entry with the specified major and minor values and the number of that tree. More...
 
void ReleaseSubTreeIndex (TVirtualIndex *index, Int_t treeNo) const
 Releases the tree index got using GetSubTreeIndex. More...
 
void DeleteIndices ()
 Delete all the indices which were built by this object. More...
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

Protected Attributes

TString fMajorName
 
TString fMinorName
 
TTreeFormulafMajorFormulaParent
 
TTreeFormulafMinorFormulaParent
 Pointer to major TreeFormula in Parent tree (if any) More...
 
std::vector< TChainIndexEntryfEntries
 Pointer to minor TreeFormula in Parent tree (if any) More...
 
- Protected Attributes inherited from TVirtualIndex
TTreefTree
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Additional Inherited Members

- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

#include <TChainIndex.h>

Inheritance diagram for TChainIndex:
[legend]

Constructor & Destructor Documentation

TChainIndex::TChainIndex ( )
TChainIndex::TChainIndex ( const TTree T,
const char *  majorname,
const char *  minorname 
)

Normal constructor for TChainIndex.

See TTreeIndex::TTreeIndex for the description of the parameters. The tree must be a TChain. All the index values in the first tree of the chain must be less then any index value in the second one, and so on. If any of those requirements isn't met the object becomes a zombie. If some subtrees don't have indices the indices are created and stored inside this TChainIndex.

Definition at line 63 of file TChainIndex.cxx.

TChainIndex::~TChainIndex ( )
virtual

The destructor.

Definition at line 183 of file TChainIndex.cxx.

Member Function Documentation

void TChainIndex::Append ( const TVirtualIndex index,
Bool_t  delaySort = kFALSE 
)
virtual

Add an index to this chain.

if delaySort is kFALSE (default) check if the indices of different trees are in order.

Implements TVirtualIndex.

Definition at line 137 of file TChainIndex.cxx.

void TChainIndex::DeleteIndices ( )
protected

Delete all the indices which were built by this object.

Definition at line 167 of file TChainIndex.cxx.

Referenced by Append(), TChainIndex(), and ~TChainIndex().

Long64_t TChainIndex::GetEntryNumberFriend ( const TTree parent)
virtual

See TTreeIndex::GetEntryNumberFriend for description.

Implements TVirtualIndex.

Definition at line 258 of file TChainIndex.cxx.

Long64_t TChainIndex::GetEntryNumberWithBestIndex ( Long64_t  major,
Long64_t  minor 
) const
virtual

See TTreeIndex::GetEntryNumberWithBestIndex for details.

Implements TVirtualIndex.

Definition at line 290 of file TChainIndex.cxx.

Long64_t TChainIndex::GetEntryNumberWithIndex ( Long64_t  major,
Long64_t  minor 
) const
virtual

Returns the entry number with given index values.

See TTreeIndex::GetEntryNumberWithIndex for details.

Implements TVirtualIndex.

Definition at line 310 of file TChainIndex.cxx.

TTreeFormula * TChainIndex::GetMajorFormulaParent ( const TTree parent)
virtual

Return a pointer to the TreeFormula corresponding to the majorname in parent tree T.

Definition at line 333 of file TChainIndex.cxx.

Referenced by GetEntryNumberFriend().

const char* TChainIndex::GetMajorName ( ) const
inlinevirtual

Implements TVirtualIndex.

Definition at line 84 of file TChainIndex.h.

TTreeFormula * TChainIndex::GetMinorFormulaParent ( const TTree parent)
virtual

Return a pointer to the TreeFormula corresponding to the minorname in parent tree T.

Definition at line 350 of file TChainIndex.cxx.

Referenced by GetEntryNumberFriend().

const char* TChainIndex::GetMinorName ( ) const
inlinevirtual

Implements TVirtualIndex.

Definition at line 85 of file TChainIndex.h.

virtual Long64_t TChainIndex::GetN ( ) const
inlinevirtual

Implements TVirtualIndex.

Definition at line 86 of file TChainIndex.h.

std::pair< TVirtualIndex *, Int_t > TChainIndex::GetSubTreeIndex ( Long64_t  major,
Long64_t  minor 
) const
protected

Returns a TVirtualIndex for a tree which holds the entry with the specified major and minor values and the number of that tree.

If the index for that tree was created by this object it's set to the tree. The tree index should be later released using ReleaseSubTreeIndex();

Definition at line 196 of file TChainIndex.cxx.

Referenced by GetEntryNumberWithBestIndex(), and GetEntryNumberWithIndex().

void TChainIndex::ReleaseSubTreeIndex ( TVirtualIndex index,
Int_t  treeNo 
) const
protected

Releases the tree index got using GetSubTreeIndex.

If the index was created by this object it is removed from the current tree, so that it isn't deleted in its destructor.

Definition at line 247 of file TChainIndex.cxx.

Referenced by GetEntryNumberWithBestIndex(), and GetEntryNumberWithIndex().

void TChainIndex::SetTree ( const TTree T)
virtual

See TTreeIndex::SetTree.

Implements TVirtualIndex.

Definition at line 389 of file TChainIndex.cxx.

void TChainIndex::UpdateFormulaLeaves ( const TTree parent)
virtual

Updates the parent formulae.

Called by TChain::LoadTree when the parent chain changes it's tree.

Implements TVirtualIndex.

Definition at line 371 of file TChainIndex.cxx.

Member Data Documentation

std::vector<TChainIndexEntry> TChainIndex::fEntries
protected

Pointer to minor TreeFormula in Parent tree (if any)

Definition at line 70 of file TChainIndex.h.

Referenced by Append(), DeleteIndices(), GetN(), GetSubTreeIndex(), ReleaseSubTreeIndex(), and TChainIndex().

TTreeFormula* TChainIndex::fMajorFormulaParent
protected
TString TChainIndex::fMajorName
protected

Definition at line 66 of file TChainIndex.h.

Referenced by GetMajorFormulaParent(), GetMajorName(), and TChainIndex().

TTreeFormula* TChainIndex::fMinorFormulaParent
protected

Pointer to major TreeFormula in Parent tree (if any)

Definition at line 69 of file TChainIndex.h.

Referenced by ClassImp(), GetEntryNumberFriend(), GetMinorFormulaParent(), TChainIndex(), and UpdateFormulaLeaves().

TString TChainIndex::fMinorName
protected

Definition at line 67 of file TChainIndex.h.

Referenced by GetMinorFormulaParent(), GetMinorName(), and TChainIndex().

Collaboration diagram for TChainIndex:
[legend]

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