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 40 of file TChainIndex.h.

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

Public Member Functions
	TChainIndex ()
	Default constructor for TChainIndex.

	TChainIndex (const TTree T, const char majorname, const char *minorname)
	Normal constructor for TChainIndex.

	~TChainIndex () override
	The destructor.

void	Append (const TVirtualIndex *, bool delaySort=false) override
	Add an index to this chain.

TObject *	Clone (const char *newname="") const override
	Create a deep copy of the TChainIndex.

Long64_t	GetEntryNumberFriend (const TTree *parent) override
	See TTreeIndex::GetEntryNumberFriend for description.

Long64_t	GetEntryNumberWithBestIndex (Long64_t major, Long64_t minor) const override
	See TTreeIndex::GetEntryNumberWithBestIndex for details.

Long64_t	GetEntryNumberWithIndex (Long64_t major, Long64_t minor) const override
	Returns the entry number with given index values.

const char *	GetMajorName () const override

const char *	GetMinorName () const override

Long64_t	GetN () const override

TClass *	IsA () const override

bool	IsValidFor (const TTree *parent) override
	Return true if index can be applied to the TTree.

void	SetTree (TTree *T) override
	See TTreeIndex::SetTree.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

void	UpdateFormulaLeaves (const TTree *parent) override
	Updates the parent formulae.

Public Member Functions inherited from TVirtualIndex
	TVirtualIndex ()
	pointer to Tree

	~TVirtualIndex () override

virtual TTree *	GetTree () const

TClass *	IsA () const override

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)
	TNamed copy ctor.

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()
	TNamed destructor.

void	Clear (Option_t *option="") override
	Set name and title to empty strings ("").

TObject *	Clone (const char *newname="") const override
	Make a clone of an object using the Streamer facility.

Int_t	Compare (const TObject *obj) const override
	Compare two TNamed objects.

void	Copy (TObject &named) const override
	Copy this to obj.

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.

const char *	GetName () const override
	Returns name of object.

const char *	GetTitle () const override
	Returns title of object.

ULong_t	Hash () const override
	Return hash value for this object.

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List TNamed name and title.

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.

void	Print (Option_t *option="") const override
	Print TNamed name and title.

virtual void	SetName (const char *name)
	Set the name of the TNamed.

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title).

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

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.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

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.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

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).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification (the base implementation is no-op).

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete (void ptr, void vp)
	Only called by placement new when throwing an exception.

void	operator delete[] (void *ptr)
	Operator delete [].

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

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.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TVirtualIndex
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Protected Member Functions
void	DeleteIndices ()
	Delete all the indices which were built by this object.

TTreeFormula *	GetMajorFormulaParent (const TTree *parent)
	Return a pointer to the TreeFormula corresponding to the majorname in parent tree T.

TTreeFormula *	GetMinorFormulaParent (const TTree *parent)
	Return a pointer to the TreeFormula corresponding to the minorname in parent tree T.

std::pair< TVirtualIndex *, Int_t >	GetSubTreeIndex (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.

void	ReleaseSubTreeIndex (TVirtualIndex *index, Int_t treeNo) const
	Releases the tree index got using GetSubTreeIndex.

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).

void	MakeZombie ()

Protected Attributes
std::vector< TChainIndexEntry >	fEntries
	Pointer to minor TreeFormula in Parent tree (if any)

TTreeFormula *	fMajorFormulaParent

TString	fMajorName

TTreeFormula *	fMinorFormulaParent
	Pointer to major TreeFormula in Parent tree (if any)

TString	fMinorName

Protected Attributes inherited from TVirtualIndex
TTree *	fTree

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

#include <TChainIndex.h>

Inheritance diagram for TChainIndex:

[legend]

Constructor & Destructor Documentation

◆ TChainIndex() [1/2]

TChainIndex::TChainIndex ( )

Default constructor for TChainIndex.

Definition at line 67 of file TChainIndex.cxx.

◆ TChainIndex() [2/2]

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 83 of file TChainIndex.cxx.

◆ ~TChainIndex()

TChainIndex::~TChainIndex ( )

override

The destructor.

Definition at line 203 of file TChainIndex.cxx.

Member Function Documentation

◆ Append()

void TChainIndex::Append	(	const TVirtualIndex *	index,
		bool	delaySort = `false`
	)

overridevirtual

Add an index to this chain.

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

Implements TVirtualIndex.

Definition at line 157 of file TChainIndex.cxx.

◆ Class()

static TClass * TChainIndex::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TChainIndex::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TChainIndex::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 100 of file TChainIndex.h.

◆ Clone()

TObject * TChainIndex::Clone ( const char * newname = "" ) const

overridevirtual

Create a deep copy of the TChainIndex.

Parameters

[in] newname A new name for the index

The new index is allocated on the heap without being managed. Also, it is not attached to any tree. It is the responsibility of the caller to manage its lifetime and attach it to a tree if necessary.

Reimplemented from TObject.

Definition at line 437 of file TChainIndex.cxx.

◆ DeclFileName()

static const char * TChainIndex::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 100 of file TChainIndex.h.

◆ DeleteIndices()

void TChainIndex::DeleteIndices ( )

protected

Delete all the indices which were built by this object.

Definition at line 187 of file TChainIndex.cxx.

◆ GetEntryNumberFriend()

Long64_t TChainIndex::GetEntryNumberFriend ( const TTree * parent )

overridevirtual

See TTreeIndex::GetEntryNumberFriend for description.

Implements TVirtualIndex.

Definition at line 280 of file TChainIndex.cxx.

◆ GetEntryNumberWithBestIndex()

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

overridevirtual

See TTreeIndex::GetEntryNumberWithBestIndex for details.

Implements TVirtualIndex.

Definition at line 312 of file TChainIndex.cxx.

◆ GetEntryNumberWithIndex()

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

overridevirtual

Returns the entry number with given index values.

See TTreeIndex::GetEntryNumberWithIndex for details.

Implements TVirtualIndex.

Definition at line 332 of file TChainIndex.cxx.

◆ GetMajorFormulaParent()

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

protected

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

Definition at line 355 of file TChainIndex.cxx.

◆ GetMajorName()

const char * TChainIndex::GetMajorName ( ) const

inlineoverridevirtual

Implements TVirtualIndex.

Definition at line 92 of file TChainIndex.h.

◆ GetMinorFormulaParent()

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

protected

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

Definition at line 372 of file TChainIndex.cxx.

◆ GetMinorName()

const char * TChainIndex::GetMinorName ( ) const

inlineoverridevirtual

Implements TVirtualIndex.

Definition at line 93 of file TChainIndex.h.

◆ GetN()

Long64_t TChainIndex::GetN ( ) const

inlineoverridevirtual

Implements TVirtualIndex.

Definition at line 94 of file TChainIndex.h.

◆ GetSubTreeIndex()

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 218 of file TChainIndex.cxx.

◆ IsA()

TClass * TChainIndex::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 100 of file TChainIndex.h.

◆ IsValidFor()

bool TChainIndex::IsValidFor ( const TTree * parent )

overridevirtual

Return true if index can be applied to the TTree.

Implements TVirtualIndex.

Definition at line 392 of file TChainIndex.cxx.

◆ ReleaseSubTreeIndex()

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 269 of file TChainIndex.cxx.

◆ SetTree()

void TChainIndex::SetTree ( TTree * T )

overridevirtual

See TTreeIndex::SetTree.

Implements TVirtualIndex.

Definition at line 424 of file TChainIndex.cxx.

◆ Streamer()

void TChainIndex::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TChainIndex::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 100 of file TChainIndex.h.

◆ UpdateFormulaLeaves()

void TChainIndex::UpdateFormulaLeaves ( const TTree * parent )

overridevirtual

Updates the parent formulae.

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

Implements TVirtualIndex.

Definition at line 406 of file TChainIndex.cxx.

Member Data Documentation

◆ fEntries

std::vector<TChainIndexEntry> TChainIndex::fEntries

protected

Pointer to minor TreeFormula in Parent tree (if any)

Definition at line 75 of file TChainIndex.h.

◆ fMajorFormulaParent

TTreeFormula* TChainIndex::fMajorFormulaParent

protected

Definition at line 73 of file TChainIndex.h.

◆ fMajorName

TString TChainIndex::fMajorName

protected

Definition at line 71 of file TChainIndex.h.

◆ fMinorFormulaParent

TTreeFormula* TChainIndex::fMinorFormulaParent

protected

Pointer to major TreeFormula in Parent tree (if any)

Definition at line 74 of file TChainIndex.h.

◆ fMinorName

TString TChainIndex::fMinorName

protected

Definition at line 72 of file TChainIndex.h.

Libraries for TChainIndex:

[legend]

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

tree/treeplayer/inc/TChainIndex.h
tree/treeplayer/src/TChainIndex.cxx

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TChainIndex() [1/2]

◆ TChainIndex() [2/2]

◆ ~TChainIndex()

Member Function Documentation

◆ Append()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Clone()

◆ DeclFileName()

◆ DeleteIndices()

◆ GetEntryNumberFriend()

◆ GetEntryNumberWithBestIndex()

◆ GetEntryNumberWithIndex()

◆ GetMajorFormulaParent()

◆ GetMajorName()

◆ GetMinorFormulaParent()

◆ GetMinorName()

◆ GetN()

◆ GetSubTreeIndex()

◆ IsA()

◆ IsValidFor()

◆ ReleaseSubTreeIndex()

◆ SetTree()

◆ Streamer()

◆ StreamerNVirtual()

◆ UpdateFormulaLeaves()

Member Data Documentation

◆ fEntries

◆ fMajorFormulaParent

◆ fMajorName

◆ fMinorFormulaParent

◆ fMinorName