Logo ROOT  
Reference Guide
TLeafObject Class Reference

A TLeaf for a general object derived from TObject.

Definition at line 31 of file TLeafObject.h.

Public Types

enum  EStatusBits { kWarn = BIT(14) }
 
enum  EStatusBitsOldValues { kOldWarn = BIT(12) }
 
- Public Types inherited from TLeaf
enum  DeserializeType { DeserializeType::kInvalid = 0, DeserializeType::kDestructive, DeserializeType::kInPlace, DeserializeType::kZeroCopy }
 
enum  EStatusBits { kIndirectAddress = BIT(11), kNewValue = BIT(12) }
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 

Public Member Functions

 TLeafObject ()
 Default constructor for LeafObject. More...
 
 TLeafObject (TBranch *parent, const char *name, const char *type)
 Create a LeafObject. More...
 
virtual ~TLeafObject ()
 Default destructor for a LeafObject. More...
 
virtual Bool_t CanGenerateOffsetArray ()
 
virtual void FillBasket (TBuffer &b)
 Pack leaf elements in Basket output buffer. More...
 
virtual Int_tGenerateOffsetArrayBase (Int_t, Int_t)
 
TClassGetClass () const
 
TMethodCallGetMethodCall (const char *name)
 Returns pointer to method corresponding to name. More...
 
TObjectGetObject () const
 
const char * GetTypeName () const
 Returns name of leaf type. More...
 
virtual voidGetValuePointer () const
 
Bool_t IsOnTerminalBranch () const
 Return true if this leaf is does not have any sub-branch/leaf. More...
 
Bool_t IsVirtual () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notifcation. More...
 
virtual void PrintValue (Int_t i=0) const
 Prints leaf value. More...
 
virtual void ReadBasket (TBuffer &b)
 Read leaf elements from Basket input buffer. More...
 
virtual void SetAddress (void *add=0)
 Set leaf buffer data address. More...
 
virtual void SetVirtual (Bool_t virt=kTRUE)
 
- Public Member Functions inherited from TLeaf
 TLeaf ()
 
 TLeaf (TBranch *parent, const char *name, const char *type)
 Create a Leaf. More...
 
virtual ~TLeaf ()
 Destructor. More...
 
virtual void Browse (TBrowser *b)
 Browse the content of this leaf. More...
 
virtual void Export (TClonesArray *, Int_t)
 
virtual Int_tGenerateOffsetArray (Int_t base, Int_t events)
 
TBranchGetBranch () const
 
virtual DeserializeType GetDeserializeType () const
 
virtual TString GetFullName () const
 Return the full name (including the parent's branch names) of the leaf. More...
 
virtual TLeafGetLeafCount () 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. More...
 
virtual TLeafGetLeafCounter (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. More...
 
virtual const Counts_tGetLeafCountValues (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. More...
 
virtual Int_t GetLen () const
 Return the number of effective elements of this leaf, for the current entry. More...
 
virtual Int_t GetLenStatic () const
 Return the fixed length of this leaf. More...
 
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 >
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_t IncludeRange (TLeaf *)
 
virtual Bool_t IsRange () const
 
virtual Bool_t 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_t destructor=kFALSE)
 Helper routine for TLeafX::SetAddress. More...
 
virtual void SetBranch (TBranch *branch)
 
virtual void SetLeafCount (TLeaf *leaf)
 Set the leaf count of this leaf. More...
 
virtual void SetLen (Int_t len=1)
 
virtual void SetOffset (Int_t offset=0)
 
virtual void SetRange (Bool_t range=kTRUE)
 
virtual void SetUnsigned ()
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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). More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Protected Attributes

TClassRef fClass
 ! pointer to class More...
 
void ** fObjAddress
 ! Address of Pointer to object More...
 
Bool_t fVirtual
 Support for polymorphism, when set classname is written with object. More...
 
- Protected Attributes inherited from TLeaf
TBranchfBranch
 ! Pointer to supporting branch (we do not own the branch) More...
 
Bool_t fIsRange
 (=kTRUE if leaf has a range, kFALSE otherwise). This is equivalent to being a 'leafcount'. For a TLeafElement the range information is actually store in the TBranchElement. More...
 
Bool_t fIsUnsigned
 (=kTRUE if unsigned, kFALSE otherwise) More...
 
TLeaffLeafCount
 Pointer to Leaf count if variable length (we do not own the counter) More...
 
LeafCountValuesfLeafCountValues
 ! Cache of collection/array sizes More...
 
Int_t fLen
 Number of fixed length elements in the leaf's data. More...
 
Int_t fLenType
 Number of bytes for this data type. More...
 
Int_t fNdata
 ! Number of elements in fAddress data buffer. More...
 
Int_t fOffset
 Offset in ClonesArray object (if one) More...
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Additional Inherited Members

- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Types inherited from TLeaf
using Counts_t = std::vector< Int_t >
 
- Protected Member Functions inherited from TLeaf
 TLeaf (const TLeaf &)
 Copy constructor. More...
 
Int_tGenerateOffsetArrayBase (Int_t base, Int_t events) const
 If the class supports it, generate an offset array base. More...
 
TLeafoperator= (const TLeaf &)
 Assignment operator. More...
 
- 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). More...
 
void MakeZombie ()
 

#include <TLeafObject.h>

Inheritance diagram for TLeafObject:
[legend]

Member Enumeration Documentation

◆ EStatusBits

Enumerator
kWarn 

Definition at line 39 of file TLeafObject.h.

◆ EStatusBitsOldValues

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 ( )
virtual

Default destructor for a LeafObject.

Definition at line 52 of file TLeafObject.cxx.

Member Function Documentation

◆ CanGenerateOffsetArray()

virtual Bool_t TLeafObject::CanGenerateOffsetArray ( )
inlinevirtual

Reimplemented from TLeaf.

Definition at line 56 of file TLeafObject.h.

◆ FillBasket()

void TLeafObject::FillBasket ( TBuffer b)
virtual

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
virtual

Returns name of leaf type.

Reimplemented from TLeaf.

Definition at line 111 of file TLeafObject.cxx.

◆ GetValuePointer()

virtual void* TLeafObject::GetValuePointer ( ) const
inlinevirtual

Reimplemented from TLeaf.

Definition at line 63 of file TLeafObject.h.

◆ IsOnTerminalBranch()

Bool_t TLeafObject::IsOnTerminalBranch ( ) const
virtual

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_t TLeafObject::IsVirtual ( ) const
inline

Definition at line 65 of file TLeafObject.h.

◆ Notify()

Bool_t TLeafObject::Notify ( )
virtual

This method must be overridden to handle object notifcation.

Reimplemented from TObject.

Definition at line 119 of file TLeafObject.cxx.

◆ PrintValue()

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

Prints leaf value.

Reimplemented from TLeaf.

Definition at line 128 of file TLeafObject.cxx.

◆ ReadBasket()

void TLeafObject::ReadBasket ( TBuffer b)
virtual

Read leaf elements from Basket input buffer.

Reimplemented from TLeaf.

Definition at line 136 of file TLeafObject.cxx.

◆ SetAddress()

void TLeafObject::SetAddress ( void add = 0)
virtual

Set leaf buffer data address.

Reimplemented from TLeaf.

Definition at line 184 of file TLeafObject.cxx.

◆ SetVirtual()

virtual void TLeafObject::SetVirtual ( Bool_t  virt = kTRUE)
inlinevirtual

Definition at line 70 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_t 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: