class TBranchRef: public TBranch


A branch containing and managing a TRefTable for TRef autoloading.
It loads the TBranch containing a referenced object when requested
by TRef::GetObject(), so the reference can be resolved. The
information which branch to load is stored by TRefTable. Once a
TBranch has read the TBranchRef's current entry it will not be told
to re-read, in case the use has changed objects read from the
branch.


LIMITATION
Note that this does NOT allow for autoloading of references spanning
different entries. The TBranchRef's current entry has to correspond
to the entry of the TBranch containing the referenced object.

The TRef cannot be stored in a top-level branch which is a
TBranchObject for the auto-loading to work. E.g. you cannot store
the TRefs in TObjArray, and create a top-level branch storing this
TObjArray.

Function Members (Methods)

public:

	TBranchRef()
	TBranchRef(TTree* tree)
virtual	~TBranchRef()
void	TObject::AbstractMethod(const char* method) const
virtual void	TBranch::AddBasket(TBasket& b, Bool_t ondisk, Long64_t startEntry)
virtual void	TBranch::AddLastBasket(Long64_t startEntry)
virtual void	TObject::AppendPad(Option_t* option = "")
virtual void	TBranch::Browse(TBrowser* b)
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	Clear(Option_t* option = "")
virtual TObject*	TNamed::Clone(const char* newname = "") const
virtual Int_t	TNamed::Compare(const TObject* obj) const
virtual void	TNamed::Copy(TObject& named) const
virtual void	TObject::Delete(Option_t* option = "")MENU
virtual void	TBranch::DeleteBaskets(Option_t* option = "")
virtual Int_t	TObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual void	TObject::Draw(Option_t* option = "")
virtual void	TObject::DrawClass() constMENU
virtual TObject*	TObject::DrawClone(Option_t* option = "") constMENU
virtual void	TBranch::DropBaskets(Option_t* option = "")
virtual void	TObject::Dump() constMENU
virtual void	TObject::Error(const char* method, const char* msgfmt) const
virtual void	TObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual void	TObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual void	TObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
void	TBranch::ExpandBasketArrays()
virtual void	TObject::Fatal(const char* method, const char* msgfmt) const
virtual Int_t	Fill()
virtual void	TNamed::FillBuffer(char*& buffer)
virtual TBranch*	TBranch::FindBranch(const char* name)
virtual TLeaf*	TBranch::FindLeaf(const char* name)
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
Int_t	TBranch::FlushBaskets()
Int_t	TBranch::FlushOneBasket(UInt_t which)
virtual char*	TBranch::GetAddress() const
TBasket*	TBranch::GetBasket(Int_t basket)
Int_t*	TBranch::GetBasketBytes() const
Long64_t*	TBranch::GetBasketEntry() const
virtual Long64_t	TBranch::GetBasketSeek(Int_t basket) const
virtual Int_t	TBranch::GetBasketSize() const
virtual TList*	TBranch::GetBrowsables()
virtual const char*	TBranch::GetClassName() const
Int_t	TBranch::GetCompressionAlgorithm() const
Int_t	TBranch::GetCompressionLevel() const
Int_t	TBranch::GetCompressionSettings() const
TDirectory*	TBranch::GetDirectory() const
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
Long64_t	TBranch::GetEntries() const
virtual Int_t	TBranch::GetEntry(Long64_t entry = 0, Int_t getall = 0)
virtual Int_t	TBranch::GetEntryExport(Long64_t entry, Int_t getall, TClonesArray* list, Int_t n)
Long64_t	TBranch::GetEntryNumber() const
Int_t	TBranch::GetEntryOffsetLen() const
Int_t	TBranch::GetEvent(Long64_t entry = 0)
virtual Int_t	TBranch::GetExpectedType(TClass*& clptr, EDataType& type)
virtual TFile*	TBranch::GetFile(Int_t mode = 0)
const char*	TBranch::GetFileName() const
virtual Color_t	TAttFill::GetFillColor() const
virtual Style_t	TAttFill::GetFillStyle() const
Long64_t	TBranch::GetFirstEntry() const
virtual const char*	TBranch::GetIconName() const
virtual TLeaf*	TBranch::GetLeaf(const char* name) const
TObjArray*	TBranch::GetListOfBaskets()
TObjArray*	TBranch::GetListOfBranches()
TObjArray*	TBranch::GetListOfLeaves()
virtual Bool_t	TBranch::GetMakeClass() const
Int_t	TBranch::GetMaxBaskets() const
TBranch*	TBranch::GetMother() const
virtual const char*	TNamed::GetName() const
Int_t	TBranch::GetNleaves() const
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_t	TObject::GetObjectStat()
Int_t	TBranch::GetOffset() const
virtual Option_t*	TObject::GetOption() const
Int_t	TBranch::GetReadBasket() const
Long64_t	TBranch::GetReadEntry() const
TRefTable*	GetRefTable() const
virtual Int_t	TBranch::GetRow(Int_t row)
Int_t	TBranch::GetSplitLevel() const
TBranch*	TBranch::GetSubBranch(const TBranch* br) const
virtual const char*	TNamed::GetTitle() const
Long64_t	TBranch::GetTotalSize(Option_t* option = "") const
Long64_t	TBranch::GetTotBytes(Option_t* option = "") const
TTree*	TBranch::GetTree() const
virtual UInt_t	TObject::GetUniqueID() const
Int_t	TBranch::GetWriteBasket() const
Long64_t	TBranch::GetZipBytes(Option_t* option = "") const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
virtual ULong_t	TNamed::Hash() const
virtual void	TObject::Info(const char* method, const char* msgfmt) const
virtual Bool_t	TObject::InheritsFrom(const char* classname) const
virtual Bool_t	TObject::InheritsFrom(const TClass* cl) const
virtual void	TObject::Inspect() constMENU
void	TObject::InvertBit(UInt_t f)
virtual TClass*	IsA() const
Bool_t	TBranch::IsAutoDelete() const
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
virtual Bool_t	TBranch::IsFolder() const
Bool_t	TObject::IsOnHeap() const
virtual Bool_t	TNamed::IsSortable() const
virtual Bool_t	TAttFill::IsTransparent() const
Bool_t	TObject::IsZombie() const
virtual void	TBranch::KeepCircular(Long64_t maxEntries)
virtual Int_t	TBranch::LoadBaskets()
virtual void	TNamed::ls(Option_t* option = "") const
void	TObject::MayNotUse(const char* method) const
virtual void	TAttFill::Modify()
virtual Bool_t	Notify()
void	TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
static void	TObject::operator delete(void* ptr)
static void	TObject::operator delete(void* ptr, void* vp)
static void	TObject::operator delete[](void* ptr)
static void	TObject::operator delete[](void* ptr, void* vp)
void*	TObject::operator new(size_t sz)
void*	TObject::operator new(size_t sz, void* vp)
void*	TObject::operator new[](size_t sz)
void*	TObject::operator new[](size_t sz, void* vp)
TNamed&	TNamed::operator=(const TNamed& rhs)
virtual void	TObject::Paint(Option_t* option = "")
virtual void	TObject::Pop()
virtual void	Print(Option_t* option = "") const
virtual Int_t	TObject::Read(const char* name)
virtual void	TBranch::ReadBasket(TBuffer& b)
virtual void	TObject::RecursiveRemove(TObject* obj)
virtual void	TBranch::Refresh(TBranch* b)
virtual void	Reset(Option_t* option = "")
virtual void	TBranch::ResetAddress()
virtual void	ResetAfterMerge(TFileMergeInfo*)
virtual void	TAttFill::ResetAttFill(Option_t* option = "")
void	TObject::ResetBit(UInt_t f)
static void	TBranch::ResetCount()
virtual void	TBranch::ResetReadEntry()
virtual void	TObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual void	TAttFill::SaveFillAttributes(ostream& out, const char* name, Int_t coldef = 1, Int_t stydef = 1001)
virtual void	TObject::SavePrimitive(ostream& out, Option_t* option = "")
virtual void	TBranch::SetAddress(void* add)
virtual void	TBranch::SetAutoDelete(Bool_t autodel = kTRUE)
virtual void	TBranch::SetBasketSize(Int_t buffsize)
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
virtual void	TBranch::SetBufferAddress(TBuffer* entryBuffer)
void	TBranch::SetCompressionAlgorithm(Int_t algorithm = 0)
void	TBranch::SetCompressionLevel(Int_t level = 1)
void	TBranch::SetCompressionSettings(Int_t settings = 1)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
virtual void	TBranch::SetEntries(Long64_t entries)
virtual void	TBranch::SetEntryOffsetLen(Int_t len, Bool_t updateSubBranches = kFALSE)
virtual void	TBranch::SetFile(TFile* file = 0)
virtual void	TBranch::SetFile(const char* filename)
virtual void	TAttFill::SetFillAttributes()MENU
virtual void	TAttFill::SetFillColor(Color_t fcolor)
virtual void	TAttFill::SetFillStyle(Style_t fstyle)
virtual void	TBranch::SetFirstEntry(Long64_t entry)
virtual Bool_t	TBranch::SetMakeClass(Bool_t decomposeObj = kTRUE)
virtual void	TNamed::SetName(const char* name)MENU
virtual void	TNamed::SetNameTitle(const char* name, const char* title)
virtual void	TBranch::SetObject(void* objadd)
static void	TObject::SetObjectStat(Bool_t stat)
virtual void	TBranch::SetOffset(Int_t offset = 0)
virtual Int_t	SetParent(const TObject* obj, Int_t branchID)
virtual void	SetRequestedEntry(Long64_t entry)
virtual void	TBranch::SetStatus(Bool_t status = 1)
virtual void	TNamed::SetTitle(const char* title = "")MENU
virtual void	TBranch::SetTree(TTree* tree)
virtual void	TObject::SetUniqueID(UInt_t uid)
virtual void	TBranch::SetupAddresses()
virtual void	ShowMembers(TMemberInspector& insp)
virtual Int_t	TNamed::Sizeof() const
virtual void	Streamer(TBuffer& b)
void	StreamerNVirtual(TBuffer& b)
virtual void	TObject::SysError(const char* method, const char* msgfmt) const
Bool_t	TObject::TestBit(UInt_t f) const
Int_t	TObject::TestBits(UInt_t f) const
virtual void	TBranch::UpdateAddress()
virtual void	TBranch::UpdateFile()
virtual void	TObject::UseCurrentStyle()
virtual void	TObject::Warning(const char* method, const char* msgfmt) const
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const

protected:

virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
void	FillLeavesImpl(TBuffer& b)
TBasket*	TBranch::GetFreshBasket()
TString	TBranch::GetRealFileName() const
void	TBranch::Init(const char* name, const char* leaflist, Int_t compress)
void	TObject::MakeZombie()
void	TBranch::ReadLeaves0Impl(TBuffer& b)
void	TBranch::ReadLeaves1Impl(TBuffer& b)
void	TBranch::ReadLeaves2Impl(TBuffer& b)
void	ReadLeavesImpl(TBuffer& b)
void	TBranch::SetSkipZip(Bool_t skip = kTRUE)
Int_t	TBranch::WriteBasket(TBasket* basket, Int_t where)

Data Members

public:

enum TBranch::EStatusBits {	kAutoDelete
	kDoNotUseBufferMap
};
enum TObject::EStatusBits {	kCanDelete
	kMustCleanup
	kObjInCanvas
	kIsReferenced
	kHasUUID
	kCannotPick
	kNoContextMenu
	kInvalidObject
};
enum TObject::[unnamed] {	kIsOnHeap
	kNotDeleted
	kZombie
	kBitMask
	kSingleKey
	kOverwrite
	kWriteDelete
};

protected:

char*	TBranch::fAddress	! Address of 1st leaf (variable or object)
Int_t*	TBranch::fBasketBytes	[fMaxBaskets] Lenght of baskets on file
Long64_t*	TBranch::fBasketEntry	[fMaxBaskets] Table of first entry in eack basket
Long64_t*	TBranch::fBasketSeek	[fMaxBaskets] Addresses of baskets on file
Int_t	TBranch::fBasketSize	Initial Size of Basket Buffer
TObjArray	TBranch::fBaskets	-> List of baskets of this branch
TObjArray	TBranch::fBranches	-> List of Branches of this branch
TList*	TBranch::fBrowsables	! List of TVirtualBranchBrowsables used for Browse()
Int_t	TBranch::fCompress	Compression level and algorithm
TBasket*	TBranch::fCurrentBasket	! Pointer to the current basket.
TDirectory*	TBranch::fDirectory	! Pointer to directory where this branch buffers are stored
Long64_t	TBranch::fEntries	Number of entries
TBuffer*	TBranch::fEntryBuffer	! Buffer used to directly pass the content without streaming
Long64_t	TBranch::fEntryNumber	Current entry number (last one filled in this branch)
Int_t	TBranch::fEntryOffsetLen	Initial Length of fEntryOffset table in the basket buffers
TString	TBranch::fFileName	Name of file where buffers are stored ("" if in same file as Tree header)
Color_t	TAttFill::fFillColor	fill area color
G__p2memfunc	TBranch::fFillLeaves	! Pointer to the FillLeaves implementation to use.
Style_t	TAttFill::fFillStyle	fill area style
Long64_t	TBranch::fFirstBasketEntry	! First entry in the current basket.
Long64_t	TBranch::fFirstEntry	Number of the first entry in this branch
TObjArray	TBranch::fLeaves	-> List of leaves of this branch
Int_t	TBranch::fMaxBaskets	Maximum number of Baskets so far
TBranch*	TBranch::fMother	! Pointer to top-level parent branch in the tree.
Int_t	TBranch::fNBaskets	! Number of baskets in memory
TString	TNamed::fName	object identifier
Long64_t	TBranch::fNextBasketEntry	! Next entry that will requires us to go to the next basket
Int_t	TBranch::fNleaves	! Number of leaves
Int_t	TBranch::fOffset	Offset of this branch
TBranch*	TBranch::fParent	! Pointer to parent branch.
Int_t	TBranch::fReadBasket	! Current basket number when reading
Long64_t	TBranch::fReadEntry	! Current entry number when reading
G__p2memfunc	TBranch::fReadLeaves	! Pointer to the ReadLeaves implementation to use.
TRefTable*	fRefTable	pointer to the TRefTable
Bool_t	TBranch::fSkipZip	! After being read, the buffer will not be unziped.
Int_t	TBranch::fSplitLevel	Branch split level
TString	TNamed::fTitle	object title
Long64_t	TBranch::fTotBytes	Total number of bytes in all leaves before compression
TTree*	TBranch::fTree	! Pointer to Tree header
Int_t	TBranch::fWriteBasket	Last basket number written
Long64_t	TBranch::fZipBytes	Total number of bytes in all leaves after compression
static Int_t	TBranch::fgCount	! branch counter

private:

Long64_t	fRequestedEntry	! Cursor indicating which entry is being requested.

Class Charts

Inheritance Inherited Members Includes Libraries

Function documentation

TBranchRef()

 Default constructor.

TBranchRef(TTree* tree)

 Main constructor called by TTree::BranchRef.

~TBranchRef()

 Typical destructor.

void Clear(Option_t* option = "")

 Clear entries in the TRefTable.

Int_t Fill()

 Fill the branch basket with the referenced objects parent numbers.

Bool_t Notify()

 This function is called by TRefTable::Notify, itself called by
 TRef::GetObject.
 The function reads the branch containing the object referenced
 by the TRef.

void Print(Option_t* option = "") const

 Print the TRefTable branch.

void ReadLeavesImpl(TBuffer& b)

 This function called by TBranch::GetEntry overloads TBranch::ReadLeaves.

void FillLeavesImpl(TBuffer& b)

 This function called by TBranch::Fill overloads TBranch::FillLeaves.

void Reset(Option_t* option = "")

    Existing buffers are deleted
    Entries, max and min are reset
    TRefTable is cleared.

void ResetAfterMerge(TFileMergeInfo* )

 Reset a Branch after a Merge operation (drop data but keep customizations)
 TRefTable is cleared.

Int_t SetParent(const TObject* obj, Int_t branchID)

 -- Set the current parent branch.

 This function is called by TBranchElement::GetEntry()
 and TBranchElement::Fill() when reading or writing
 branches that may contain referenced objects.

TRefTable * GetRefTable() const

{return fRefTable;}

void SetRequestedEntry(Long64_t entry)

{fRequestedEntry = entry;}