Manages buffers for branches of a Tree.

See picture in TTree.

Definition at line 38 of file TBasket.h.

Public Member Functions
	TBasket ()
	Size of the buffer last time we wrote it to disk. More...

	TBasket (TDirectory *motherDir)
	Constructor used during reading. More...

	TBasket (const char name, const char title, TBranch *branch)
	Basket normal constructor, used during writing. More...

virtual	~TBasket ()
	Basket destructor. More...

virtual void	AdjustSize (Int_t newsize)
	Increase the size of the current fBuffer up to newsize. More...

virtual void	DeleteEntryOffset ()
	Delete fEntryOffset array. More...

virtual Int_t	DropBuffers ()
	Drop buffers of this basket if it is not the current basket. More...

TBranch *	GetBranch () const

Int_t	GetBufferSize () const

Int_t *	GetDisplacement () const

Int_t *	GetEntryOffset () const

Int_t	GetEntryPointer (Int_t Entry)
	Get pointer to buffer for internal entry. More...

Int_t	GetNevBuf () const

Int_t	GetNevBufSize () const

Int_t	GetLast () const

virtual void	MoveEntries (Int_t dentries)
	Remove the first dentries of this basket, moving entries at dentries to the start of the buffer. More...

virtual void	PrepareBasket (Long64_t)

Int_t	ReadBasketBuffers (Long64_t pos, Int_t len, TFile *file)
	Read basket buffers in memory and cleanup. More...

Int_t	ReadBasketBytes (Long64_t pos, TFile *file)
	Read basket buffers in memory and cleanup. More...

virtual void	Reset ()
	Reset the basket to the starting state. More...

Int_t	LoadBasketBuffers (Long64_t pos, Int_t len, TFile file, TTree tree=0)
	Load basket buffers in memory without unziping. More...

Long64_t	CopyTo (TFile *to)
	Copy the basket of this branch onto the file to. More...

void	SetBranch (TBranch *branch)

void	SetNevBufSize (Int_t n)

virtual void	SetReadMode ()
	Set read mode of basket. More...

virtual void	SetWriteMode ()
	Set write mode of basket. More...

void	Update (Int_t newlast)

virtual void	Update (Int_t newlast, Int_t skipped)
	Update basket header and EntryOffset table. More...

virtual Int_t	WriteBuffer ()
	Write buffer of this basket on the current file. More...

	ClassDef (TBasket, 2)

Public Member Functions inherited from TKey
	TKey ()

	TKey (TDirectory *motherDir)
	TKey default constructor. More...

	TKey (TDirectory *motherDir, const TKey &orig, UShort_t pidOffset)
	Copy a TKey from its original directory to the new 'motherDir'. More...

	TKey (const char name, const char title, const TClass cl, Int_t nbytes, TDirectory motherDir)
	Create a TKey object with the specified name, title for the given class. More...

	TKey (const TString &name, const TString &title, const TClass cl, Int_t nbytes, TDirectory motherDir)
	Create a TKey object with the specified name, title for the given class. More...

	TKey (const TObject obj, const char name, Int_t bufsize, TDirectory *motherDir)
	Create a TKey object for a TObject* and fill output buffer. More...

	TKey (const void obj, const TClass cl, const char name, Int_t bufsize, TDirectory motherDir)
	Create a TKey object for any object obj of class cl d and fill output buffer. More...

	TKey (Long64_t pointer, Int_t nbytes, TDirectory *motherDir=0)
	Create a TKey object to read keys. More...

virtual	~TKey ()
	TKey default destructor. More...

virtual void	Browse (TBrowser *b)
	Read object from disk and call its Browse() method. More...

virtual void	Delete (Option_t *option="")
	Delete an object from the file. More...

virtual void	DeleteBuffer ()
	Delete key buffer(s). More...

virtual void	FillBuffer (char *&buffer)
	Encode key header into output buffer. More...

virtual const char *	GetClassName () const

virtual const char *	GetIconName () const
	Title can keep 32x32 xpm thumbnail/icon of the parent object. More...

virtual const char *	GetTitle () const
	Returns title (title can contain 32x32 xpm thumbnail/icon). More...

virtual char *	GetBuffer () const

TBuffer *	GetBufferRef () const

Short_t	GetCycle () const
	Return cycle number associated to this key. More...

const TDatime &	GetDatime () const

TFile *	GetFile () const
	Returns file to which key belong. More...

Short_t	GetKeep () const
	Returns the "KEEP" status. More...

Int_t	GetKeylen () const

TDirectory *	GetMotherDir () const

Int_t	GetNbytes () const

Int_t	GetObjlen () const

Int_t	GetVersion () const

virtual Long64_t	GetSeekKey () const

virtual Long64_t	GetSeekPdir () const

virtual ULong_t	Hash () const
	This Hash function should redefine the default from TNamed. More...

virtual void	IncrementPidOffset (UShort_t offset)
	Increment fPidOffset by 'offset'. More...

Bool_t	IsFolder () const
	Check if object referenced by the key is a folder. More...

virtual void	Keep ()
	Set the "KEEP" status. More...

virtual void	ls (Option_t *option="") const
	List Key contents. More...

virtual void	Print (Option_t *option="") const
	Print key contents. More...

virtual Int_t	Read (TObject *obj)
	To read an object from the file. More...

virtual TObject *	ReadObj ()
	To read a TObject* from the file. More...

virtual TObject *	ReadObjWithBuffer (char *bufferRead)
	To read a TObject* from bufferRead. More...

virtual void *	ReadObjectAny (const TClass *expectedClass)
	To read an object (non deriving from TObject) from the file. More...

virtual void	ReadBuffer (char *&buffer)
	Decode input buffer. More...

void	ReadKeyBuffer (char *&buffer)
	Decode input buffer. More...

virtual Bool_t	ReadFile ()
	Read the key structure from the file. More...

virtual void	SetBuffer ()

virtual void	SetParent (const TObject *parent)
	Set parent in key buffer. More...

void	SetMotherDir (TDirectory *dir)

virtual Int_t	Sizeof () const
	Return the size in bytes of the key header structure. More...

virtual Int_t	WriteFile (Int_t cycle=1, TFile *f=0)
	Write the encoded object supported by this key. More...

	ClassDef (TKey, 4)

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)

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

virtual	~TNamed ()

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

virtual TObject *	Clone (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 const char *	GetName () const
	Returns name of 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...

Public Member Functions inherited from TObject
	TObject ()

	TObject (const TObject &object)
	TObject copy ctor. More...

TObject &	operator= (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 const char *	ClassName () const
	Returns name of class to which the object belongs. 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 TObject *	DrawClone (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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes. More...

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

virtual Option_t *	GetDrawOption () 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 Option_t *	GetOption () 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	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 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...

void *	operator new (size_t sz)

void *	operator new[] (size_t sz)

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

void *	operator 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 Attributes
Int_t	fBufferSize

Int_t	fNevBufSize

Int_t	fNevBuf

Int_t	fLast

Bool_t	fHeaderOnly

Int_t *	fDisplacement

Int_t *	fEntryOffset
	[fNevBuf] Displacement of entries in fBuffer(TKey) More...

TBranch *	fBranch

TBuffer *	fCompressedBufferRef

Bool_t	fOwnsCompressedBuffer
	Compressed buffer. More...

Int_t	fLastWriteBufferSize
	Whether or not we own the compressed buffer. More...

Protected Attributes inherited from TKey
Int_t	fVersion
	Key version identifier. More...

Int_t	fNbytes
	Number of bytes for the object on file. More...

Int_t	fObjlen
	Length of uncompressed object in bytes. More...

TDatime	fDatime
	Date/Time of insertion in file. More...

Short_t	fKeylen
	Number of bytes for the key itself. More...

Short_t	fCycle
	Cycle number. More...

Long64_t	fSeekKey
	Location of object on file. More...

Long64_t	fSeekPdir
	Location of parent directory on file. More...

TString	fClassName
	Object Class name. More...

Int_t	fLeft
	Number of bytes left in current segment. More...

char *	fBuffer
	Object buffer. More...

TBuffer *	fBufferRef
	Pointer to the TBuffer object. More...

UShort_t	fPidOffset
	!Offset to be added to the pid index in this key/buffer. This is actually saved in the high bits of fSeekPdir More...

TDirectory *	fMotherDir
	!pointer to mother directory More...

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Private Member Functions
	TBasket (const TBasket &)

TBasket &	operator= (const TBasket &)

Int_t	ReadBasketBuffersUnzip (char , Int_t, Bool_t, TFile )
	We always create the TBuffer for the basket but it hold the buffer from the cache. More...

Int_t	ReadBasketBuffersUncompressedCase ()
	By-passing buffer unzipping has been requested and is possible (only 1 entry in this basket). More...

void	InitializeCompressedBuffer (Int_t len, TFile *file)
	Initialize the compressed buffer; either from the TTree or create a local one. More...

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

Protected Member Functions inherited from TKey
virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory. More...

virtual void	Create (Int_t nbytes, TFile *f=0)
	Create a TKey object of specified size. More...

void	Build (TDirectory motherDir, const char classname, Long64_t filepos)
	Method used in all TKey constructor to initialize basic data fields. More...

virtual Int_t	WriteFileKeepBuffer (TFile *f=0)
	Write the encoded object supported by this key. 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...

#include <TBasket.h>

Inheritance diagram for TBasket:

Collaboration diagram for TBasket:

Constructor & Destructor Documentation

TBasket::TBasket ( const TBasket & )

private

TBasket::TBasket ( )

Size of the buffer last time we wrote it to disk.

TBasket::TBasket ( TDirectory * motherDir )

Constructor used during reading.

Definition at line 67 of file TBasket.cxx.

TBasket::TBasket	(	const char *	name,
		const char *	title,
		TBranch *	branch
	)

Basket normal constructor, used during writing.

Definition at line 84 of file TBasket.cxx.

TBasket::~TBasket ( )

virtual

Basket destructor.

Definition at line 129 of file TBasket.cxx.

Member Function Documentation

void TBasket::AdjustSize ( Int_t newsize )

virtual

Increase the size of the current fBuffer up to newsize.

Definition at line 148 of file TBasket.cxx.

Referenced by TBranch::SetBasketSize().

TBasket::ClassDef	(	TBasket	,
		2
	)

Long64_t TBasket::CopyTo ( TFile * to )

Copy the basket of this branch onto the file to.

Definition at line 163 of file TBasket.cxx.

Referenced by TTreeCloner::WriteBaskets().

void TBasket::DeleteEntryOffset ( )

virtual

Delete fEntryOffset array.

Definition at line 181 of file TBasket.cxx.

Int_t TBasket::DropBuffers ( )

virtual

Drop buffers of this basket if it is not the current basket.

Definition at line 191 of file TBasket.cxx.

Referenced by TBranch::DropBaskets(), TTree::DropBuffers(), TBranch::FlushOneBasket(), and TBranch::WriteBasket().

TBranch* TBasket::GetBranch ( ) const

inline

Definition at line 74 of file TBasket.h.

Int_t TBasket::GetBufferSize ( ) const

inline

Definition at line 75 of file TBasket.h.

Referenced by TBranch::AddBasket(), and TBranch__SetTree().

Int_t* TBasket::GetDisplacement ( ) const

inline

Definition at line 76 of file TBasket.h.

Referenced by TBranch::GetEntry(), and TBranch::GetEntryExport().

Int_t* TBasket::GetEntryOffset ( ) const

inline

Definition at line 77 of file TBasket.h.

Referenced by TBranch::GetEntry(), TBranch::GetEntryExport(), TBranchElement::IsMissingCollection(), and TLeafC::ReadBasket().

Int_t TBasket::GetEntryPointer ( Int_t Entry )

Get pointer to buffer for internal entry.

Definition at line 211 of file TBasket.cxx.

Int_t TBasket::GetLast ( ) const

inline

Definition at line 81 of file TBasket.h.

Referenced by TBranch::FillEntryBuffer(), TBranchElement::IsMissingCollection(), and TLeafC::ReadBasket().

Int_t TBasket::GetNevBuf ( ) const

inline

Definition at line 79 of file TBasket.h.

Referenced by TBranch::AddBasket(), TTreeCloner::CopyMemoryBaskets(), TBranch::DropBaskets(), TBranch::Fill(), TBranch::FillEntryBuffer(), TBranch::FlushOneBasket(), TBranch::GetTotalSize(), TBranch::WriteBasket(), and TTreeCloner::WriteBaskets().

Int_t TBasket::GetNevBufSize ( ) const

inline

Definition at line 80 of file TBasket.h.

Referenced by TBranch::Fill(), TBranch::GetEntry(), TBranch::GetEntryExport(), and TBranchElement::IsMissingCollection().

void TBasket::InitializeCompressedBuffer	(	Int_t	len,
		TFile *	file
	)

inlineprivate

Initialize the compressed buffer; either from the TTree or create a local one.

Definition at line 411 of file TBasket.cxx.

Referenced by ReadBasketBuffers(), and WriteBuffer().

Int_t TBasket::LoadBasketBuffers	(	Long64_t	pos,
		Int_t	len,
		TFile *	file,
		TTree *	tree = `0`
	)

Load basket buffers in memory without unziping.

This function is called by TTreeCloner. The function returns 0 in case of success, 1 in case of error.

Definition at line 225 of file TBasket.cxx.

Referenced by TTreeCloner::WriteBaskets().

void TBasket::MoveEntries ( Int_t dentries )

virtual

Remove the first dentries of this basket, moving entries at dentries to the start of the buffer.

Definition at line 290 of file TBasket.cxx.

Referenced by TBranch::KeepCircular().

TBasket& TBasket::operator= ( const TBasket & )

private

virtual void TBasket::PrepareBasket ( Long64_t )

inlinevirtual

Reimplemented in TBasketSQL.

Definition at line 83 of file TBasket.h.

Referenced by TBranch::GetEntry().

Int_t TBasket::ReadBasketBuffers	(	Long64_t	pos,
		Int_t	len,
		TFile *	file
	)

Read basket buffers in memory and cleanup.

Read a basket buffer. Check if buffers of previous ReadBasket should not be dropped. Remember, we keep buffers in memory up to fMaxVirtualSize. The function returns 0 in case of success, 1 in case of error This function was modified with the addition of the parallel unzipping, it will try to get the unzipped file from the cache receiving only a pointer to that buffer (so we shall not delete that pointer), although we get a new buffer in case it's not found in the cache. There is a lot of code duplication but it was necesary to assure the expected behavior when there is no cache.

Definition at line 435 of file TBasket.cxx.

Referenced by TBranch::GetBasket(), TBranch::GetEntry(), and TBranch::LoadBaskets().

Int_t TBasket::ReadBasketBuffersUncompressedCase ( )

private

By-passing buffer unzipping has been requested and is possible (only 1 entry in this basket).

Definition at line 337 of file TBasket.cxx.

Referenced by ReadBasketBuffers(), and ReadBasketBuffersUnzip().

Int_t TBasket::ReadBasketBuffersUnzip	(	char *	buffer,
		Int_t	size,
		Bool_t	mustFree,
		TFile *	file
	)

private

We always create the TBuffer for the basket but it hold the buffer from the cache.

Definition at line 359 of file TBasket.cxx.

Referenced by ReadBasketBuffers().

Int_t TBasket::ReadBasketBytes	(	Long64_t	pos,
		TFile *	file
	)

Read basket buffers in memory and cleanup.

Read first bytes of a logical record starting at position pos return record length (first 4 bytes of record).

Definition at line 645 of file TBasket.cxx.

Referenced by TBranch::GetBasket(), TBranch::LoadBaskets(), and TTreeCloner::WriteBaskets().

void TBasket::Reset ( void )

virtual

Reset the basket to the starting state.

i.e. as it was after calling the constructor (and potentially attaching a TBuffer.) Reduce memory used by fEntryOffset and the TBuffer if needed ..

Reimplemented from TKey.

Reimplemented in TBasketSQL.

Definition at line 660 of file TBasket.cxx.

Referenced by TBasketSQL::Reset(), TBranch::ResetAfterMerge(), and TBranch::WriteBasket().

void TBasket::SetBranch ( TBranch * branch )

inline

Definition at line 91 of file TBasket.h.

Referenced by TBranch::AddBasket(), TTreeCloner::CopyMemoryBaskets(), TBranch::Refresh(), and TTreeCloner::WriteBaskets().

void TBasket::SetNevBufSize ( Int_t n )

inline

Definition at line 92 of file TBasket.h.

Referenced by TBranch::Fill().

void TBasket::SetReadMode ( )

virtual

Set read mode of basket.

Definition at line 745 of file TBasket.cxx.

Referenced by TBranch::GetEntry(), and TBranch::GetEntryExport().

void TBasket::SetWriteMode ( )

virtual

Set write mode of basket.

Definition at line 754 of file TBasket.cxx.

Referenced by TBranch::Fill(), and TBranch::FlushOneBasket().

void TBasket::Update ( Int_t newlast )

inline

Definition at line 95 of file TBasket.h.

Referenced by TBranch::Fill(), TBranch::FillEntryBuffer(), and Update().

void TBasket::Update	(	Int_t	newlast,
		Int_t	skipped
	)

virtual

Update basket header and EntryOffset table.

Reimplemented in TBasketSQL.

Definition at line 877 of file TBasket.cxx.

Int_t TBasket::WriteBuffer ( )

virtual

Write buffer of this basket on the current file.

The function returns the number of bytes committed to the memory. If a write error occurs, the number of bytes returned is -1. If no data are written, the number of bytes returned is 0.

Definition at line 919 of file TBasket.cxx.

Referenced by TBranch::WriteBasket().