HBOOK Branch.

Definition at line 28 of file THbookBranch.h.

Public Member Functions
	THbookBranch ()

	THbookBranch (TTree tree, const char name, void address, const char leaflist, Int_t basketsize=32000, Int_t compress=-1)

	THbookBranch (TBranch branch, const char name, void address, const char leaflist, Int_t basketsize=32000, Int_t compress=-1)

virtual	~THbookBranch ()

virtual void	Browse (TBrowser *b)
	Browser interface. More...

virtual Int_t	GetEntry (Long64_t entry=0, Int_t getall=0)
	get one entry from hbook ntuple More...

const char *	GetBlockName () const

virtual void	SetAddress (void *addobj)
	Set address of this branch See important remark in the header of THbookTree. More...

void	SetBlockName (const char *name)

virtual void	SetEntries (Long64_t n)
	Set the number of entries in this branch. More...

Public Member Functions inherited from TBranch
	TBranch ()

	TBranch (TTree tree, const char name, void address, const char leaflist, Int_t basketsize=32000, Int_t compress=-1)
	Create a Branch as a child of a Tree. More...

	TBranch (TBranch parent, const char name, void address, const char leaflist, Int_t basketsize=32000, Int_t compress=-1)
	Create a Branch as a child of another Branch. More...

virtual	~TBranch ()
	Destructor. More...

virtual void	AddBasket (TBasket &b, Bool_t ondisk, Long64_t startEntry)
	Add the basket to this branch. More...

virtual void	AddLastBasket (Long64_t startEntry)
	Add the start entry of the write basket (not yet created) More...

virtual void	DeleteBaskets (Option_t *option="")
	Loop on all branch baskets. More...

virtual void	DropBaskets (Option_t *option="")
	Loop on all branch baskets. More...

void	ExpandBasketArrays ()
	Increase BasketEntry buffer of a minimum of 10 locations and a maximum of 50 per cent of current size. More...

virtual Int_t	Fill ()
	Loop on all leaves of this branch to fill Basket buffer. More...

virtual TBranch *	FindBranch (const char *name)
	Find the immediate sub-branch with passed name. More...

virtual TLeaf *	FindLeaf (const char *name)
	Find the leaf corresponding to the name 'searchname'. More...

Int_t	FlushBaskets ()
	Flush to disk all the baskets of this branch and any of subbranches. More...

Int_t	FlushOneBasket (UInt_t which)
	If we have a write basket in memory and it contains some entries and has not yet been written to disk, we write it and delete it from memory. More...

virtual char *	GetAddress () const

TBasket *	GetBasket (Int_t basket)
	Return pointer to basket basketnumber in this Branch. More...

Int_t *	GetBasketBytes () const

Long64_t *	GetBasketEntry () const

virtual Long64_t	GetBasketSeek (Int_t basket) const
	Return address of basket in the file. More...

virtual Int_t	GetBasketSize () const

virtual TList *	GetBrowsables ()
	Returns (and, if 0, creates) browsable objects for this branch See TVirtualBranchBrowsable::FillListOfBrowsables. More...

virtual const char *	GetClassName () const
	Return the name of the user class whose content is stored in this branch, if any. More...

Int_t	GetCompressionAlgorithm () const

Int_t	GetCompressionLevel () const

Int_t	GetCompressionSettings () const

TDirectory *	GetDirectory () const

virtual Int_t	GetEntryExport (Long64_t entry, Int_t getall, TClonesArray *list, Int_t n)
	Read all leaves of an entry and export buffers to real objects in a TClonesArray list. More...

Int_t	GetEntryOffsetLen () const

Int_t	GetEvent (Long64_t entry=0)

const char *	GetIconName () const
	Return icon name depending on type of branch. More...

virtual Int_t	GetExpectedType (TClass *&clptr, EDataType &type)
	Fill expectedClass and expectedType with information on the data type of the object/values contained in this branch (and thus the type of pointers expected to be passed to Set[Branch]Address return 0 in case of success and > 0 in case of failure. More...

virtual TLeaf *	GetLeaf (const char *name) const
	Return pointer to the 1st Leaf named name in thisBranch. More...

virtual TFile *	GetFile (Int_t mode=0)
	Return pointer to the file where branch buffers reside, returns 0 in case branch buffers reside in the same file as tree header. More...

const char *	GetFileName () const

Int_t	GetOffset () const

Int_t	GetReadBasket () const

Long64_t	GetReadEntry () const

Int_t	GetWriteBasket () const

Long64_t	GetTotalSize (Option_t *option="") const
	Return total number of bytes in the branch (including current buffer) More...

Long64_t	GetTotBytes (Option_t *option="") const
	Return total number of bytes in the branch (excluding current buffer) if option ="*" includes all sub-branches of this branch too. More...

Long64_t	GetZipBytes (Option_t *option="") const
	Return total number of zip bytes in the branch if option ="*" includes all sub-branches of this branch too. More...

Long64_t	GetEntryNumber () const

Long64_t	GetFirstEntry () const

TObjArray *	GetListOfBaskets ()

TObjArray *	GetListOfBranches ()

TObjArray *	GetListOfLeaves ()

Int_t	GetMaxBaskets () const

Int_t	GetNleaves () const

Int_t	GetSplitLevel () const

Long64_t	GetEntries () const

TTree *	GetTree () const

virtual Int_t	GetRow (Int_t row)
	Return all elements of one row unpacked in internal array fValues [Actually just returns 1 (?)]. More...

virtual Bool_t	GetMakeClass () const
	Return whether this branch is in a mode where the object are decomposed or not (Also known as MakeClass mode). More...

TBranch *	GetMother () const
	Get our top-level parent branch in the tree. More...

TBranch *	GetSubBranch (const TBranch *br) const
	Find the parent branch of child. More...

Bool_t	IsAutoDelete () const
	Return kTRUE if an existing object in a TBranchObject must be deleted. More...

Bool_t	IsFolder () const
	Return kTRUE if more than one leaf or browsables, kFALSE otherwise. More...

virtual void	KeepCircular (Long64_t maxEntries)
	keep a maximum of fMaxEntries in memory More...

virtual Int_t	LoadBaskets ()
	Baskets associated to this branch are forced to be in memory. More...

virtual void	Print (Option_t *option="") const
	Print TBranch parameters. More...

virtual void	ReadBasket (TBuffer &b)
	Loop on all leaves of this branch to read Basket buffer. More...

virtual void	Refresh (TBranch *b)
	Refresh this branch using new information in b This function is called by TTree::Refresh. More...

virtual void	Reset (Option_t *option="")
	Reset a Branch. More...

virtual void	ResetAfterMerge (TFileMergeInfo *)
	Reset a Branch. More...

virtual void	ResetAddress ()
	Reset the address of the branch. More...

virtual void	ResetReadEntry ()

virtual void	SetObject (void *objadd)
	Set object this branch is pointing to. More...

virtual void	SetAutoDelete (Bool_t autodel=kTRUE)
	Set the automatic delete bit. More...

virtual void	SetBasketSize (Int_t buffsize)
	Set the basket size The function makes sure that the basket size is greater than fEntryOffsetlen. More...

virtual void	SetBufferAddress (TBuffer *entryBuffer)
	Set address of this branch directly from a TBuffer to avoid streaming. More...

void	SetCompressionAlgorithm (Int_t algorithm=0)
	Set compression algorithm. More...

void	SetCompressionLevel (Int_t level=1)
	Set compression level. More...

void	SetCompressionSettings (Int_t settings=1)
	Set compression settings. More...

virtual void	SetEntryOffsetLen (Int_t len, Bool_t updateSubBranches=kFALSE)
	Update the default value for the branch's fEntryOffsetLen if and only if it was already non zero (and the new value is not zero) If updateExisting is true, also update all the existing branches. More...

virtual void	SetFirstEntry (Long64_t entry)
	set the first entry number (case of TBranchSTL) More...

virtual void	SetFile (TFile *file=0)
	Set file where this branch writes/reads its buffers. More...

virtual void	SetFile (const char *filename)
	Set file where this branch writes/reads its buffers. More...

virtual Bool_t	SetMakeClass (Bool_t decomposeObj=kTRUE)
	Set the branch in a mode where the object are decomposed (Also known as MakeClass mode). More...

virtual void	SetOffset (Int_t offset=0)

virtual void	SetStatus (Bool_t status=1)
	Set branch status to Process or DoNotProcess. More...

virtual void	SetTree (TTree *tree)

virtual void	SetupAddresses ()
	If the branch address is not set, we set all addresses starting with the top level parent branch. More...

virtual void	UpdateAddress ()

virtual void	UpdateFile ()
	Refresh the value of fDirectory (i.e. More...

	ClassDef (TBranch, 12)

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

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

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

Public Member Functions inherited from TAttFill
	TAttFill ()

	TAttFill (Color_t fcolor, Style_t fstyle)
	AttFill normal constructor. More...

virtual	~TAttFill ()
	AttFill destructor. More...

void	Copy (TAttFill &attfill) const
	Copy this fill attributes to a new TAttFill. More...

virtual Color_t	GetFillColor () const

virtual Style_t	GetFillStyle () const

virtual Bool_t	IsTransparent () const

virtual void	Modify ()
	Change current fill area attributes if necessary. More...

virtual void	ResetAttFill (Option_t *option="")
	Reset this fill attributes to default values. More...

virtual void	SaveFillAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1001)
	Save fill attributes as C++ statement(s) on output stream out. More...

virtual void	SetFillAttributes ()
	Invoke the DialogCanvas Fill attributes. More...

virtual void	SetFillColor (Color_t fcolor)

virtual void	SetFillColorAlpha (Color_t fcolor, Float_t falpha)
	Set a transparent fill color. More...

virtual void	SetFillStyle (Style_t fstyle)

Protected Attributes
TString	fBlockName

Protected Attributes inherited from TBranch
Int_t	fCompress
	branch counter More...

Int_t	fBasketSize

Int_t	fEntryOffsetLen

Int_t	fWriteBasket

Long64_t	fEntryNumber

Int_t	fOffset

Int_t	fMaxBaskets

Int_t	fNBaskets

Int_t	fSplitLevel
	Number of baskets in memory. More...

Int_t	fNleaves

Int_t	fReadBasket
	Number of leaves. More...

Long64_t	fReadEntry
	Current basket number when reading. More...

Long64_t	fFirstBasketEntry
	Current entry number when reading. More...

Long64_t	fNextBasketEntry
	First entry in the current basket. More...

TBasket *	fCurrentBasket
	Next entry that will requires us to go to the next basket. More...

Long64_t	fEntries
	Pointer to the current basket. More...

Long64_t	fFirstEntry

Long64_t	fTotBytes

Long64_t	fZipBytes

TObjArray	fBranches

TObjArray	fLeaves

TObjArray	fBaskets

Int_t *	fBasketBytes

Long64_t *	fBasketEntry

Long64_t *	fBasketSeek

TTree *	fTree

TBranch *	fMother
	Pointer to Tree header. More...

TBranch *	fParent
	Pointer to top-level parent branch in the tree. More...

char *	fAddress
	Pointer to parent branch. More...

TDirectory *	fDirectory
	Address of 1st leaf (variable or object) More...

TString	fFileName
	Pointer to directory where this branch buffers are stored. More...

TBuffer *	fEntryBuffer

TList *	fBrowsables
	Buffer used to directly pass the content without streaming. More...

Bool_t	fSkipZip
	List of TVirtualBranchBrowsables used for Browse() More...

ReadLeaves_t	fReadLeaves

FillLeaves_t	fFillLeaves

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Protected Attributes inherited from TAttFill
Color_t	fFillColor

Style_t	fFillStyle

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 TBranch
static void	ResetCount ()
	Static function resetting fgCount. More...

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 Types inherited from TBranch
enum	EStatusBits { kAutoDelete = BIT(15), kDoNotUseBufferMap = BIT(22) }

typedef void(TBranch::*	ReadLeaves_t )(TBuffer &b)
	After being read, the buffer will not be unziped. More...

typedef void(TBranch::*	FillLeaves_t )(TBuffer &b)
	Pointer to the ReadLeaves implementation to use. More...

Protected Member Functions inherited from TBranch
void	ReadLeavesImpl (TBuffer &b)
	Pointer to the FillLeaves implementation to use. More...

void	ReadLeaves0Impl (TBuffer &b)
	Read zero leaves without the overhead of a loop. More...

void	ReadLeaves1Impl (TBuffer &b)
	Read one leaf without the overhead of a loop. More...

void	ReadLeaves2Impl (TBuffer &b)
	Read two leaves without the overhead of a loop. More...

void	FillLeavesImpl (TBuffer &b)
	Loop on all leaves of this branch to fill Basket buffer. More...

void	SetSkipZip (Bool_t skip=kTRUE)

void	Init (const char name, const char leaflist, Int_t compress)

TBasket *	GetFreshBasket ()
	Return a fresh basket by either resusing an existing basket that needs to be drop (according to TTree::MemoryFull) or create a new one. More...

Int_t	WriteBasket (TBasket *basket, Int_t where)
	Write the current basket to disk and return the number of bytes written to the file. More...

TString	GetRealFileName () const
	Get real file name. 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...

Static Protected Attributes inherited from TBranch
static Int_t	fgCount = 0

#include <THbookBranch.h>

Inheritance diagram for THbookBranch:

[legend]

Constructor & Destructor Documentation

THbookBranch::THbookBranch ( )

inline

Definition at line 34 of file THbookBranch.h.

THbookBranch::THbookBranch	(	TTree *	tree,
		const char *	name,
		void *	address,
		const char *	leaflist,
		Int_t	basketsize = `32000`,
		Int_t	compress = `-1`
	)

THbookBranch::THbookBranch	(	TBranch *	branch,
		const char *	name,
		void *	address,
		const char *	leaflist,
		Int_t	basketsize = `32000`,
		Int_t	compress = `-1`
	)

Definition at line 32 of file THbookBranch.cxx.

THbookBranch::~THbookBranch ( )

virtual

Definition at line 39 of file THbookBranch.cxx.

Member Function Documentation

void THbookBranch::Browse ( TBrowser * b )

virtual

Browser interface.

Reimplemented from TBranch.

Definition at line 47 of file THbookBranch.cxx.

const char* THbookBranch::GetBlockName ( ) const

inline

Definition at line 40 of file THbookBranch.h.

Referenced by SetAddress().

Int_t THbookBranch::GetEntry	(	Long64_t	entry = `0`,
		Int_t	getall = `0`
	)

virtual

get one entry from hbook ntuple

Reimplemented from TBranch.

Definition at line 59 of file THbookBranch.cxx.

void THbookBranch::SetAddress ( void * addobj )

virtual

Set address of this branch See important remark in the header of THbookTree.

Reimplemented from TBranch.

Definition at line 75 of file THbookBranch.cxx.

Referenced by THbookFile::ConvertRWN().

void THbookBranch::SetBlockName ( const char * name )

inline

Definition at line 42 of file THbookBranch.h.

Referenced by THbookFile::ConvertCWN(), and THbookFile::ConvertRWN().

virtual void THbookBranch::SetEntries ( Long64_t entries )

inlinevirtual

Set the number of entries in this branch.

Reimplemented from TBranch.

Definition at line 43 of file THbookBranch.h.

Referenced by THbookTree::SetEntries().

Member Data Documentation

TString THbookBranch::fBlockName

protected

Definition at line 31 of file THbookBranch.h.

Referenced by GetBlockName(), and SetBlockName().

Collaboration diagram for THbookBranch:

[legend]

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

hist/hbook/inc/THbookBranch.h
hist/hbook/src/THbookBranch.cxx

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation