TBasket Class Reference

Manages buffers for branches of a Tree.

See picture in TTree.

Definition at line 34 of file TBasket.h.

Public Types
enum	{ kSingleKey = (1ULL << (0)) , kOverwrite = (1ULL << (1)) , kWriteDelete = (1ULL << (2)) }
enum	{   kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,   kBitMask = 0x00ffffff }
enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << (3)) }
enum class	EIOBits : Char_t { kGenerateOffsetMap = (1ULL << (0)) , kSupported = kGenerateOffsetMap }
enum class	EUnsupportedIOBits : Char_t { kUnsupported = 0 }

Public Member Functions
	TBasket ()
	Default constructor.
	TBasket (const char *name, const char *title, TBranch *branch)
	Basket normal constructor, used during writing.
	TBasket (TDirectory *motherDir)
	Constructor used during reading.
	~TBasket () override
	Basket destructor.
void	AbstractMethod (const char *method) const
	Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.
virtual void	AdjustSize (Int_t newsize)
	Increase the size of the current fBuffer up to newsize.
virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.
void	Browse (TBrowser *b) override
	Read object from disk and call its Browse() method.
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.
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.
Long64_t	CopyTo (TFile *to)
	Copy the basket of this branch onto the file to.
void	Delete (Option_t *option="") override
	Delete an object from the file.
virtual void	DeleteBuffer ()
	Delete key buffer(s).
virtual void	DeleteEntryOffset ()
	Delete fEntryOffset array.
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 Int_t	DropBuffers ()
	Drop buffers of this basket if it is not the current basket.
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.
void	FillBuffer (char *&buffer) override
	Encode key header into output buffer.
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.
TBranch *	GetBranch () const
virtual char *	GetBuffer () const
TBuffer *	GetBufferRef () const
Int_t	GetBufferSize () const
virtual const char *	GetClassName () const
Short_t	GetCycle () const
	Return cycle number associated to this key.
const TDatime &	GetDatime () const
Int_t *	GetDisplacement () const
virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.
Int_t *	GetEntryOffset ()
Int_t	GetEntryPointer (Int_t Entry)
	Get pointer to buffer for internal entry.
TFile *	GetFile () const
	Returns file to which key belong.
const char *	GetIconName () const override
	Title can keep 32x32 xpm thumbnail/icon of the parent object.
Short_t	GetKeep () const
	Returns the "KEEP" status.
Int_t	GetKeylen () const
Int_t	GetLast () const
TDirectory *	GetMotherDir () const
const char *	GetName () const override
	Returns name of object.
Int_t	GetNbytes () const
Int_t	GetNevBuf () const
Int_t	GetNevBufSize () const
virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).
Int_t	GetObjlen () const
virtual Option_t *	GetOption () const
bool	GetResetAllocationCount () const
virtual Long64_t	GetSeekKey () const
virtual Long64_t	GetSeekPdir () const
const char *	GetTitle () const override
	Returns title (title can contain 32x32 xpm thumbnail/icon).
virtual UInt_t	GetUniqueID () const
	Return the unique object id.
Int_t	GetVersion () const
virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.
ULong_t	Hash () const override
	Return hash value for this object.
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	IncrementPidOffset (UShort_t offset)
	Increment fPidOffset by 'offset'.
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)
TClass *	IsA () const override
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).
Bool_t	IsFolder () const override
	Check if object referenced by the key is a folder.
Bool_t	IsOnHeap () const
Bool_t	IsSortable () const override
Bool_t	IsZombie () const
virtual void	Keep ()
	Set the "KEEP" status.
Int_t	LoadBasketBuffers (Long64_t pos, Int_t len, TFile *file, TTree *tree=nullptr)
	Load basket buffers in memory without unziping.
virtual void	ls (Bool_t current) const
	List Key contents.
void	ls (Option_t *option="") const override
	List Key contents.
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 void	MoveEntries (Int_t dentries)
	Remove the first dentries of this basket, moving entries at dentries to the start of the buffer.
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 *, size_t)
	Operator delete for sized deallocation.
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 *, size_t)
	Operator delete [] for sized deallocation.
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)
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 void	PrepareBasket (Long64_t)
void	Print (Option_t *option="") const override
	Print key contents.
virtual Int_t	Read (TObject *obj)
	To read an object from the file.
Int_t	ReadBasketBuffers (Long64_t pos, Int_t len, TFile *file)
	Read basket buffers in memory and cleanup.
Int_t	ReadBasketBytes (Long64_t pos, TFile *file)
	Read basket buffers in memory and cleanup.
virtual void	ReadBuffer (char *&buffer)
	Decode input buffer.
virtual Bool_t	ReadFile ()
	Read the key structure from the file.
void	ReadKeyBuffer (char *&buffer)
	Decode input buffer.
virtual TObject *	ReadObj ()
	To read a TObject* from the file.
template<typename T>
T *	ReadObject ()
	To read an object (non deriving from TObject) from the file.
virtual void *	ReadObjectAny (const TClass *expectedClass)
	To read an object (non deriving from TObject) from the file.
virtual TObject *	ReadObjWithBuffer (char *bufferRead)
	To read a TObject* from bufferRead.
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.
void	SetBranch (TBranch *branch)
virtual void	SetBuffer ()
virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.
void	SetMotherDir (TDirectory *dir)
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).
void	SetNevBufSize (Int_t n)
virtual void	SetParent (const TObject *parent)
	Set parent in key buffer.
virtual void	SetReadMode ()
	Set read mode of basket.
virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.
virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.
virtual void	SetWriteMode ()
	Set write mode of basket.
Int_t	Sizeof () const override
	Return the size in bytes of the key header structure.
void	Streamer (TBuffer &) override
	Stream a class object.
void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
virtual void	SysError (const char *method, const char *msgfmt,...) const
	Issue system error message.
Bool_t	TestBit (UInt_t f) const
Int_t	TestBits (UInt_t f) const
void	Update (Int_t newlast)
virtual void	Update (Int_t newlast, Int_t skipped)
	Update basket header and EntryOffset table.
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.
virtual Int_t	WriteBuffer ()
	Write buffer of this basket on the current file.
virtual Int_t	WriteFile (Int_t cycle=1, TFile *f=nullptr)
	Write the encoded object supported by this key.
virtual void	WriteReset ()
	Reset the write basket to the starting state.

Static Public Member Functions
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.

Static Public Attributes
static constexpr int	kIOBitCount = 1

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

Protected Member Functions
void	Build (TDirectory *motherDir, const char *classname, Long64_t filepos)
	Method used in all TKey constructor to initialize basic data fields.
virtual void	Create (Int_t nbytes, TFile *f=nullptr)
	Create a TKey object of specified size.
virtual void	DoError (int level, const char *location, const char *fmt, va_list va) const
	Interface to ErrorHandler (protected).
void	MakeZombie ()
Int_t	Read (const char *name) override
	Read contents of object with specified name from the current directory.
virtual void	ReadResetBuffer (Int_t basketnumber)
	Reset the read basket TBuffer memory allocation if needed.
void	Reset ()
	Reset the key as it had not been 'filled' yet.
void	SavePrimitiveNameTitle (std::ostream &out, const char *variable_name)
	Save object name and title into the output stream "out".
virtual Int_t	WriteFileKeepBuffer (TFile *f=nullptr)
	Write the encoded object supported by this key.

Static Protected Member Functions
static void	SavePrimitiveConstructor (std::ostream &out, TClass *cl, const char *variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
	Save object constructor in the output stream "out".
static void	SavePrimitiveDraw (std::ostream &out, const char *variable_name, Option_t *option=nullptr)
	Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.
static TString	SavePrimitiveVector (std::ostream &out, const char *prefix, Int_t len, Double_t *arr, Int_t flag=0)
	Save array in the output stream "out" as vector.

Protected Attributes
TBranch *	fBranch {nullptr}
	Pointer to the basket support branch.
char *	fBuffer
	Object buffer.
TBuffer *	fBufferRef
	Pointer to the TBuffer object.
Int_t	fBufferSize {0}
	fBuffer length in bytes
TString	fClassName
	Object Class name.
TBuffer *	fCompressedBufferRef {nullptr}
	! Compressed buffer.
Short_t	fCycle
	Cycle number.
TDatime	fDatime
	Date/Time of insertion in file.
Int_t *	fDisplacement {nullptr}
	![fNevBuf] Displacement of entries in fBuffer(TKey)
Int_t *	fEntryOffset {nullptr}
	[fNevBuf] Offset of entries in fBuffer(TKey); generated at runtime.
bool	fHeaderOnly {false}
	True when only the basket header must be read/written.
UChar_t	fIOBits {0}
	!IO feature flags. Serialized in custom portion of streamer to avoid forward compat issues unless needed.
Short_t	fKeylen
	Number of bytes for the key itself.
Int_t	fLast {0}
	Pointer to last used byte in basket.
Int_t	fLastWriteBufferSize [3] = {0,0,0}
	! Size of the buffer last three buffers we wrote it to disk
Int_t	fLeft
	Number of bytes left in current segment.
TDirectory *	fMotherDir
	!pointer to mother directory
TString	fName
Int_t	fNbytes
	Number of bytes for the whole key on file (key header and data).
Int_t	fNevBuf {0}
	Number of entries in basket.
Int_t	fNevBufSize {0}
	Length in Int_t of fEntryOffset OR fixed length of each entry if fEntryOffset is null!
UChar_t	fNextBufferSizeRecord {0}
	! Index into fLastWriteBufferSize of the last buffer written to disk
Int_t	fObjlen
	Length of uncompressed object in bytes.
bool	fOwnsCompressedBuffer {false}
	! Whether or not we own the compressed buffer.
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
bool	fReadEntryOffset {false}
	!Set to true if offset array was read from a file.
bool	fResetAllocation {false}
	! True if last reset re-allocated the memory
Long64_t	fSeekKey
	Location of object on file.
Long64_t	fSeekPdir
	Location of parent directory on file.
TString	fTitle
Int_t	fVersion
	Key version identifier.

Private Types
enum	EStatusBits { kIsDirectoryFile = (1ULL << (14)) , kReproducible = (1ULL << (15)) }

Private Member Functions
	TBasket (const TBasket &)
	TBasket objects are not copiable.
void	AdoptBuffer (TBuffer *user_buffer)
	Adopt a buffer from an external entity.
bool	CanGenerateOffsetArray ()
	Determine whether we can generate the offset array when this branch is read.
void	DisownBuffer ()
	Disown all references to the internal buffer - some other object likely now owns it.
Int_t *	GetCalculatedEntryOffset ()
	Calculates the entry offset array, if possible.
void	InitializeCompressedBuffer (Int_t len, TFile *file)
	Initialize the compressed buffer; either from the TTree or create a local one.
TBasket &	operator= (const TBasket &)
	TBasket objects are not copiable.
Int_t	ReadBasketBuffersUncompressedCase ()
	By-passing buffer unzipping has been requested and is possible (only 1 entry in this basket).
Int_t	ReadBasketBuffersUnzip (char *, Int_t, bool, TFile *)
	We always create the TBuffer for the basket but it hold the buffer from the cache.
void	ResetEntryOffset ()
Int_t	UnzipBuffer (char *targetBuffer, const char *compressedBuffer) const
	Core of uncompressing the key payload.

Static Private Member Functions
static void	AddToTObjectTable (TObject *)
	Private helper function which will dispatch to TObjectTable::AddObj.

Private Attributes
UInt_t	fBits
	bit field status word
UInt_t	fUniqueID
	object unique identifier

Static Private Attributes
static Longptr_t	fgDtorOnly = 0
	object for which to call dtor only (i.e. no delete)
static Bool_t	fgObjectStat = kTRUE
	if true keep track of objects in TObjectTable

Friends
class	TBranch

#include <TBasket.h>

Inheritance diagram for TBasket:

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator

kOnlyPrepStep

Used to request that the class specific implementation of TObject::Write just prepare the objects to be ready to be written but do not actually write them into the TBuffer. This is just for example by TBufferMerger to request that the TTree inside the file calls TTree::FlushBaskets (outside of the merging lock) and TBufferMerger will later ask for the write (inside the merging lock). To take advantage of this feature the class needs to overload TObject::Write and use this enum value accordingly. (See TTree::Write and TObject::Write) Do not use, this feature will be migrate to the Merge function (See TClass and TTree::Merge)

Definition at line 106 of file TObject.h.

anonymous enum

anonymous enum

inherited

Enumerator
kSingleKey	write collection with single key
kOverwrite	overwrite existing object with same name
kWriteDelete	write object, then delete previous key with same name

Definition at line 99 of file TObject.h.

anonymous enum

anonymous enum

inherited

Enumerator
kIsOnHeap	object is on heap
kNotDeleted	object has not been deleted
kZombie	object ctor failed
kInconsistent	class overload Hash but does call RecursiveRemove in destructor
kBitMask

Definition at line 89 of file TObject.h.

EDeprecatedStatusBits

enum TObject::EDeprecatedStatusBits

inherited

Enumerator
kObjInCanvas	for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

EIOBits

enum class TBasket::EIOBits : Char_t

strong

Enumerator
kGenerateOffsetMap
kSupported

Definition at line 97 of file TBasket.h.

EStatusBits

enum TKey::EStatusBits

privateinherited

Enumerator
kIsDirectoryFile
kReproducible

Definition at line 31 of file TKey.h.

EUnsupportedIOBits

enum class TBasket::EUnsupportedIOBits : Char_t

strong

Enumerator
kUnsupported

Definition at line 109 of file TBasket.h.

Constructor & Destructor Documentation

TBasket() [1/4]

TBasket::TBasket ( const TBasket & )

private

TBasket objects are not copiable.

TBasket() [2/4]

TBasket::TBasket

(

)

Default constructor.

Definition at line 46 of file TBasket.cxx.

TBasket() [3/4]

TBasket::TBasket

(

TDirectory *

motherDir

)

Constructor used during reading.

Definition at line 53 of file TBasket.cxx.

TBasket() [4/4]

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

Basket normal constructor, used during writing.

Definition at line 60 of file TBasket.cxx.

~TBasket()

TBasket::~TBasket ( )

override

Basket destructor.

Definition at line 103 of file TBasket.cxx.

Member Function Documentation

AbstractMethod()

void TObject::AbstractMethod ( const char * method ) const

inherited

Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.

In other word, this method acts as a "runtime purely virtual" warning instead of a "compiler purely virtual" error.

Warning

This interface is a legacy function that is no longer recommended to be used by new development code.

Note

The name "AbstractMethod" does not imply that it's an abstract method in the strict C++ sense.

Definition at line 1149 of file TObject.cxx.

AddToTObjectTable()

void TObject::AddToTObjectTable ( TObject * op )

staticprivateinherited

Private helper function which will dispatch to TObjectTable::AddObj.

Included here to avoid circular dependency between header files.

Definition at line 195 of file TObject.cxx.

AdjustSize()

void TBasket::AdjustSize ( Int_t newsize )

virtual

Increase the size of the current fBuffer up to newsize.

Definition at line 126 of file TBasket.cxx.

AdoptBuffer()

void TBasket::AdoptBuffer ( TBuffer * user_buffer )

private

Adopt a buffer from an external entity.

Definition at line 730 of file TBasket.cxx.

AppendPad()

void TObject::AppendPad ( Option_t * option = "" )

virtualinherited

Append graphics object to current pad.

In case no current pad is set yet, create a default canvas with the name "c1".

Definition at line 204 of file TObject.cxx.

Browse()

void TKey::Browse ( TBrowser * b )

overridevirtualinherited

Read object from disk and call its Browse() method.

If object with same name already exist in memory delete it (like TDirectoryFile::Get() is doing), except when the key references a folder in which case we don't want to re-read the folder object since it might contain new objects not yet saved.

Reimplemented from TObject.

Definition at line 461 of file TKey.cxx.

Build()

void TKey::Build ( TDirectory * motherDir, const char * classname, Long64_t filepos )

protectedinherited

Method used in all TKey constructor to initialize basic data fields.

The member filepos is used to calculate correct version number of key if filepos==-1, end of file position is used.

Definition at line 423 of file TKey.cxx.

CanGenerateOffsetArray()

bool TBasket::CanGenerateOffsetArray ( )

private

Determine whether we can generate the offset array when this branch is read.

Definition at line 217 of file TBasket.cxx.

CheckedHash()

ULong_t TObject::CheckedHash ( )

inlineinherited

Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

The intent is for this routine to be called instead of directly calling the function Hash during "insert" operations. See TObject::HasInconsistenTObjectHash();

(*) The setup is consistent when all classes in the class hierarchy that overload TObject::Hash do call ROOT::CallRecursiveRemoveIfNeeded in their destructor. i.e. it is safe to call the Hash virtual function during the RecursiveRemove operation.

Definition at line 332 of file TObject.h.

Class()

TClass * TBasket::Class ( )

static

Returns

TClass describing this class

Class_Name()

const char * TBasket::Class_Name ( )

static

Returns

Name of this class

Class_Version()

constexpr Version_t TBasket::Class_Version ( )

inlinestaticconstexpr

Returns

Version of this class

Definition at line 156 of file TBasket.h.

ClassName()

const char * TObject::ClassName ( ) const

virtualinherited

Returns name of class to which the object belongs.

Definition at line 227 of file TObject.cxx.

Clear()

void TNamed::Clear ( Option_t * option = "" )

overridevirtualinherited

Set name and title to empty strings ("").

Reimplemented from TObject.

Reimplemented in TPrincipal, TProcessID, TStreamerInfo, TTask, TVirtualFitter, and TVirtualStreamerInfo.

Definition at line 63 of file TNamed.cxx.

Clone()

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

overridevirtualinherited

Make a clone of an object using the Streamer facility.

If newname is specified, this will be the name of the new object.

Reimplemented from TObject.

Reimplemented in TStreamerInfo, and TTreeIndex.

Definition at line 73 of file TNamed.cxx.

Compare()

Int_t TNamed::Compare ( const TObject * obj ) const

overridevirtualinherited

Compare two TNamed objects.

Returns 0 when equal, -1 when this is smaller and +1 when bigger (like strcmp).

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 84 of file TNamed.cxx.

Copy()

void TNamed::Copy ( TObject & named ) const

overridevirtualinherited

Copy this to obj.

Reimplemented from TObject.

Reimplemented in TPieSlice, TProfile2D, TProfile3D, TProfile, TStyle, TSystemDirectory, TSystemFile, TText, and TXTRU.

Definition at line 93 of file TNamed.cxx.

CopyTo()

Long64_t TBasket::CopyTo

(

TFile *

to

)

Copy the basket of this branch onto the file to.

Definition at line 145 of file TBasket.cxx.

Create()

void TKey::Create ( Int_t nbytes, TFile * externFile = nullptr )

protectedvirtualinherited

Create a TKey object of specified size.

If externFile!=0, key will be allocated in specified file, otherwise file of mother directory will be used.

Definition at line 493 of file TKey.cxx.

DeclFileName()

const char * TBasket::DeclFileName ( )

inlinestatic

Returns

Name of the file containing the class declaration

Definition at line 156 of file TBasket.h.

Delete()

void TKey::Delete ( Option_t * option = "" )

overridevirtualinherited

Delete an object from the file.

Note: the key is not deleted. You still have to call "delete key". This is different from the behaviour of TObject::Delete()!

Reimplemented from TObject.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 572 of file TKey.cxx.

DeleteBuffer()

void TKey::DeleteBuffer ( )

virtualinherited

Delete key buffer(s).

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 593 of file TKey.cxx.

DeleteEntryOffset()

void TBasket::DeleteEntryOffset ( )

virtual

Delete fEntryOffset array.

Definition at line 163 of file TBasket.cxx.

DisownBuffer()

void TBasket::DisownBuffer ( )

private

Disown all references to the internal buffer - some other object likely now owns it.

This TBasket is now useless and invalid until it is told to adopt a buffer.

Definition at line 722 of file TBasket.cxx.

DistancetoPrimitive()

Int_t TObject::DistancetoPrimitive ( Int_t px, Int_t py )

virtualinherited

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

This member function must be implemented for each graphics primitive. This default function returns a big number (999999).

Reimplemented in TASImage, TAxis3D, TAxis, TBox, TBRIK, TColorWheel, TCrown, TCurlyArc, TCurlyLine, TDiamond, TEfficiency, TEllipse, TF1, TF2, TF3, TFileDrawMap, TGenerator, TGeoBBox, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoEltu, TGeoHalfSpace, TGeoHype, TGeoNode, TGeoOverlap, TGeoParaboloid, TGeoPcon, TGeoPgon, TGeoScaledShape, TGeoShape, TGeoShapeAssembly, TGeoSphere, TGeoTessellated, TGeoTorus, TGeoTrack, TGeoTube, TGeoTubeSeg, TGeoVGShape, TGeoVolume, TGeoXtru, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLScenePad, TGLTH3Composition, TGLViewer, TGraph2D, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TH1, THistPainter, THStack, TLine, TMarker3DBox, TMarker, TMultiGraph, TNode, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPCON, TPie, TPieSlice, TPoints3DABC, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TScatter2D, TScatter, TSPHE, TSpider, TSpline, TStyle, TText, TTreePerfStats, TTUBE, TTUBS, TVirtualHistPainter, and TXTRU.

Definition at line 284 of file TObject.cxx.

DoError()

void TObject::DoError ( int level, const char * location, const char * fmt, va_list va ) const

protectedvirtualinherited

Interface to ErrorHandler (protected).

Reimplemented in TThread, and TTreeViewer.

Definition at line 1059 of file TObject.cxx.

Draw()

void TObject::Draw ( Option_t * option = "" )

virtualinherited

Default Draw method for all objects.

Reimplemented in RooAbsData, RooPlot, RooStats::HypoTestInverterPlot, RooStats::SamplingDistPlot, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoPoint, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoSpace, ROOT::Experimental::XRooFit::xRooNode, ROOT::RGeoPainter, TArrow, TASImage, TBox, TBrowser, TButton, TCanvas, TChain, TClass, TClassTree, TCollection, TColorWheel, TDiamond, TDirectory, TEfficiency, TEllipse, TEveGeoNode, TEveGeoTopNode, TF1, TF2, TF3, TFile, TFITSHDU, TFrame, TGenerator, TGeoBatemanSol, TGeometry, TGeoNode, TGeoOverlap, TGeoPainter, TGeoParallelWorld, TGeoPhysicalNode, TGeoPolygon, TGeoShape, TGeoTrack, TGeoVGShape, TGeoVolume, TGItemContext, TGListTree, TGPicture, TGraph2D, TGraph, TGraphPolar, TGraphPolargram, TGraphStruct, TGraphTime, TH1, THelix, THStack, TLegend, TMarker, TMatrixTBase< Element >, TMatrixTBase< Double_t >, TMatrixTBase< Float_t >, TMultiDimFit, TMultiGraph, TMultiLayerPerceptron, TNode, TNodeDiv, TPad, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TPave, TPaveLabel, TPavesText, TPaveText, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TRatioPlot, TSpider, TSpline, TStructViewer, TStructViewerGUI, TTree, TTreePerfStats, TVectorT< Element >, TVectorT< Double_t >, TVectorT< Float_t >, TVirtualPad, and TWbox.

Definition at line 293 of file TObject.cxx.

DrawClass()

void TObject::DrawClass ( ) const

virtualinherited

Draw class inheritance tree of the class to which this object belongs.

If a class B inherits from a class A, description of B is drawn on the right side of description of A. Member functions overridden by B are shown in class A with a blue line crossing-out the corresponding member function. The following picture is the class inheritance tree of class TPaveLabel:

Reimplemented in TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 308 of file TObject.cxx.

DrawClone()

TObject * TObject::DrawClone ( Option_t * option = "" ) const

virtualinherited

Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).

If pad was not selected - gPad will be used.

Note

For histograms, use the more specialised TH1::DrawCopy().

Reimplemented in TAxis, TCanvas, TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 319 of file TObject.cxx.

DropBuffers()

Int_t TBasket::DropBuffers ( )

virtual

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

Definition at line 172 of file TBasket.cxx.

Dump()

void TObject::Dump ( ) const

virtualinherited

Dump contents of object on stdout.

Using the information in the object dictionary (class TClass) each data member is interpreted. If a data member is a pointer, the pointer value is printed

The following output is the Dump of a TArrow object:

fAngle                   0           Arrow opening angle (degrees)
fArrowSize               0.2         Arrow Size
fOption.*fData
fX1                      0.1         X of 1st point
fY1                      0.15        Y of 1st point
fX2                      0.67        X of 2nd point
fY2                      0.83        Y of 2nd point
fUniqueID                0           object unique identifier
fBits                    50331648    bit field status word
fLineColor               1           line color
fLineStyle               1           line style
fLineWidth               1           line width
fFillColor               19          fill area color
fFillStyle               1001        fill area style

Reimplemented in TClass, TCollection, TGFrame, TGPack, and TSystemFile.

Definition at line 367 of file TObject.cxx.

Error()

void TObject::Error ( const char * location, const char * fmt, ... ) const

virtualinherited

Issue error message.

Use "location" to specify the method where the error occurred. Accepts standard printf formatting arguments.

Reimplemented in TFitResult.

Definition at line 1098 of file TObject.cxx.

Execute() [1/2]

void TObject::Execute ( const char * method, const char * params, Int_t * error = nullptr )

virtualinherited

Execute method on this object with the given parameter string, e.g.

"3.14,1,\"text\"".

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 378 of file TObject.cxx.

Execute() [2/2]

void TObject::Execute ( TMethod * method, TObjArray * params, Int_t * error = nullptr )

virtualinherited

Execute method on this object with parameters stored in the TObjArray.

The TObjArray should contain an argv vector like:

argv[0] ... argv[n] = the list of TObjString parameters

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 398 of file TObject.cxx.

ExecuteEvent()

void TObject::ExecuteEvent ( Int_t event, Int_t px, Int_t py )

virtualinherited

Execute action corresponding to an event at (px,py).

This method must be overridden if an object can react to graphics events.

Reimplemented in TASImage, TASPaletteEditor::LimitLine, TAxis3D, TAxis, TBox, TButton, TCanvas, TCrown, TCurlyArc, TCurlyLine, TDiamond, TEfficiency, TEllipse, TF1, TF2, TF3, TFrame, TGenerator, TGeoManager, TGeoNode, TGeoOverlap, TGeoShape, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLEventHandler, TGLHistPainter, TGLParametricEquation, TGLScenePad, TGLTH3Composition, TGLViewer, TGraph2D, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TGroupButton, TH1, THistPainter, TLine, TLink, TMarker3DBox, TMarker, TNode, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TScatter2D, TScatter, TSliderBox, TSpider, TSpline, TText, TTreePerfStats, TView3D, TView, TVirtualHistPainter, and TWbox.

Definition at line 415 of file TObject.cxx.

Fatal()

void TObject::Fatal ( const char * location, const char * fmt, ... ) const

virtualinherited

Issue fatal error message.

Use "location" to specify the method where the fatal error occurred. Accepts standard printf formatting arguments.

Definition at line 1126 of file TObject.cxx.

FillBuffer()

void TKey::FillBuffer ( char *& buffer )

overridevirtualinherited

Encode key header into output buffer.

Reimplemented from TNamed.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 635 of file TKey.cxx.

FindObject() [1/2]

TObject * TObject::FindObject ( const char * name ) const

virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object by name inside this object.

Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 425 of file TObject.cxx.

FindObject() [2/2]

TObject * TObject::FindObject ( const TObject * obj ) const

virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object inside this object.

Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 435 of file TObject.cxx.

GetBranch()

TBranch * TBasket::GetBranch ( ) const

inline

Definition at line 121 of file TBasket.h.

GetBuffer()

virtual char * TKey::GetBuffer ( ) const

inlinevirtualinherited

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 80 of file TKey.h.

GetBufferRef()

TBuffer * TKey::GetBufferRef ( ) const

inlineinherited

Definition at line 81 of file TKey.h.

GetBufferSize()

Int_t TBasket::GetBufferSize ( ) const

inline

Definition at line 122 of file TBasket.h.

GetCalculatedEntryOffset()

Int_t * TBasket::GetCalculatedEntryOffset ( )

private

Calculates the entry offset array, if possible.

Result is cached, meaning that this should only be invoked once per basket.

Definition at line 194 of file TBasket.cxx.

GetClassName()

virtual const char * TKey::GetClassName ( ) const

inlinevirtualinherited

Definition at line 77 of file TKey.h.

GetCycle()

Short_t TKey::GetCycle ( ) const

inherited

Return cycle number associated to this key.

Definition at line 611 of file TKey.cxx.

GetDatime()

const TDatime & TKey::GetDatime ( ) const

inlineinherited

Definition at line 83 of file TKey.h.

GetDisplacement()

Int_t * TBasket::GetDisplacement ( ) const

inline

Definition at line 123 of file TBasket.h.

GetDrawOption()

Option_t * TObject::GetDrawOption ( ) const

virtualinherited

Get option used by the graphics system to draw this object.

Note that before calling object.GetDrawOption(), you must have called object.Draw(..) before in the current pad.

Reimplemented in TBrowser, TFitEditor, TGedFrame, TGFileBrowser, TRootBrowser, and TRootBrowserLite.

Definition at line 445 of file TObject.cxx.

GetDtorOnly()

Longptr_t TObject::GetDtorOnly ( )

staticinherited

Return destructor only flag.

Definition at line 1196 of file TObject.cxx.

GetEntryOffset()

Int_t * TBasket::GetEntryOffset ( )

inline

Definition at line 124 of file TBasket.h.

GetEntryPointer()

Int_t TBasket::GetEntryPointer

(

Int_t

Entry

)

Get pointer to buffer for internal entry.

Definition at line 229 of file TBasket.cxx.

GetFile()

TFile * TKey::GetFile ( ) const

inherited

Returns file to which key belong.

Definition at line 619 of file TKey.cxx.

GetIconName()

const char * TKey::GetIconName ( ) const

overridevirtualinherited

Title can keep 32x32 xpm thumbnail/icon of the parent object.

Reimplemented from TObject.

Definition at line 1528 of file TKey.cxx.

GetKeep()

Short_t TKey::GetKeep ( ) const

inherited

Returns the "KEEP" status.

Definition at line 627 of file TKey.cxx.

GetKeylen()

Int_t TKey::GetKeylen ( ) const

inlineinherited

Definition at line 86 of file TKey.h.

GetLast()

Int_t TBasket::GetLast ( ) const

inline

Definition at line 131 of file TBasket.h.

GetMotherDir()

TDirectory * TKey::GetMotherDir ( ) const

inlineinherited

Definition at line 87 of file TKey.h.

GetName()

const char * TNamed::GetName ( ) const

inlineoverridevirtualinherited

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 49 of file TNamed.h.

GetNbytes()

Int_t TKey::GetNbytes ( ) const

inlineinherited

Definition at line 88 of file TKey.h.

GetNevBuf()

Int_t TBasket::GetNevBuf ( ) const

inline

Definition at line 129 of file TBasket.h.

GetNevBufSize()

Int_t TBasket::GetNevBufSize ( ) const

inline

Definition at line 130 of file TBasket.h.

GetObjectInfo()

char * TObject::GetObjectInfo ( Int_t px, Int_t py ) const

virtualinherited

Returns string containing info about the object at position (px,py).

This method is typically overridden by classes of which the objects can report peculiarities for different positions. Returned string will be re-used (lock in MT environment).

Reimplemented in TASImage, TAxis3D, TColorWheel, TF1, TF2, TFileDrawMap, TGeoNode, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph, TH1, THistPainter, TNode, TPaletteAxis, TParallelCoordVar, and TVirtualHistPainter.

Definition at line 491 of file TObject.cxx.

GetObjectStat()

Bool_t TObject::GetObjectStat ( )

staticinherited

Get status of object stat flag.

Definition at line 1181 of file TObject.cxx.

GetObjlen()

Int_t TKey::GetObjlen ( ) const

inlineinherited

Definition at line 89 of file TKey.h.

GetOption()

virtual Option_t * TObject::GetOption ( ) const

inlinevirtualinherited

Reimplemented in TArrow, TAxis3D, TFile, TGaxis, TGeoVolume, TH1, THelix, TLegendEntry, TMapFile, TNode, TPave, TPoints3DABC, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPSocket, TSelector, TSocket, and TUDPSocket.

Definition at line 147 of file TObject.h.

GetResetAllocationCount()

bool TBasket::GetResetAllocationCount ( ) const

inline

Definition at line 143 of file TBasket.h.

GetSeekKey()

virtual Long64_t TKey::GetSeekKey ( ) const

inlinevirtualinherited

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 91 of file TKey.h.

GetSeekPdir()

virtual Long64_t TKey::GetSeekPdir ( ) const

inlinevirtualinherited

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 92 of file TKey.h.

GetTitle()

const char * TKey::GetTitle ( ) const

overridevirtualinherited

Returns title (title can contain 32x32 xpm thumbnail/icon).

Reimplemented from TObject.

Definition at line 1536 of file TKey.cxx.

GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const

virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

GetVersion()

Int_t TKey::GetVersion ( ) const

inlineinherited

Definition at line 90 of file TKey.h.

HandleTimer()

Bool_t TObject::HandleTimer ( TTimer * timer )

virtualinherited

Execute action in response of a timer timing out.

This method must be overridden if an object has to react to timers.

Reimplemented in TGCommandPlugin, TGDNDManager, TGFileContainer, TGHtml, TGLEventHandler, TGPopupMenu, TGraphTime, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGuiBldDragManager, TGWindow, and TTreeViewer.

Definition at line 516 of file TObject.cxx.

Hash()

ULong_t TNamed::Hash ( ) const

inlineoverridevirtualinherited

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

ROOT::CallRecursiveRemoveIfNeeded(*this)

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides
TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.

Reimplemented from TObject.

Definition at line 51 of file TNamed.h.

HasInconsistentHash()

Bool_t TObject::HasInconsistentHash ( ) const

inlineinherited

Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

missing call to RecursiveRemove in destructor).

Note: Since the consistency is only tested for during inserts, this routine will return true for object that have never been inserted whether or not they have a consistent setup. This has no negative side-effect as searching for the object with the right or wrong Hash will always yield a not-found answer (Since anyway no hash can be guaranteed unique, there is always a check)

Definition at line 366 of file TObject.h.

IncrementPidOffset()

void TKey::IncrementPidOffset ( UShort_t offset )

virtualinherited

Increment fPidOffset by 'offset'.

This offset is used when a key (or basket) is transferred from one file to the other. In this case the TRef and TObject might have stored a pid index (to retrieve TProcessIDs) which refered to their order on the original file, the fPidOffset is to be added to those values to correctly find the TProcessID. This fPidOffset needs to be increment if the key/basket is copied and need to be zero for new key/basket.

Definition at line 684 of file TKey.cxx.

Info()

void TObject::Info ( const char * location, const char * fmt, ... ) const

virtualinherited

Issue info message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1072 of file TObject.cxx.

InheritsFrom() [1/2]

Bool_t TObject::InheritsFrom ( const char * classname ) const

virtualinherited

Returns kTRUE if object inherits from class "classname".

Reimplemented in TClass.

Definition at line 549 of file TObject.cxx.

InheritsFrom() [2/2]

Bool_t TObject::InheritsFrom ( const TClass * cl ) const

virtualinherited

Returns kTRUE if object inherits from TClass cl.

Reimplemented in TClass.

Definition at line 557 of file TObject.cxx.

InitializeCompressedBuffer()

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 431 of file TBasket.cxx.

Inspect()

void TObject::Inspect ( ) const

virtualinherited

Dump contents of this object in a graphics canvas.

Same action as Dump but in a graphical form. In addition pointers to other objects can be followed.

The following picture is the Inspect of a histogram object:

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TGFrame, TInspectorObject, and TSystemFile.

Definition at line 570 of file TObject.cxx.

InvertBit()

void TObject::InvertBit ( UInt_t f )

inlineinherited

Definition at line 206 of file TObject.h.

IsA()

TClass * TBasket::IsA ( ) const

inlineoverridevirtual

Returns

TClass describing current object

Reimplemented from TObject.

Reimplemented in TBasketSQL.

Definition at line 156 of file TBasket.h.

IsDestructed()

Bool_t TObject::IsDestructed ( ) const

inlineinherited

IsDestructed.

Note

This function must be non-virtual as it can be used on destructed (but not yet modified) memory. This is used for example in TClonesArray to record the element that have been destructed but not deleted and thus are ready for re-use (by operator new with placement).

Returns

true if this object's destructor has been run.

Definition at line 186 of file TObject.h.

IsEqual()

Bool_t TObject::IsEqual ( const TObject * obj ) const

virtualinherited

Default equal comparison (objects are equal if they have the same address in memory).

More complicated classes might want to override this function.

Reimplemented in TGObject, TObjString, TPair, and TQCommand.

Definition at line 589 of file TObject.cxx.

IsFolder()

Bool_t TKey::IsFolder ( ) const

overridevirtualinherited

Check if object referenced by the key is a folder.

Reimplemented from TObject.

Definition at line 698 of file TKey.cxx.

IsOnHeap()

Bool_t TObject::IsOnHeap ( ) const

inlineinherited

Definition at line 160 of file TObject.h.

IsSortable()

Bool_t TNamed::IsSortable ( ) const

inlineoverridevirtualinherited

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 52 of file TNamed.h.

IsZombie()

Bool_t TObject::IsZombie ( ) const

inlineinherited

Definition at line 161 of file TObject.h.

Keep()

void TKey::Keep ( )

virtualinherited

Set the "KEEP" status.

When the KEEP flag is set to 1 the object cannot be purged.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 719 of file TKey.cxx.

LoadBasketBuffers()

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

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 244 of file TBasket.cxx.

ls() [1/2]

void TKey::ls ( Bool_t current ) const

virtualinherited

List Key contents.

Add indicator of whether it is the current item or a backup copy.

Definition at line 728 of file TKey.cxx.

ls() [2/2]

void TKey::ls ( Option_t * option = "" ) const

overridevirtualinherited

List Key contents.

Reimplemented from TObject.

Definition at line 739 of file TKey.cxx.

MakeZombie()

void TObject::MakeZombie ( )

inlineprotectedinherited

Definition at line 55 of file TObject.h.

MayNotUse()

void TObject::MayNotUse ( const char * method ) const

inherited

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

Definition at line 1160 of file TObject.cxx.

MoveEntries()

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 309 of file TBasket.cxx.

Notify()

Bool_t TObject::Notify ( )

virtualinherited

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

Different objects in ROOT use the Notify method for different purposes, in coordination with other objects that call this method at the appropriate time.

For example, TLeaf uses it to load class information; TBranchRef to load contents of referenced branches TBranchRef; most notably, based on Notify, TChain implements a callback mechanism to inform interested parties when it switches to a new sub-tree.

Reimplemented in h1analysis, h1analysisTreeReader, TARInterruptHandler, TASInputHandler, TASInterruptHandler, TASLogHandler, TASSigPipeHandler, TBlinkTimer, TBranchElement, TBranchRef, TBreakLineCom, TBrowserTimer, TCollection, TDelCharCom, TDelTextCom, TFileHandler, TGContainerKeyboardTimer, TGContainerScrollTimer, TGInputHandler, TGLRedrawTimer, TGTextEditHist, TGuiBldDragManagerRepeatTimer, TIdleTimer, TInsCharCom, TInsTextCom, TInterruptHandler, TLeafObject, TMessageHandler, TNotifyLink< Type >, TNotifyLink< RNoCleanupNotifierHelper >, TNotifyLink< ROOT::Detail::TBranchProxy >, TNotifyLink< TTreeReader >, TPopupDelayTimer, TProcessEventTimer, TRefTable, TRepeatTimer, TSBRepeatTimer, TSelector, TSelectorDraw, TSelectorEntries, TSignalHandler, TSingleShotCleaner, TSocketHandler, TStdExceptionHandler, TSysEvtHandler, TTermInputHandler, TThreadTimer, TTimeOutTimer, TTimer, TTipDelayTimer, TTree, TTreeFormula, TTreeFormulaManager, TTreeReader, TViewTimer, and TViewUpdateTimer.

Definition at line 618 of file TObject.cxx.

Obsolete()

void TObject::Obsolete ( const char * method, const char * asOfVers, const char * removedFromVers ) const

inherited

Use this method to declare a method obsolete.

Specify as of which version the method is obsolete and as from which version it will be removed.

Definition at line 1169 of file TObject.cxx.

operator delete() [1/3]

void TObject::operator delete ( void * ptr, size_t size )

inherited

Operator delete for sized deallocation.

Definition at line 1234 of file TObject.cxx.

operator delete() [2/3]

void TObject::operator delete ( void * ptr )

inherited

Operator delete.

Definition at line 1212 of file TObject.cxx.

operator delete() [3/3]

void TObject::operator delete ( void * ptr, void * vp )

inherited

Only called by placement new when throwing an exception.

Definition at line 1266 of file TObject.cxx.

operator delete[]() [1/3]

void TObject::operator delete[] ( void * ptr, size_t size )

inherited

Operator delete [] for sized deallocation.

Definition at line 1245 of file TObject.cxx.

operator delete[]() [2/3]

void TObject::operator delete[] ( void * ptr )

inherited

Operator delete [].

Definition at line 1223 of file TObject.cxx.

operator delete[]() [3/3]

void TObject::operator delete[] ( void * ptr, void * vp )

inherited

Only called by placement new[] when throwing an exception.

Definition at line 1274 of file TObject.cxx.

operator new() [1/2]

void * TObject::operator new ( size_t sz )

inlineinherited

Definition at line 189 of file TObject.h.

operator new() [2/2]

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

inlineinherited

Definition at line 191 of file TObject.h.

operator new[]() [1/2]

void * TObject::operator new[] ( size_t sz )

inlineinherited

Definition at line 190 of file TObject.h.

operator new[]() [2/2]

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

inlineinherited

Definition at line 192 of file TObject.h.

operator=()

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

private

TBasket objects are not copiable.

Paint()

void TObject::Paint ( Option_t * option = "" )

virtualinherited

This method must be overridden if a class wants to paint itself.

The difference between Paint() and Draw() is that when a object draws itself it is added to the display list of the pad in which it is drawn (and automatically redrawn whenever the pad is redrawn). While paint just draws the object without adding it to the pad display list.

Reimplemented in ROOT::Experimental::RTreeMapPainter, ROOT::RGeoPainter, TAnnotation, TArrow, TASImage, TASPaletteEditor::LimitLine, TASPaletteEditor::PaintPalette, TAxis3D, TBits, TBox, TButton, TCanvas, TClassTree, TCollection, TColorWheel, TCrown, TDiamond, TDirectory, TEfficiency, TEllipse, TEveArrow, TEveCaloViz, TEveDigitSet, TEveGeoShape, TEveGeoTopNode, TEvePlot3D, TEvePointSet, TEveProjectionAxes, TEveScene, TEveShape, TEveStraightLineSet, TEveText, TEveTriangleSet, TExec, TF1, TF2, TF3, TFile, TFileDrawMap, TFrame, TGaxis, TGenerator, TGeoBoolNode, TGeoIntersection, TGeoNode, TGeoOverlap, TGeoPainter, TGeoPhysicalNode, TGeoShape, TGeoSubtraction, TGeoTrack, TGeoUnion, TGeoVGShape, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph2D, TGraph2DPainter, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TGraphTime, TH1, THistPainter, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TNode, TNodeDiv, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TRatioPlot, TScatter2D, TScatter, TShape, TSpectrum2Painter, TSpider, TSpline, TSQLFile, TStyle, TText, TTreePerfStats, TVirtualGeoPainter, TVirtualGeoTrack, TVirtualHistPainter, TVirtualPad, TWbox, and TXMLFile.

Definition at line 631 of file TObject.cxx.

Pop()

void TObject::Pop ( )

virtualinherited

Pop on object drawn in a pad to the top of the display list.

I.e. it will be drawn last and on top of all other primitives.

Reimplemented in TFrame, TPad, and TVirtualPad.

Definition at line 640 of file TObject.cxx.

PrepareBasket()

virtual void TBasket::PrepareBasket ( Long64_t )

inlinevirtual

Reimplemented in TBasketSQL.

Definition at line 133 of file TBasket.h.

Print()

void TKey::Print ( Option_t * option = "" ) const

overridevirtualinherited

Print key contents.

Reimplemented from TObject.

Definition at line 748 of file TKey.cxx.

Read() [1/2]

Int_t TKey::Read ( const char * name )

inlineoverrideprotectedvirtualinherited

Read contents of object with specified name from the current directory.

First the key with the given name is searched in the current directory, next the key buffer is deserialized into the object. The object must have been created before via the default constructor. See TObject::Write().

Reimplemented from TObject.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 56 of file TKey.h.

Read() [2/2]

Int_t TKey::Read ( TObject * obj )

virtualinherited

To read an object from the file.

The object associated to this key is read from the file into memory. Before invoking this function, obj has been created via the default constructor.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 1154 of file TKey.cxx.

ReadBasketBuffers()

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 necessary to assure the expected behavior when there is no cache.

Definition at line 463 of file TBasket.cxx.

ReadBasketBuffersUncompressedCase()

Int_t TBasket::ReadBasketBuffersUncompressedCase ( )

private

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

Definition at line 357 of file TBasket.cxx.

ReadBasketBuffersUnzip()

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

private

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

Definition at line 379 of file TBasket.cxx.

ReadBasketBytes()

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 707 of file TBasket.cxx.

ReadBuffer()

void TKey::ReadBuffer ( char *& buffer )

virtualinherited

Decode input buffer.

In some situation will add key to gDirectory.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 1203 of file TKey.cxx.

ReadFile()

Bool_t TKey::ReadFile ( )

virtualinherited

Read the key structure from the file.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 1290 of file TKey.cxx.

ReadKeyBuffer()

void TKey::ReadKeyBuffer ( char *& buffer )

inherited

Decode input buffer.

Definition at line 1215 of file TKey.cxx.

ReadObj()

TObject * TKey::ReadObj ( )

virtualinherited

To read a TObject* from the file.

The object associated to this key is read from the file into memory Once the key structure is read (via Streamer) the class identifier of the object is known. Using the class identifier we find the TClass object for this class. A TClass object contains a full description (i.e. dictionary) of the associated class. In particular the TClass object can create a new object of the class type it describes. This new object now calls its Streamer function to rebuilt itself.

Use TKey::ReadObjectAny to read any object non-derived from TObject

Note

A C style cast can only be used in the case where the final class of this object derives from TObject as a first inheritance, otherwise one must use a dynamic_cast.

Example1: simplified case

class MyClass : public TObject, public AnotherClass

then on return, one get away with using:

MyClass *obj = (MyClass*)key->ReadObj();

Example2: Usual case (recommended unless performance is critical)

MyClass *obj = dynamic_cast<MyClass*>(key->ReadObj());

which support also the more complex inheritance like:

class MyClass : public AnotherClass, public TObject

Of course, dynamic_cast<> can also be used in the example 1.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 792 of file TKey.cxx.

ReadObject()

template<typename T>

T * TKey::ReadObject ( )

inlineinherited

To read an object (non deriving from TObject) from the file.

This is more user friendly version of TKey::ReadObjectAny. See TKey::ReadObjectAny for more details.

Definition at line 105 of file TKey.h.

ReadObjectAny()

void * TKey::ReadObjectAny ( const TClass * expectedClass )

virtualinherited

To read an object (non deriving from TObject) from the file.

If expectedClass is not null, we checked that that actual class of the object stored is suitable to be stored in a pointer pointing to an object of class 'expectedClass'. We also adjust the value of the returned address so that it is suitable to be cast (C-Style) a pointer pointing to an object of class 'expectedClass'.

So for example if the class Bottom inherits from Top and the object stored is of type Bottom you can safely do:

auto TopClass = TClass::GetClass("Top");
auto ptr = (Top*) key->ReadObjectAny( TopClass );
if (ptr==0) printError("the object stored in the key is not of the expected type\n");

The object associated to this key is read from the file into memory. Once the key structure is read (via Streamer) the class identifier of the object is known. Using the class identifier we find the TClass object for this class. A TClass object contains a full description (i.e. dictionary) of the associated class. In particular the TClass object can create a new object of the class type it describes. This new object now calls its Streamer function to rebuilt itself.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 1031 of file TKey.cxx.

ReadObjWithBuffer()

TObject * TKey::ReadObjWithBuffer ( char * bufferRead )

virtualinherited

To read a TObject* from bufferRead.

This function is identical to TKey::ReadObj, but it reads directly from bufferRead instead of reading from a file. The object associated to this key is read from the buffer into memory Using the class identifier we find the TClass object for this class. A TClass object contains a full description (i.e. dictionary) of the associated class. In particular the TClass object can create a new object of the class type it describes. This new object now calls its Streamer function to rebuilt itself.

Note

This function is called only internally by ROOT classes. Although being public it is not supposed to be used outside ROOT. If used, you must make sure that the bufferRead is large enough to accommodate the object being read.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 913 of file TKey.cxx.

ReadResetBuffer()

void TBasket::ReadResetBuffer ( Int_t basketnumber )

protectedvirtual

Reset the read basket TBuffer memory allocation if needed.

This allows to reduce the number of memory allocation while avoiding to always use the maximum size.

Definition at line 742 of file TBasket.cxx.

RecursiveRemove()

void TObject::RecursiveRemove ( TObject * obj )

virtualinherited

Recursively remove this object from a list.

Typically implemented by classes that can contain multiple references to a same object.

Reimplemented in RooAbsCollection, RooAbsData, RooLinkedList, RooMCStudy, ROOT::Internal::TCheckHashRecursiveRemoveConsistency, ROOT::RBrowserDataCleanup, RooWorkspace, TBrowser, TChain, TCling, TCollection, TDialogCanvas, TDirectory, TEfficiency, TFileMerger, TFitEditor, TFolder, TFriendElement, TGedEditor, TGeometry, TGFileBrowser, TGraph2D, TGraph, TH1, TH1Editor, TH2Editor, THashList, THistPainter, THStack, TInspectCanvas, TLegend, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TMultiGraph, TNode, TObjArray, TObjectRefSpy, TObjectSpy, TPad, TProcessID, TROOT, TRootBrowser, TRootBrowserHistory, TRootBrowserLite, TRootContextMenu, TTree, TTreePlayer, TViewPubDataMembers, TViewPubFunctions, and TVirtualPad.

Definition at line 684 of file TObject.cxx.

Reset()

void TKey::Reset ( )

protectedinherited

Reset the key as it had not been 'filled' yet.

Definition at line 1319 of file TKey.cxx.

ResetBit()

void TObject::ResetBit ( UInt_t f )

inlineinherited

Definition at line 203 of file TObject.h.

ResetEntryOffset()

void TBasket::ResetEntryOffset ( )

private

Definition at line 440 of file TBasket.cxx.

SaveAs()

void TObject::SaveAs ( const char * filename = "", Option_t * option = "" ) const

virtualinherited

Save this object in the file specified by filename.

• if "filename" contains ".root" the object is saved in filename as root binary file.
• if "filename" contains ".xml" the object is saved in filename as a xml ascii file.
• if "filename" contains ".cc" the object is saved in filename as C code independent from ROOT. The code is generated via SavePrimitive(). Specific code should be implemented in each object to handle this option. Like in TF1::SavePrimitive().

• otherwise the object is written to filename as a CINT/C++ script. The C++ code to rebuild this object is generated via SavePrimitive(). The "option" parameter is passed to SavePrimitive. By default it is an empty string. It can be used to specify the Draw option in the code generated by SavePrimitive.

  The function is available via the object context menu.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TClassTree, TFolder, TGeoVolume, TGObject, TGraph, TH1, TPad, TPaveClass, TSpline3, TSpline5, TSpline, TTreePerfStats, and TVirtualPad.

Definition at line 708 of file TObject.cxx.

SavePrimitive()

void TObject::SavePrimitive ( std::ostream & out, Option_t * option = "" )

virtualinherited

Save a primitive as a C++ statement(s) on output stream "out".

Reimplemented in TAnnotation, TArc, TArrow, TASImage, TAxis3D, TBox, TButton, TCanvas, TChain, TCrown, TCurlyArc, TCurlyLine, TCutG, TDiamond, TEfficiency, TEllipse, TExec, TF12, TF1, TF2, TF3, TFrame, TGaxis, TGButton, TGButtonGroup, TGCanvas, TGCheckButton, TGColorSelect, TGColumnLayout, TGComboBox, TGCompositeFrame, TGContainer, TGDockableFrame, TGDoubleHSlider, TGDoubleVSlider, TGedMarkerSelect, TGedPatternSelect, TGeoArb8, TGeoBBox, TGeoBoolNode, TGeoCombiTrans, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoCtub, TGeoDecayChannel, TGeoElementRN, TGeoEltu, TGeoGtra, TGeoHalfSpace, TGeoHMatrix, TGeoHype, TGeoIdentity, TGeoIntersection, TGeoMaterial, TGeoMedium, TGeoMixture, TGeoPara, TGeoParaboloid, TGeoPatternCylPhi, TGeoPatternCylR, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternSphPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternTrapZ, TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPcon, TGeoPgon, TGeoRotation, TGeoScaledShape, TGeoShapeAssembly, TGeoSphere, TGeoSubtraction, TGeoTessellated, TGeoTorus, TGeoTranslation, TGeoTrap, TGeoTrd1, TGeoTrd2, TGeoTube, TGeoTubeSeg, TGeoUnion, TGeoVolume, TGeoXtru, TGFileContainer, TGFont, TGFrame, TGFSComboBox, TGGC, TGGroupFrame, TGHButtonGroup, TGHorizontal3DLine, TGHorizontalFrame, TGHorizontalLayout, TGHProgressBar, TGHScrollBar, TGHSlider, TGHSplitter, TGHtml, TGIcon, TGLabel, TGLayoutHints, TGLineStyleComboBox, TGLineWidthComboBox, TGListBox, TGListDetailsLayout, TGListLayout, TGListTree, TGListView, TGLVContainer, TGMainFrame, TGMatrixLayout, TGMdiFrame, TGMdiMainFrame, TGMdiMenuBar, TGMenuBar, TGMenuTitle, TGNumberEntry, TGNumberEntryField, TGPictureButton, TGPopupMenu, TGProgressBar, TGRadioButton, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraph, TGraphAsymmErrors, TGraphBentErrors, TGraphEdge, TGraphErrors, TGraphMultiErrors, TGraphNode, TGraphPolar, TGraphPolargram, TGraphStruct, TGroupButton, TGRowLayout, TGShapedFrame, TGShutter, TGShutterItem, TGSplitFrame, TGStatusBar, TGTab, TGTabLayout, TGTableLayout, TGTableLayoutHints, TGTextButton, TGTextEdit, TGTextEntry, TGTextLBEntry, TGTextView, TGTileLayout, TGToolBar, TGTransientFrame, TGTripleHSlider, TGTripleVSlider, TGVButtonGroup, TGVertical3DLine, TGVerticalFrame, TGVerticalLayout, TGVFileSplitter, TGVProgressBar, TGVScrollBar, TGVSlider, TGVSplitter, TGXYLayout, TGXYLayoutHints, TH1, TH2Poly, THelix, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TPad, TPaletteAxis, TParallelCoord, TParallelCoordVar, TPave, TPaveClass, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPieSlice, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TProfile2D, TProfile3D, TProfile, TRootContainer, TRootEmbeddedCanvas, TScatter2D, TScatter, TSlider, TSliderBox, TSpline3, TSpline5, TStyle, TText, TTreePerfStats, and TWbox.

Definition at line 858 of file TObject.cxx.

SavePrimitiveConstructor()

void TObject::SavePrimitiveConstructor ( std::ostream & out, TClass * cl, const char * variable_name, const char * constructor_agrs = "", Bool_t empty_line = kTRUE )

staticprotectedinherited

Save object constructor in the output stream "out".

Can be used as first statement when implementing SavePrimitive() method for the object

Definition at line 777 of file TObject.cxx.

SavePrimitiveDraw()

void TObject::SavePrimitiveDraw ( std::ostream & out, const char * variable_name, Option_t * option = nullptr )

staticprotectedinherited

Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.

Definition at line 845 of file TObject.cxx.

SavePrimitiveNameTitle()

void TNamed::SavePrimitiveNameTitle ( std::ostream & out, const char * variable_name )

protectedinherited

Save object name and title into the output stream "out".

Definition at line 135 of file TNamed.cxx.

SavePrimitiveVector()

TString TObject::SavePrimitiveVector ( std::ostream & out, const char * prefix, Int_t len, Double_t * arr, Int_t flag = 0 )

staticprotectedinherited

Save array in the output stream "out" as vector.

Create unique variable name based on prefix value Returns name of vector which can be used in constructor or in other places of C++ code If flag === kTRUE, just add empty line If flag === 111, check if array is empty and return nullptr or <vectorname>.data()

Definition at line 796 of file TObject.cxx.

SetBit() [1/2]

void TObject::SetBit ( UInt_t f )

inlineinherited

Definition at line 202 of file TObject.h.

SetBit() [2/2]

void TObject::SetBit ( UInt_t f, Bool_t set )

inherited

Set or unset the user status bits as specified in f.

Definition at line 888 of file TObject.cxx.

SetBranch()

void TBasket::SetBranch ( TBranch * branch )

inline

Definition at line 148 of file TBasket.h.

SetBuffer()

virtual void TKey::SetBuffer ( )

inlinevirtualinherited

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 112 of file TKey.h.

SetDrawOption()

void TObject::SetDrawOption ( Option_t * option = "" )

virtualinherited

Set drawing option for object.

This option only affects the drawing style and is stored in the option field of the TObjOptLink supporting a TPad's primitive list (TList). Note that it does not make sense to call object.SetDrawOption(option) before having called object.Draw().

Reimplemented in RooPlot, TAxis, TBrowser, TGedFrame, TGFrame, TPad, TPaveStats, TRootBrowserLite, TSystemDirectory, and TSystemFile.

Definition at line 871 of file TObject.cxx.

SetDtorOnly()

void TObject::SetDtorOnly ( void * obj )

staticinherited

Set destructor only flag.

Definition at line 1204 of file TObject.cxx.

SetMotherDir()

void TKey::SetMotherDir ( TDirectory * dir )

inlineinherited

Definition at line 114 of file TKey.h.

SetName()

void TNamed::SetName ( const char * name )

virtualinherited

Set the name of the TNamed.

WARNING: if the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, ROOT::Experimental::XRooFit::xRooNode, TChain, TColor, TDirectory, TEfficiency, TEventList, TEveScene, TFormula, TGraph2D, TGraph, TH1, TNode, TRotMatrix, TShape, TSystemDirectory, TSystemFile, and TTree.

Definition at line 149 of file TNamed.cxx.

SetNameTitle()

void TNamed::SetNameTitle ( const char * name, const char * title )

virtualinherited

Set all the TNamed parameters (name and title).

WARNING: if the name is changed and the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, TContextMenu, TGraph2D, TGraph, TH1, and TNode.

Definition at line 163 of file TNamed.cxx.

SetNevBufSize()

void TBasket::SetNevBufSize ( Int_t n )

inline

Definition at line 149 of file TBasket.h.

SetObjectStat()

void TObject::SetObjectStat ( Bool_t stat )

staticinherited

Turn on/off tracking of objects in the TObjectTable.

Definition at line 1188 of file TObject.cxx.

SetParent()

void TKey::SetParent ( const TObject * parent )

virtualinherited

Set parent in key buffer.

Definition at line 1311 of file TKey.cxx.

SetReadMode()

void TBasket::SetReadMode ( )

virtual

Set read mode of basket.

Definition at line 934 of file TBasket.cxx.

SetTitle()

void TNamed::SetTitle ( const char * title = "" )

virtualinherited

Set the title of the TNamed.

Reimplemented in Axis2, RooPlot, ROOT::Experimental::XRooFit::xRooNode, ROOT::TSchemaRule::TSources, TASImage, TEfficiency, TF1, TGraph2D, TGraph, TH1, THnBase, TParallelCoordVar, TSystemDirectory, and TSystemFile.

Definition at line 173 of file TNamed.cxx.

SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid )

virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

SetWriteMode()

void TBasket::SetWriteMode ( )

virtual

Set write mode of basket.

Definition at line 943 of file TBasket.cxx.

Sizeof()

Int_t TKey::Sizeof ( ) const

overridevirtualinherited

Return the size in bytes of the key header structure.

An explanation about the nbytes (Int_t nbytes) variable used in the function. The size of fSeekKey and fSeekPdir is 8 instead of 4 if version is greater than 1000.

Component	Sizeof
fNbytes	4
sizeof(Version_t)	2
fObjlen	4
fDatime	4
fKeylen	2
fCycle	2
fSeekKey	4 or 8
fSeekPdir	4 or 8
FIXED TOTAL	26 or 34
fClassName	1+ bytes
fName	1+ bytes
fTitle	1+ bytes
TOTAL	29+ or 37+

Reimplemented from TNamed.

Definition at line 1358 of file TKey.cxx.

Streamer()

void TBasket::Streamer ( TBuffer & b )

overridevirtual

Stream a class object.

Reimplemented from TObject.

Reimplemented in TBasketSQL.

Definition at line 952 of file TBasket.cxx.

StreamerNVirtual()

void TBasket::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 156 of file TBasket.h.

SysError()

void TObject::SysError ( const char * location, const char * fmt, ... ) const

virtualinherited

Issue system error message.

Use "location" to specify the method where the system error occurred. Accepts standard printf formatting arguments.

Definition at line 1112 of file TObject.cxx.

TestBit()

Bool_t TObject::TestBit ( UInt_t f ) const

inlineinherited

Definition at line 204 of file TObject.h.

TestBits()

Int_t TObject::TestBits ( UInt_t f ) const

inlineinherited

Definition at line 205 of file TObject.h.

UnzipBuffer()

Int_t TKey::UnzipBuffer ( char * targetBuffer, const char * compressedBuffer ) const

privateinherited

Core of uncompressing the key payload.

Returns number of bytes uncompressed. We expect that the compressedBuffer contains the entire key (key header + payload). The target buffer must have space for at least fObjLen bytes. Lastly, the object length must be larger than the key payload, i.e. we already know that we have a compressed payload.

Definition at line 391 of file TKey.cxx.

Update() [1/2]

void TBasket::Update ( Int_t newlast )

inline

Definition at line 152 of file TBasket.h.

Update() [2/2]

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

virtual

Update basket header and EntryOffset table.

Reimplemented in TBasketSQL.

Definition at line 1097 of file TBasket.cxx.

UseCurrentStyle()

void TObject::UseCurrentStyle ( )

virtualinherited

Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

Reimplemented in TAxis3D, TCanvas, TFrame, TGraph, TH1, TPad, TPaveStats, TPaveText, and TTree.

Definition at line 909 of file TObject.cxx.

Warning()

void TObject::Warning ( const char * location, const char * fmt, ... ) const

virtualinherited

Issue warning message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1084 of file TObject.cxx.

Write() [1/2]

Int_t TObject::Write ( const char * name = nullptr, Int_t option = 0, Int_t bufsize = 0 )

virtualinherited

Write this object to the current directory.

For more see the const version of this method.

Reimplemented in ROOT::TBufferMergerFile, TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 989 of file TObject.cxx.

Write() [2/2]

Int_t TObject::Write ( const char * name = nullptr, Int_t option = 0, Int_t bufsize = 0 ) const

virtualinherited

Write this object to the current directory.

The data structure corresponding to this object is serialized. The corresponding buffer is written to the current directory with an associated key with name "name".

Writing an object to a file involves the following steps:

• Creation of a support TKey object in the current directory. The TKey object creates a TBuffer object.
• The TBuffer object is filled via the class::Streamer function.
• If the file is compressed (default) a second buffer is created to hold the compressed buffer.
• Reservation of the corresponding space in the file by looking in the TFree list of free blocks of the file.
• The buffer is written to the file.

Bufsize can be given to force a given buffer size to write this object. By default, the buffersize will be taken from the average buffer size of all objects written to the current file so far.

If a name is specified, it will be the name of the key. If name is not given, the name of the key will be the name as returned by GetName().

The option can be a combination of: kSingleKey, kOverwrite or kWriteDelete Using the kOverwrite option a previous key with the same name is overwritten. The previous key is deleted before writing the new object. Using the kWriteDelete option a previous key with the same name is deleted only after the new object has been written. This option is safer than kOverwrite but it is slower. NOTE: Neither kOverwrite nor kWriteDelete reduces the size of a TFile– the space is simply freed up to be overwritten; in the case of a TTree, it is more complicated. If one opens a TTree, appends some entries, then writes it out, the behaviour is effectively the same. If, however, one creates a new TTree and writes it out in this way, only the metadata is replaced, effectively making the old data invisible without deleting it. TTree::Delete() can be used to mark all disk space occupied by a TTree as free before overwriting its metadata this way. The kSingleKey option is only used by TCollection::Write() to write a container with a single key instead of each object in the container with its own key.

An object is read from the file into memory via TKey::Read() or via TObject::Read().

The function returns the total number of bytes written to the file. It returns 0 if the object cannot be written.

Reimplemented in TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 964 of file TObject.cxx.

WriteBuffer()

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 1140 of file TBasket.cxx.

WriteFile()

Int_t TKey::WriteFile ( Int_t cycle = 1, TFile * f = nullptr )

virtualinherited

Write the encoded object supported by this key.

The function returns the number of bytes committed to the file. If a write error occurs, the number of bytes returned is -1.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 1472 of file TKey.cxx.

WriteFileKeepBuffer()

Int_t TKey::WriteFileKeepBuffer ( TFile * f = nullptr )

protectedvirtualinherited

Write the encoded object supported by this key.

The function returns the number of bytes committed to the file. If a write error occurs, the number of bytes returned is -1.

Definition at line 1504 of file TKey.cxx.

WriteReset()

void TBasket::WriteReset ( )

virtual

Reset the write 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 ..

Definition at line 815 of file TBasket.cxx.

Friends And Related Symbol Documentation

TBranch

friend class TBranch

friend

Definition at line 35 of file TBasket.h.

Member Data Documentation

fBits

UInt_t TObject::fBits

privateinherited

bit field status word

Definition at line 47 of file TObject.h.

fBranch

TBranch* TBasket::fBranch {nullptr}

protected

Pointer to the basket support branch.

Definition at line 73 of file TBasket.h.

fBuffer

char* TKey::fBuffer

protectedinherited

Object buffer.

Definition at line 51 of file TKey.h.

fBufferRef

TBuffer* TKey::fBufferRef

protectedinherited

Pointer to the TBuffer object.

Definition at line 52 of file TKey.h.

fBufferSize

Int_t TBasket::fBufferSize {0}

protected

fBuffer length in bytes

Definition at line 62 of file TBasket.h.

fClassName

TString TKey::fClassName

protectedinherited

Object Class name.

Definition at line 49 of file TKey.h.

fCompressedBufferRef

TBuffer* TBasket::fCompressedBufferRef {nullptr}

protected

! Compressed buffer.

Definition at line 74 of file TBasket.h.

fCycle

Short_t TKey::fCycle

protectedinherited

Cycle number.

Definition at line 46 of file TKey.h.

fDatime

TDatime TKey::fDatime

protectedinherited

Date/Time of insertion in file.

Definition at line 44 of file TKey.h.

fDisplacement

Int_t* TBasket::fDisplacement {nullptr}

protected

![fNevBuf] Displacement of entries in fBuffer(TKey)

Definition at line 70 of file TBasket.h.

fEntryOffset

Int_t* TBasket::fEntryOffset {nullptr}

protected

[fNevBuf] Offset of entries in fBuffer(TKey); generated at runtime.

Special value of -1 indicates that the offset generation MUST be performed on first read.

Definition at line 71 of file TBasket.h.

fgDtorOnly

Longptr_t TObject::fgDtorOnly = 0

staticprivateinherited

object for which to call dtor only (i.e. no delete)

Definition at line 49 of file TObject.h.

fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE

staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.h.

fHeaderOnly

bool TBasket::fHeaderOnly {false}

protected

True when only the basket header must be read/written.

Definition at line 66 of file TBasket.h.

fIOBits

UChar_t TBasket::fIOBits {0}

protected

!IO feature flags. Serialized in custom portion of streamer to avoid forward compat issues unless needed.

Definition at line 67 of file TBasket.h.

fKeylen

Short_t TKey::fKeylen

protectedinherited

Number of bytes for the key itself.

Definition at line 45 of file TKey.h.

fLast

Int_t TBasket::fLast {0}

protected

Pointer to last used byte in basket.

Definition at line 65 of file TBasket.h.

fLastWriteBufferSize

Int_t TBasket::fLastWriteBufferSize[3] = {0,0,0}

protected

! Size of the buffer last three buffers we wrote it to disk

Definition at line 75 of file TBasket.h.

fLeft

Int_t TKey::fLeft

protectedinherited

Number of bytes left in current segment.

Definition at line 50 of file TKey.h.

fMotherDir

TDirectory* TKey::fMotherDir

protectedinherited

!pointer to mother directory

Definition at line 54 of file TKey.h.

fName

TString TNamed::fName

protectedinherited

Definition at line 32 of file TNamed.h.

fNbytes

Int_t TKey::fNbytes

protectedinherited

Number of bytes for the whole key on file (key header and data).

Definition at line 42 of file TKey.h.

fNevBuf

Int_t TBasket::fNevBuf {0}

protected

Number of entries in basket.

Definition at line 64 of file TBasket.h.

fNevBufSize

Int_t TBasket::fNevBufSize {0}

protected

Length in Int_t of fEntryOffset OR fixed length of each entry if fEntryOffset is null!

Definition at line 63 of file TBasket.h.

fNextBufferSizeRecord

UChar_t TBasket::fNextBufferSizeRecord {0}

protected

! Index into fLastWriteBufferSize of the last buffer written to disk

Definition at line 77 of file TBasket.h.

fObjlen

Int_t TKey::fObjlen

protectedinherited

Length of uncompressed object in bytes.

Definition at line 43 of file TKey.h.

fOwnsCompressedBuffer

bool TBasket::fOwnsCompressedBuffer {false}

protected

! Whether or not we own the compressed buffer.

Definition at line 68 of file TBasket.h.

fPidOffset

UShort_t TKey::fPidOffset

protectedinherited

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

Definition at line 53 of file TKey.h.

fReadEntryOffset

bool TBasket::fReadEntryOffset {false}

protected

!Set to true if offset array was read from a file.

Definition at line 69 of file TBasket.h.

fResetAllocation

bool TBasket::fResetAllocation {false}

protected

! True if last reset re-allocated the memory

Definition at line 76 of file TBasket.h.

fSeekKey

Long64_t TKey::fSeekKey

protectedinherited

Location of object on file.

Definition at line 47 of file TKey.h.

fSeekPdir

Long64_t TKey::fSeekPdir

protectedinherited

Location of parent directory on file.

Definition at line 48 of file TKey.h.

fTitle

TString TNamed::fTitle

protectedinherited

Definition at line 33 of file TNamed.h.

fUniqueID

UInt_t TObject::fUniqueID

privateinherited

object unique identifier

Definition at line 46 of file TObject.h.

fVersion

Int_t TKey::fVersion

protectedinherited

Key version identifier.

Definition at line 41 of file TKey.h.

kIOBitCount

int TBasket::kIOBitCount = 1

staticconstexpr

Definition at line 111 of file TBasket.h.

---

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

• tree/tree/inc/TBasket.h
• tree/tree/src/TBasket.cxx