Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TLeafElement Class Reference

A TLeaf for the general case when using the branches created via a TStreamerInfo (i.e.

using TBranchElement).

Definition at line 32 of file TLeafElement.h.

Public Member Functions

 TLeafElement ()
 Default constructor for LeafObject.
 
 TLeafElement (TBranch *parent, const char *name, Int_t id, Int_t type)
 Create a LeafObject.
 
 ~TLeafElement () override
 Default destructor for a LeafObject.
 
Bool_t CanGenerateOffsetArray () override
 
virtual Int_tGenerateOffsetArrayBase (Int_t, Int_t)
 
DeserializeType GetDeserializeType () const override
 Determine if this TLeafElement supports bulk IO.
 
TString GetFullName () const override
 Return the full name (including the parent's branch names) of the leaf.
 
Int_t GetID () const
 
Int_t GetLen () const override
 Return the number of effective elements of this leaf, for the current entry.
 
Int_t GetMaximum () const override
 
TMethodCallGetMethodCall (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;.
 
Int_t GetNdata () const override
 
template<typename T >
GetTypedValueSubArray (Int_t i=0, Int_t j=0) const
 
const char * GetTypeName () const override
 
Double_t GetValue (Int_t i=0) const override
 
Long64_t GetValueLong64 (Int_t i=0) const override
 
LongDouble_t GetValueLongDouble (Int_t i=0) const override
 
void * GetValuePointer () const override
 
Bool_t IncludeRange (TLeaf *) override
 Copy/set fMinimum and fMaximum to include/be wide than those of the parameter.
 
TClassIsA () const override
 
Bool_t IsOnTerminalBranch () const override
 Return true if this leaf is does not have any sub-branch/leaf.
 
void PrintValue (Int_t i=0) const override
 
bool ReadBasketFast (TBuffer &, Long64_t) override
 Deserialize N events from an input buffer.
 
void SetLeafCount (TLeaf *leaf) override
 Set the leaf count of this leaf.
 
void Streamer (TBuffer &) override
 Stream a class object.
 
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 void FillBasket (TBuffer &b)
 Pack leaf elements in Basket output buffer.
 
virtual Int_tGenerateOffsetArray (Int_t base, Int_t events)
 
TBranchGetBranch () const
 
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.
 
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.
 
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.
 
virtual Int_t GetLenStatic () const
 Return the fixed length of this leaf.
 
virtual Int_t GetLenType () const
 
virtual Int_t GetMinimum () const
 
virtual Int_t GetOffset () const
 
template<typename T >
GetTypedValue (Int_t i=0) const
 
virtual void Import (TClonesArray *, Int_t)
 
virtual Bool_t IsRange () const
 
virtual Bool_t IsUnsigned () const
 
virtual void ReadBasket (TBuffer &)
 
virtual void ReadBasketExport (TBuffer &, TClonesArray *, Int_t)
 
virtual bool ReadBasketSerialized (TBuffer &, Long64_t)
 
virtual void ReadValue (std::istream &, Char_t=' ')
 
Int_t ResetAddress (void *add, Bool_t calledFromDestructor=kFALSE)
 Helper routine for TLeafX::SetAddress.
 
virtual void SetAddress (void *add=nullptr)
 
virtual void SetBranch (TBranch *branch)
 
virtual void SetLen (Int_t len=1)
 
virtual void SetOffset (Int_t offset=0)
 
virtual void SetRange (Bool_t range=kTRUE)
 
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 ("").
 
TObjectClone (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.
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title.
 
TNamedoperator= (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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () 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_tGetOption () 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).
 
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 *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)
 
TObjectoperator= (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 TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TLeaf
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
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

char * fAbsAddress
 ! Absolute leaf Address
 
std::atomic< EDataTypefDataTypeCache {EDataType::kOther_t}
 ! Cache of the EDataType of deserialization.
 
std::atomic< DeserializeTypefDeserializeTypeCache { DeserializeType::kInvalid }
 ! Cache of the type of deserialization.
 
Int_t fID
 element serial number in fInfo
 
Int_t fType
 leaf type
 
- Protected Attributes inherited from TLeaf
TBranchfBranch
 ! Pointer to supporting branch (we do not own the branch)
 
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.
 
Bool_t fIsUnsigned
 (=kTRUE if unsigned, kFALSE otherwise)
 
TLeaffLeafCount
 Pointer to Leaf count if variable length (we do not own the counter)
 
LeafCountValuesfLeafCountValues
 ! 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
 

Private Member Functions

Int_t GetOffsetHeaderSize () const override
 

Additional Inherited Members

- 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 ))
}
 
- 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_tGenerateOffsetArrayBase (Int_t base, Int_t events) const
 If the class supports it, generate an offset array base.
 
TLeafoperator= (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 <TLeafElement.h>

Inheritance diagram for TLeafElement:
[legend]

Constructor & Destructor Documentation

◆ TLeafElement() [1/2]

TLeafElement::TLeafElement ( )

Default constructor for LeafObject.

Definition at line 30 of file TLeafElement.cxx.

◆ TLeafElement() [2/2]

TLeafElement::TLeafElement ( TBranch parent,
const char *  name,
Int_t  id,
Int_t  type 
)

Create a LeafObject.

Definition at line 40 of file TLeafElement.cxx.

◆ ~TLeafElement()

TLeafElement::~TLeafElement ( )
override

Default destructor for a LeafObject.

Definition at line 104 of file TLeafElement.cxx.

Member Function Documentation

◆ CanGenerateOffsetArray()

Bool_t TLeafElement::CanGenerateOffsetArray ( )
inlineoverridevirtual

Reimplemented from TLeaf.

Definition at line 49 of file TLeafElement.h.

◆ Class()

static TClass * TLeafElement::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TLeafElement::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TLeafElement::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 74 of file TLeafElement.h.

◆ DeclFileName()

static const char * TLeafElement::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 74 of file TLeafElement.h.

◆ GenerateOffsetArrayBase()

virtual Int_t * TLeafElement::GenerateOffsetArrayBase ( Int_t  ,
Int_t   
)
inlinevirtual

Definition at line 50 of file TLeafElement.h.

◆ GetDeserializeType()

TLeaf::DeserializeType TLeafElement::GetDeserializeType ( ) const
overridevirtual

Determine if this TLeafElement supports bulk IO.

Reimplemented from TLeaf.

Definition at line 111 of file TLeafElement.cxx.

◆ GetFullName()

TString TLeafElement::GetFullName ( ) const
overridevirtual

Return the full name (including the parent's branch names) of the leaf.

Reimplemented from TLeaf.

Definition at line 165 of file TLeafElement.cxx.

◆ GetID()

Int_t TLeafElement::GetID ( ) const
inline

Definition at line 53 of file TLeafElement.h.

◆ GetLen()

Int_t TLeafElement::GetLen ( ) const
inlineoverridevirtual

Return the number of effective elements of this leaf, for the current entry.

Reimplemented from TLeaf.

Definition at line 55 of file TLeafElement.h.

◆ GetMaximum()

Int_t TLeafElement::GetMaximum ( ) const
inlineoverridevirtual

Reimplemented from TLeaf.

Definition at line 57 of file TLeafElement.h.

◆ GetMethodCall()

TMethodCall * TLeafElement::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 157 of file TLeafElement.cxx.

◆ GetNdata()

Int_t TLeafElement::GetNdata ( ) const
inlineoverridevirtual

Reimplemented from TLeaf.

Definition at line 58 of file TLeafElement.h.

◆ GetOffsetHeaderSize()

Int_t TLeafElement::GetOffsetHeaderSize ( ) const
inlineoverrideprivatevirtual

Reimplemented from TLeaf.

Definition at line 42 of file TLeafElement.h.

◆ GetTypedValueSubArray()

template<typename T >
T TLeafElement::GetTypedValueSubArray ( Int_t  i = 0,
Int_t  j = 0 
) const
inline

Definition at line 64 of file TLeafElement.h.

◆ GetTypeName()

const char * TLeafElement::GetTypeName ( ) const
inlineoverridevirtual

Reimplemented from TLeaf.

Definition at line 59 of file TLeafElement.h.

◆ GetValue()

Double_t TLeafElement::GetValue ( Int_t  i = 0) const
inlineoverridevirtual

Reimplemented from TLeaf.

Definition at line 61 of file TLeafElement.h.

◆ GetValueLong64()

Long64_t TLeafElement::GetValueLong64 ( Int_t  i = 0) const
inlineoverridevirtual

Reimplemented from TLeaf.

Definition at line 62 of file TLeafElement.h.

◆ GetValueLongDouble()

LongDouble_t TLeafElement::GetValueLongDouble ( Int_t  i = 0) const
inlineoverridevirtual

Reimplemented from TLeaf.

Definition at line 63 of file TLeafElement.h.

◆ GetValuePointer()

void * TLeafElement::GetValuePointer ( ) const
inlineoverridevirtual

Reimplemented from TLeaf.

Definition at line 68 of file TLeafElement.h.

◆ IncludeRange()

Bool_t TLeafElement::IncludeRange ( TLeaf input)
overridevirtual

Copy/set fMinimum and fMaximum to include/be wide than those of the parameter.

Reimplemented from TLeaf.

Definition at line 180 of file TLeafElement.cxx.

◆ IsA()

TClass * TLeafElement::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TLeaf.

Definition at line 74 of file TLeafElement.h.

◆ IsOnTerminalBranch()

Bool_t TLeafElement::IsOnTerminalBranch ( ) const
overridevirtual

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

Reimplemented from TLeaf.

Definition at line 194 of file TLeafElement.cxx.

◆ PrintValue()

void TLeafElement::PrintValue ( Int_t  i = 0) const
inlineoverridevirtual

Reimplemented from TLeaf.

Definition at line 71 of file TLeafElement.h.

◆ ReadBasketFast()

Bool_t TLeafElement::ReadBasketFast ( TBuffer input_buf,
Long64_t  N 
)
overridevirtual

Deserialize N events from an input buffer.

Reimplemented from TLeaf.

Definition at line 144 of file TLeafElement.cxx.

◆ SetLeafCount()

void TLeafElement::SetLeafCount ( TLeaf leaf)
inlineoverridevirtual

Set the leaf count of this leaf.

Reimplemented from TLeaf.

Definition at line 72 of file TLeafElement.h.

◆ Streamer()

void TLeafElement::Streamer ( TBuffer b)
overridevirtual

Stream a class object.

Reimplemented from TLeaf.

◆ StreamerNVirtual()

void TLeafElement::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 74 of file TLeafElement.h.

Member Data Documentation

◆ fAbsAddress

char* TLeafElement::fAbsAddress
protected

! Absolute leaf Address

Definition at line 35 of file TLeafElement.h.

◆ fDataTypeCache

std::atomic<EDataType> TLeafElement::fDataTypeCache {EDataType::kOther_t}
mutableprotected

! Cache of the EDataType of deserialization.

Definition at line 39 of file TLeafElement.h.

◆ fDeserializeTypeCache

std::atomic<DeserializeType> TLeafElement::fDeserializeTypeCache { DeserializeType::kInvalid }
mutableprotected

! Cache of the type of deserialization.

Definition at line 38 of file TLeafElement.h.

◆ fID

Int_t TLeafElement::fID
protected

element serial number in fInfo

Definition at line 36 of file TLeafElement.h.

◆ fType

Int_t TLeafElement::fType
protected

leaf type

Definition at line 37 of file TLeafElement.h.

Libraries for TLeafElement:

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