Logo ROOT   6.11/03
Reference Guide
List of all members | Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TLeaf Class Reference

A TLeaf describes individual elements of a TBranch See TBranch structure in TTree.

Definition at line 32 of file TLeaf.h.

Classes

struct  GetValueHelper
 
struct  GetValueHelper< Long64_t >
 
struct  GetValueHelper< LongDouble_t >
 
struct  GetValueHelper< ULong64_t >
 

Public Types

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

 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 Bool_t CanGenerateOffsetArray ()
 
virtual void Export (TClonesArray *, Int_t)
 
virtual void FillBasket (TBuffer &b)
 Pack leaf elements in Basket output buffer. More...
 
virtual Int_tGenerateOffsetArray (Int_t base, Int_t events)
 
TBranchGetBranch () const
 
virtual TLeafGetLeafCount () const
 
virtual TLeafGetLeafCounter (Int_t &countval) const
 Return a pointer to the counter of this leaf. More...
 
virtual Int_t GetLen () const
 Return the number of effective elements of this leaf. More...
 
virtual Int_t GetLenStatic () const
 
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 const char * GetTypeName () 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 voidGetValuePointer () const
 
virtual void Import (TClonesArray *, Int_t)
 
virtual Bool_t IsOnTerminalBranch () const
 
virtual Bool_t IsRange () const
 
virtual Bool_t IsUnsigned () const
 
virtual void PrintValue (Int_t i=0) const
 
virtual void ReadBasket (TBuffer &)
 
virtual void ReadBasketExport (TBuffer &, TClonesArray *, Int_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 SetAddress (void *add=0)
 
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 TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
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 ()
 Checked and record whether for 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...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. 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, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
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 Member Functions

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

Protected Attributes

TBranchfBranch
 ! Pointer to supporting branch (we do not own the branch) More...
 
Bool_t fIsRange
 (=kTRUE if leaf has a range, kFALSE otherwise) 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...
 
Int_t fLen
 Number of fixed length elements. 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...
 

#include <TLeaf.h>

Inheritance diagram for TLeaf:
[legend]

Member Enumeration Documentation

Enumerator
kIndirectAddress 

Data member is a pointer to an array of basic types.

kNewValue 

Set if we own the value buffer and so must delete it ourselves.

Definition at line 57 of file TLeaf.h.

Constructor & Destructor Documentation

TLeaf::TLeaf ( const TLeaf lf)
protected

Copy constructor.

Definition at line 75 of file TLeaf.cxx.

TLeaf::TLeaf ( )

Definition at line 32 of file TLeaf.cxx.

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

Create a Leaf.

See the TTree and TBranch constructors for explanation of parameters.

Definition at line 50 of file TLeaf.cxx.

TLeaf::~TLeaf ( )
virtual

Destructor.

Definition at line 110 of file TLeaf.cxx.

Member Function Documentation

void TLeaf::Browse ( TBrowser b)
virtual

Browse the content of this leaf.

Reimplemented from TObject.

Definition at line 126 of file TLeaf.cxx.

virtual Bool_t TLeaf::CanGenerateOffsetArray ( )
inlinevirtual

Reimplemented in TLeafObject, and TLeafElement.

Definition at line 67 of file TLeaf.h.

virtual void TLeaf::Export ( TClonesArray ,
Int_t   
)
inlinevirtual

Reimplemented in TLeafI, TLeafL, TLeafB, TLeafC, TLeafD, TLeafF, TLeafO, and TLeafS.

Definition at line 68 of file TLeaf.h.

void TLeaf::FillBasket ( TBuffer b)
virtual

Pack leaf elements in Basket output buffer.

Reimplemented in TLeafObject, TLeafI, TLeafL, TLeafB, TLeafC, TLeafD, TLeafF, TLeafO, and TLeafS.

Definition at line 149 of file TLeaf.cxx.

virtual Int_t* TLeaf::GenerateOffsetArray ( Int_t  base,
Int_t  events 
)
inlinevirtual

Definition at line 70 of file TLeaf.h.

Int_t * TLeaf::GenerateOffsetArrayBase ( Int_t  base,
Int_t  events 
) const
protected

If the class supports it, generate an offset array base.

This class only returns nullptr on error.

Definition at line 157 of file TLeaf.cxx.

TBranch* TLeaf::GetBranch ( ) const
inline

Definition at line 71 of file TLeaf.h.

virtual TLeaf* TLeaf::GetLeafCount ( ) const
inlinevirtual

Definition at line 72 of file TLeaf.h.

TLeaf * TLeaf::GetLeafCounter ( Int_t countval) const
virtual

Return a pointer to the counter of this leaf.

  • If leaf name has the form var[nelem], where nelem is alphanumeric, then if nelem is a leaf name, return countval = 1 and the pointer to the leaf named nelem, otherwise return 0.
  • If leaf name has the form var[nelem], where nelem is a non-negative integer, then return countval = nelem and a null pointer.
  • If leaf name has the form of a multi-dimensional array (e.g. var[nelem][nelem2] where nelem and nelem2 are non-negative integers) then return countval = product of all dimension sizes and a null pointer.
  • If leaf name has the form var[... (and does not match the previous 2 cases) return countval = -1 and null pointer;
  • Otherwise return countval = 1 and a null pointer.

Definition at line 196 of file TLeaf.cxx.

Int_t TLeaf::GetLen ( ) const
virtual

Return the number of effective elements of this leaf.

Reimplemented in TLeafElement.

Definition at line 307 of file TLeaf.cxx.

virtual Int_t TLeaf::GetLenStatic ( ) const
inlinevirtual

Definition at line 75 of file TLeaf.h.

virtual Int_t TLeaf::GetLenType ( ) const
inlinevirtual

Definition at line 76 of file TLeaf.h.

virtual Int_t TLeaf::GetMaximum ( ) const
inlinevirtual

Reimplemented in TLeafElement, TLeafI, TLeafL, TLeafB, TLeafC, TLeafO, and TLeafS.

Definition at line 77 of file TLeaf.h.

virtual Int_t TLeaf::GetMinimum ( ) const
inlinevirtual

Reimplemented in TLeafI, TLeafL, TLeafB, TLeafC, TLeafO, and TLeafS.

Definition at line 78 of file TLeaf.h.

virtual Int_t TLeaf::GetNdata ( ) const
inlinevirtual

Reimplemented in TLeafElement.

Definition at line 79 of file TLeaf.h.

virtual Int_t TLeaf::GetOffset ( ) const
inlinevirtual

Definition at line 80 of file TLeaf.h.

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

Definition at line 87 of file TLeaf.h.

virtual const char* TLeaf::GetTypeName ( ) const
inlinevirtual

Reimplemented in TLeafObject, TLeafElement, TLeafB, TLeafC, TLeafO, TLeafS, TLeafI, TLeafL, TLeafD, and TLeafF.

Definition at line 82 of file TLeaf.h.

Double_t TLeaf::GetValue ( Int_t  i = 0) const
inlinevirtual

Reimplemented in TLeafElement, TLeafI, TLeafL, TLeafB, TLeafC, TLeafO, TLeafS, TLeafD, and TLeafF.

Definition at line 123 of file TLeaf.h.

virtual Long64_t TLeaf::GetValueLong64 ( Int_t  i = 0) const
inlinevirtual

Reimplemented in TLeafElement, and TLeafL.

Definition at line 85 of file TLeaf.h.

virtual LongDouble_t TLeaf::GetValueLongDouble ( Int_t  i = 0) const
inlinevirtual

Reimplemented in TLeafElement, and TLeafL.

Definition at line 86 of file TLeaf.h.

virtual void* TLeaf::GetValuePointer ( ) const
inlinevirtual

Reimplemented in TLeafObject, TLeafElement, TLeafL, TLeafI, TLeafB, TLeafC, TLeafO, TLeafS, TLeafD, and TLeafF.

Definition at line 81 of file TLeaf.h.

virtual void TLeaf::Import ( TClonesArray ,
Int_t   
)
inlinevirtual

Reimplemented in TLeafL, TLeafC, TLeafI, TLeafB, TLeafO, TLeafS, TLeafD, and TLeafF.

Definition at line 89 of file TLeaf.h.

virtual Bool_t TLeaf::IsOnTerminalBranch ( ) const
inlinevirtual

Reimplemented in TLeafObject, and TLeafElement.

Definition at line 90 of file TLeaf.h.

virtual Bool_t TLeaf::IsRange ( ) const
inlinevirtual

Definition at line 91 of file TLeaf.h.

virtual Bool_t TLeaf::IsUnsigned ( ) const
inlinevirtual

Definition at line 92 of file TLeaf.h.

TLeaf & TLeaf::operator= ( const TLeaf lf)
protected

Assignment operator.

Definition at line 91 of file TLeaf.cxx.

void TLeaf::PrintValue ( Int_t  i = 0) const
inlinevirtual

Reimplemented in TLeafObject, TLeafElement, TLeafL, TLeafC, TLeafI, TLeafB, TLeafO, TLeafS, TLeafD, and TLeafF.

Definition at line 124 of file TLeaf.h.

virtual void TLeaf::ReadBasket ( TBuffer )
inlinevirtual

Reimplemented in TLeafObject, TLeafL, TLeafC, TLeafI, TLeafB, TLeafO, TLeafS, TLeafD, and TLeafF.

Definition at line 94 of file TLeaf.h.

virtual void TLeaf::ReadBasketExport ( TBuffer ,
TClonesArray ,
Int_t   
)
inlinevirtual

Reimplemented in TLeafL, TLeafC, TLeafI, TLeafB, TLeafO, TLeafS, TLeafD, and TLeafF.

Definition at line 95 of file TLeaf.h.

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

Reimplemented in TLeafL, TLeafC, TLeafI, TLeafB, TLeafO, TLeafS, TLeafD, and TLeafF.

Definition at line 96 of file TLeaf.h.

Int_t TLeaf::ResetAddress ( void addr,
Bool_t  calledFromDestructor = kFALSE 
)

Helper routine for TLeafX::SetAddress.

The return value is non-zero if we owned the old value buffer and must delete it now. The size of the value buffer is recalculated and stored, and a decision is made whether or not we own the new value buffer.

Definition at line 332 of file TLeaf.cxx.

void TLeaf::SetAddress ( void add = 0)
inlinevirtual

Reimplemented in TLeafObject, TLeafL, TLeafC, TLeafI, TLeafB, TLeafO, TLeafS, TLeafD, and TLeafF.

Definition at line 125 of file TLeaf.h.

virtual void TLeaf::SetBranch ( TBranch branch)
inlinevirtual

Definition at line 101 of file TLeaf.h.

void TLeaf::SetLeafCount ( TLeaf leaf)
virtual

Set the leaf count of this leaf.

Reimplemented in TLeafElement.

Definition at line 368 of file TLeaf.cxx.

virtual void TLeaf::SetLen ( Int_t  len = 1)
inlinevirtual

Definition at line 103 of file TLeaf.h.

virtual void TLeaf::SetOffset ( Int_t  offset = 0)
inlinevirtual

Definition at line 104 of file TLeaf.h.

virtual void TLeaf::SetRange ( Bool_t  range = kTRUE)
inlinevirtual

Definition at line 105 of file TLeaf.h.

virtual void TLeaf::SetUnsigned ( )
inlinevirtual

Definition at line 106 of file TLeaf.h.

Member Data Documentation

TBranch* TLeaf::fBranch
protected

! Pointer to supporting branch (we do not own the branch)

Definition at line 43 of file TLeaf.h.

Bool_t TLeaf::fIsRange
protected

(=kTRUE if leaf has a range, kFALSE otherwise)

Definition at line 40 of file TLeaf.h.

Bool_t TLeaf::fIsUnsigned
protected

(=kTRUE if unsigned, kFALSE otherwise)

Definition at line 41 of file TLeaf.h.

TLeaf* TLeaf::fLeafCount
protected

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

Definition at line 42 of file TLeaf.h.

Int_t TLeaf::fLen
protected

Number of fixed length elements.

Definition at line 37 of file TLeaf.h.

Int_t TLeaf::fLenType
protected

Number of bytes for this data type.

Definition at line 38 of file TLeaf.h.

Int_t TLeaf::fNdata
protected

! Number of elements in fAddress data buffer

Definition at line 36 of file TLeaf.h.

Int_t TLeaf::fOffset
protected

Offset in ClonesArray object (if one)

Definition at line 39 of file TLeaf.h.

Libraries for TLeaf:
[legend]

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