A TLeaf for a general object derived from TObject.

Definition at line 31 of file TLeafObject.h.

Public Types
enum	EStatusBits { kWarn = (1ULL << ( 14 )) }

enum	EStatusBitsOldValues { kOldWarn = (1ULL << ( 12 )) }
	In version of ROOT older then v6.12, kWarn was set to BIT(12) which overlaps with TBranch::kBranchObject. More...

Public Types inherited from TLeaf
enum class	DeserializeType { kInvalid = 0 , kExternal , kDestructive = kExternal , kInPlace , kZeroCopy }

enum	EStatusBits { kIndirectAddress = (1ULL << ( 11 )) , kNewValue = (1ULL << ( 12 )) }

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

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

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

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

Public Member Functions
	TLeafObject ()
	Default constructor for LeafObject.

	TLeafObject (TBranch parent, const char name, const char *type)
	Create a LeafObject.

	~TLeafObject () override
	Default destructor for a LeafObject.

bool	CanGenerateOffsetArray () override

void	FillBasket (TBuffer &b) override
	Pack leaf elements in Basket output buffer.

virtual Int_t *	GenerateOffsetArrayBase (Int_t, Int_t)

TClass *	GetClass () const

TMethodCall *	GetMethodCall (const char *name)
	Returns pointer to method corresponding to name.

TObject *	GetObject () const

const char *	GetTypeName () const override
	Returns name of leaf type.

void *	GetValuePointer () const override

TClass *	IsA () const override

bool	IsOnTerminalBranch () const override
	Return true if this leaf is does not have any sub-branch/leaf.

bool	IsVirtual () const

bool	Notify () override
	This method must be overridden to handle object notification.

void	PrintValue (Int_t i=0) const override
	Prints leaf value.

void	ReadBasket (TBuffer &b) override
	Read leaf elements from Basket input buffer.

void	SetAddress (void *add=nullptr) override
	Set leaf buffer data address.

virtual void	SetVirtual (bool virt=true)

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TLeaf
	TLeaf ()

	TLeaf (TBranch parent, const char name, const char *type)
	Create a Leaf.

	~TLeaf () override
	Destructor.

void	Browse (TBrowser *b) override
	Browse the content of this leaf.

virtual void	Export (TClonesArray *, Int_t)

virtual Int_t *	GenerateOffsetArray (Int_t base, Int_t events)

TBranch *	GetBranch () const

virtual DeserializeType	GetDeserializeType () const

virtual TString	GetFullName () const
	Return the full name (including the parent's branch names) of the leaf.

virtual TLeaf *	GetLeafCount () const
	If this leaf stores a variable-sized array or a multi-dimensional array whose last dimension has variable size, return a pointer to the TLeaf that stores such size.

virtual TLeaf *	GetLeafCounter (Int_t &countval) const
	Return a pointer to the counter of this leaf (if any) or store the number of elements that the leaf contains in countval.

virtual const Counts_t *	GetLeafCountValues (Long64_t start, Long64_t len)
	If this branch is a branch count, return the set of collection size for the entry range requested start: first entry to read and return information about len: number of entries to read.

virtual Int_t	GetLen () const
	Return the number of effective elements of this leaf, for the current entry.

virtual Int_t	GetLenStatic () const
	Return the fixed length of this leaf.

virtual Int_t	GetLenType () const

virtual Int_t	GetMaximum () const

virtual Int_t	GetMinimum () const

virtual Int_t	GetNdata () const

virtual Int_t	GetOffset () const

template<typename T >
T	GetTypedValue (Int_t i=0) const

virtual Double_t	GetValue (Int_t i=0) const

virtual Long64_t	GetValueLong64 (Int_t i=0) const

virtual LongDouble_t	GetValueLongDouble (Int_t i=0) const

virtual void	Import (TClonesArray *, Int_t)

virtual bool	IncludeRange (TLeaf *)

virtual bool	IsRange () const

virtual bool	IsUnsigned () const

virtual void	ReadBasketExport (TBuffer &, TClonesArray *, Int_t)

virtual bool	ReadBasketFast (TBuffer &, Long64_t)

virtual bool	ReadBasketSerialized (TBuffer &, Long64_t)

virtual void	ReadValue (std::istream &, Char_t=' ')

Int_t	ResetAddress (void *add, bool calledFromDestructor=false)
	Helper routine for TLeafX::SetAddress.

virtual void	SetBranch (TBranch *branch)

virtual void	SetLeafCount (TLeaf *leaf)
	Set the leaf count of this leaf.

virtual void	SetLen (Int_t len=1)

virtual void	SetOffset (Int_t offset=0)

virtual void	SetRange (bool range=true)

virtual void	SetUnsigned ()

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)
	TNamed copy ctor.

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

virtual	~TNamed ()
	TNamed destructor.

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

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

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

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

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

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

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

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

TClass *	IsA () const override

Bool_t	IsSortable () const override

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

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

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

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

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

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

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

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual Option_t *	GetOption () const

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

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

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

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

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

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

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

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

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

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

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

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

void	operator delete (void *ptr)
	Operator delete.

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

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

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

void *	operator new (size_t sz)

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

void *	operator new[] (size_t sz)

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

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

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

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

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

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

void	ResetBit (UInt_t f)

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

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

void	SetBit (UInt_t f)

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

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

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

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

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

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

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

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

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

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

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

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

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

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

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

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

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

Protected Attributes
TClassRef	fClass
	! pointer to class

void **	fObjAddress
	! Address of Pointer to object

bool	fVirtual
	Support for polymorphism, when set classname is written with object.

Protected Attributes inherited from TLeaf
TBranch *	fBranch
	! Pointer to supporting branch (we do not own the branch)

bool	fIsRange
	(=true if leaf has a range, false otherwise). This is equivalent to being a 'leafcount'. For a TLeafElement the range information is actually store in the TBranchElement.

bool	fIsUnsigned
	(=true if unsigned, false otherwise)

TLeaf *	fLeafCount
	Pointer to Leaf count if variable length (we do not own the counter)

LeafCountValues *	fLeafCountValues
	! Cache of collection/array sizes

Int_t	fLen
	Number of fixed length elements in the leaf's data.

Int_t	fLenType
	Number of bytes for this data type.

Int_t	fNdata
	! Number of elements in fAddress data buffer.

Int_t	fOffset
	Offset in ClonesArray object (if one)

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Additional Inherited Members
Protected Types inherited from TLeaf
using	Counts_t = std::vector< Int_t >

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

Protected Member Functions inherited from TLeaf
	TLeaf (const TLeaf &)
	Copy constructor.

Int_t *	GenerateOffsetArrayBase (Int_t base, Int_t events) const
	If the class supports it, generate an offset array base.

TLeaf &	operator= (const TLeaf &)
	Assignment operator.

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

#include <TLeafObject.h>

Inheritance diagram for TLeafObject:

[legend]

Member Enumeration Documentation

◆ EStatusBits

enum TLeafObject::EStatusBits

Enumerator
kWarn

Definition at line 39 of file TLeafObject.h.

◆ EStatusBitsOldValues

enum TLeafObject::EStatusBitsOldValues

In version of ROOT older then v6.12, kWarn was set to BIT(12) which overlaps with TBranch::kBranchObject.

Since it stored in ROOT files as part of the TBranchObject and that we want to reset in TBranchObject::Streamer, we need to keep track of the old value.

Enumerator
kOldWarn

Definition at line 48 of file TLeafObject.h.

Constructor & Destructor Documentation

◆ TLeafObject() [1/2]

TLeafObject::TLeafObject ( )

Default constructor for LeafObject.

Definition at line 30 of file TLeafObject.cxx.

◆ TLeafObject() [2/2]

TLeafObject::TLeafObject	(	TBranch *	parent,
		const char *	name,
		const char *	type
	)

Create a LeafObject.

Definition at line 40 of file TLeafObject.cxx.

◆ ~TLeafObject()

TLeafObject::~TLeafObject ( )

override

Default destructor for a LeafObject.

Definition at line 52 of file TLeafObject.cxx.

Member Function Documentation

◆ CanGenerateOffsetArray()

bool TLeafObject::CanGenerateOffsetArray ( )

inlineoverridevirtual

Reimplemented from TLeaf.

Definition at line 56 of file TLeafObject.h.

◆ Class()

static TClass * TLeafObject::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TLeafObject::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TLeafObject::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 72 of file TLeafObject.h.

◆ DeclFileName()

static const char * TLeafObject::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 72 of file TLeafObject.h.

◆ FillBasket()

void TLeafObject::FillBasket ( TBuffer & b )

overridevirtual

Pack leaf elements in Basket output buffer.

Reimplemented from TLeaf.

Definition at line 59 of file TLeafObject.cxx.

◆ GenerateOffsetArrayBase()

virtual Int_t * TLeafObject::GenerateOffsetArrayBase	(	Int_t	,
		Int_t
	)

inlinevirtual

Definition at line 58 of file TLeafObject.h.

◆ GetClass()

TClass * TLeafObject::GetClass ( ) const

inline

Definition at line 59 of file TLeafObject.h.

◆ GetMethodCall()

TMethodCall * TLeafObject::GetMethodCall ( const char * name )

Returns pointer to method corresponding to name.

name is a string with the general form "method(list of params)" If list of params is omitted, () is assumed;

Definition at line 91 of file TLeafObject.cxx.

◆ GetObject()

TObject * TLeafObject::GetObject ( ) const

inline

Definition at line 61 of file TLeafObject.h.

◆ GetTypeName()

const char * TLeafObject::GetTypeName ( ) const

overridevirtual

Returns name of leaf type.

Reimplemented from TLeaf.

Definition at line 111 of file TLeafObject.cxx.

◆ GetValuePointer()

void * TLeafObject::GetValuePointer ( ) const

inlineoverridevirtual

Reimplemented from TLeaf.

Definition at line 63 of file TLeafObject.h.

◆ IsA()

TClass * TLeafObject::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TLeaf.

Definition at line 72 of file TLeafObject.h.

◆ IsOnTerminalBranch()

bool TLeafObject::IsOnTerminalBranch ( ) const

overridevirtual

Return true if this leaf is does not have any sub-branch/leaf.

Reimplemented from TLeaf.

Definition at line 230 of file TLeafObject.cxx.

◆ IsVirtual()

bool TLeafObject::IsVirtual ( ) const

inline

Definition at line 65 of file TLeafObject.h.

◆ Notify()

bool TLeafObject::Notify ( )

overridevirtual

This method must be overridden to handle object notification.

Reimplemented from TObject.

Definition at line 119 of file TLeafObject.cxx.

◆ PrintValue()

void TLeafObject::PrintValue ( Int_t i = 0 ) const

overridevirtual

Prints leaf value.

Reimplemented from TLeaf.

Definition at line 128 of file TLeafObject.cxx.

◆ ReadBasket()

void TLeafObject::ReadBasket ( TBuffer & b )

overridevirtual

Read leaf elements from Basket input buffer.

Reimplemented from TLeaf.

Definition at line 136 of file TLeafObject.cxx.

◆ SetAddress()

void TLeafObject::SetAddress ( void * add = nullptr )

overridevirtual

Set leaf buffer data address.

Reimplemented from TLeaf.

Definition at line 184 of file TLeafObject.cxx.

◆ SetVirtual()

virtual void TLeafObject::SetVirtual ( bool virt = true )

inlinevirtual

Definition at line 70 of file TLeafObject.h.

◆ Streamer()

void TLeafObject::Streamer ( TBuffer & b )

overridevirtual

Stream an object of class TLeafObject.

Reimplemented from TLeaf.

Definition at line 192 of file TLeafObject.cxx.

◆ StreamerNVirtual()

void TLeafObject::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 72 of file TLeafObject.h.

Member Data Documentation

◆ fClass

TClassRef TLeafObject::fClass

protected

! pointer to class

Definition at line 34 of file TLeafObject.h.

◆ fObjAddress

void** TLeafObject::fObjAddress

protected

! Address of Pointer to object

Definition at line 35 of file TLeafObject.h.

◆ fVirtual

bool TLeafObject::fVirtual

protected

Support for polymorphism, when set classname is written with object.

Definition at line 36 of file TLeafObject.h.

Libraries for TLeafObject:

[legend]

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

tree/tree/inc/TLeafObject.h
tree/tree/src/TLeafObject.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ EStatusBits

◆ EStatusBitsOldValues

Constructor & Destructor Documentation

◆ TLeafObject() [1/2]

◆ TLeafObject() [2/2]

◆ ~TLeafObject()

Member Function Documentation

◆ CanGenerateOffsetArray()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ FillBasket()

◆ GenerateOffsetArrayBase()

◆ GetClass()

◆ GetMethodCall()

◆ GetObject()

◆ GetTypeName()

◆ GetValuePointer()

◆ IsA()

◆ IsOnTerminalBranch()

◆ IsVirtual()

◆ Notify()

◆ PrintValue()

◆ ReadBasket()

◆ SetAddress()

◆ SetVirtual()

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ fClass

◆ fObjAddress

◆ fVirtual