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

A small helper class to implement reading a data member on a generic collection object stored in a TTree.

Definition at line 261 of file TFormLeafInfo.h.

Public Member Functions

 TFormLeafInfoCollection ()
 Constructor.
 
 TFormLeafInfoCollection (const TFormLeafInfoCollection &orig)
 Constructor.
 
 TFormLeafInfoCollection (TClass *classptr, Longptr_t offset, TStreamerElement *element, Bool_t top=kFALSE)
 Constructor.
 
 TFormLeafInfoCollection (TClass *motherclassptr, Longptr_t offset=0, TClass *elementclassptr=nullptr, Bool_t top=kFALSE)
 Constructor.
 
 ~TFormLeafInfoCollection () override
 Destructor.
 
TFormLeafInfoDeepCopy () const override
 Copy of the object and its content.
 
Int_t GetCounterValue (TLeaf *leaf) override
 Return the current size of the TClonesArray.
 
virtual Int_t GetCounterValue (TLeaf *leaf, Int_t instance)
 Return the current size of the TClonesArray.
 
void * GetLocalValuePointer (char *thisobj, Int_t instance=0) override
 Return the address of the local value.
 
void * GetLocalValuePointer (TLeaf *leaf, Int_t instance=0) override
 Return the pointer to the clonesArray.
 
Double_t GetValue (TLeaf *leaf, Int_t instance=0) override
 
template<typename T >
GetValueImpl (TLeaf *leaf, Int_t instance=0)
 Return the value of the underlying data member inside the clones array.
 
Long64_t GetValueLong64 (TLeaf *leaf, Int_t instance=0) override
 
LongDouble_t GetValueLongDouble (TLeaf *leaf, Int_t instance=0) override
 
void * GetValuePointer (char *thisobj, Int_t instance=0) override
 Return the pointer to the clonesArray.
 
void * GetValuePointer (TLeaf *leaf, Int_t instance=0) override
 Return the pointer to the clonesArray.
 
Bool_t HasCounter () const override
 Return true if the underlying data has a array size counter.
 
TFormLeafInfoCollectionoperator= (const TFormLeafInfoCollection &orig)
 Exception safe assignment operator.
 
Int_t ReadCounterValue (char *where) override
 Return the size of the underlying array for the current entry in the TTree.
 
Double_t ReadValue (char *where, Int_t instance=0) override
 
template<typename T >
ReadValueImpl (char *where, Int_t instance=0)
 Return the value of the underlying data member inside the clones array.
 
Long64_t ReadValueLong64 (char *where, Int_t instance=0) override
 
LongDouble_t ReadValueLongDouble (char *where, Int_t instance=0) override
 
void Swap (TFormLeafInfoCollection &other)
 Exception safe swap.
 
Bool_t Update () override
 We reloading all cached information in case the underlying class information has changed (for example when changing from the 'emulated' class to the real class.
 
- Public Member Functions inherited from TFormLeafInfo
 TFormLeafInfo (const TFormLeafInfo &orig)
 Constructor.
 
 TFormLeafInfo (TClass *classptr=nullptr, Longptr_t offset=0, TStreamerElement *element=nullptr)
 Constructor.
 
 ~TFormLeafInfo () override
 Delete this object and all its content.
 
virtual void AddOffset (Int_t offset, TStreamerElement *element)
 Increase the offset of this element.
 
virtual Int_t GetArrayLength ()
 Return the current length of the array.
 
virtual TClassGetClass () const
 Get the class of the underlying data.
 
Int_t GetMultiplicity ()
 Reminder of the meaning of fMultiplicity:
 
virtual Int_t GetNdata ()
 Get the number of element in the entry.
 
Int_t GetNdata (TLeaf *leaf)
 
char * GetObjectAddress (TLeafElement *leaf, Int_t &instance)
 Returns the location of the object pointed to.
 
virtual Int_t GetPrimaryIndex ()
 Method for multiple variable dimensions.
 
virtual Int_t GetSize (Int_t index)
 For the current entry, and the value 'index' for the main array, return the size of the secondary variable dimension of the 'array'.
 
virtual Int_t GetSumOfSizes ()
 Total all the elements that are available for the current entry for the secondary variable dimension.
 
template<typename T >
GetTypedValue (TLeaf *leaf, Int_t instance=0)
 
template<typename T >
GetValueImpl (TLeaf *leaf, Int_t instance=0)
 Return result of a leafobject method.
 
virtual Int_t GetVarDim ()
 Return the index of the dimension which varies for each elements of an enclosing array (typically a TClonesArray)
 
virtual Int_t GetVirtVarDim ()
 Return the virtual index (for this expression) of the dimension which varies for each elements of an enclosing array (typically a TClonesArray)
 
virtual Bool_t IsInteger () const
 Return true if the underlying data is an integral value.
 
virtual Bool_t IsReference () const
 
virtual Bool_t IsString () const
 Return true if the underlying data is a string.
 
virtual void LoadSizes (TBranch *branch)
 Load the current array sizes.
 
TFormLeafInfooperator= (const TFormLeafInfo &orig)
 Exception safe assignment operator.
 
template<typename T >
ReadTypedValue (char *where, Int_t instance=0)
 
template<typename T >
ReadValueImpl (char *where, Int_t instance=0)
 Read the value at the given memory location.
 
virtual void SetBranch (TBranch *br)
 
virtual void SetPrimaryIndex (Int_t index)
 Set the primary index value.
 
virtual void SetSecondaryIndex (Int_t index)
 Set the primary index value.
 
virtual void SetSize (Int_t index, Int_t val)
 Set the current size of the arrays.
 
void Swap (TFormLeafInfo &other)
 
virtual void UpdateSizes (TArrayI *garr)
 Set the current sizes of the arrays.
 
- 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.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
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 Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method.
 
virtual void Copy (TObject &object) const
 Copy this to obj.
 
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 const char * GetName () const
 Returns 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 const char * GetTitle () const
 Returns title of object.
 
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.
 
virtual ULong_t Hash () const
 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 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)
 
virtual TClassIsA () const
 
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
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout.
 
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 void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself.
 
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.
 
virtual void Streamer (TBuffer &)
 Stream an object of class TObject.
 
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.
 

Private Attributes

TClassfCollClass
 
TString fCollClassName
 
TVirtualCollectionProxyfCollProxy
 
TStreamerElementfLocalElement
 
Bool_t fTop
 

Additional Inherited Members

- 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 ))
}
 
- 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.
 
- Public Attributes inherited from TFormLeafInfo
TClassfClass
 ! This is the class of the data pointed to
 
TString fClassName
 
TFormLeafInfofCounter
 
TStreamerElementfElement
 ! Descriptor of the data pointed to.
 
TString fElementName
 
TFormLeafInfofNext
 follow this to grab the inside information
 
Longptr_t fOffset
 ! Offset of the data pointed inside the class fClass
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- 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 ()
 
- Protected Attributes inherited from TFormLeafInfo
Int_t fMultiplicity
 

#include <TFormLeafInfo.h>

Inheritance diagram for TFormLeafInfoCollection:
[legend]

Constructor & Destructor Documentation

◆ TFormLeafInfoCollection() [1/4]

TFormLeafInfoCollection::TFormLeafInfoCollection ( TClass classptr,
Longptr_t  offset,
TStreamerElement element,
Bool_t  top = kFALSE 
)

Constructor.

Definition at line 1456 of file TFormLeafInfo.cxx.

◆ TFormLeafInfoCollection() [2/4]

TFormLeafInfoCollection::TFormLeafInfoCollection ( TClass motherclassptr,
Longptr_t  offset = 0,
TClass elementclassptr = nullptr,
Bool_t  top = kFALSE 
)

Constructor.

Definition at line 1483 of file TFormLeafInfo.cxx.

◆ TFormLeafInfoCollection() [3/4]

TFormLeafInfoCollection::TFormLeafInfoCollection ( )

Constructor.

Definition at line 1519 of file TFormLeafInfo.cxx.

◆ TFormLeafInfoCollection() [4/4]

TFormLeafInfoCollection::TFormLeafInfoCollection ( const TFormLeafInfoCollection orig)

Constructor.

Definition at line 1531 of file TFormLeafInfo.cxx.

◆ ~TFormLeafInfoCollection()

TFormLeafInfoCollection::~TFormLeafInfoCollection ( )
override

Destructor.

Definition at line 1567 of file TFormLeafInfo.cxx.

Member Function Documentation

◆ DeepCopy()

TFormLeafInfo * TFormLeafInfoCollection::DeepCopy ( ) const
overridevirtual

Copy of the object and its content.

Reimplemented from TFormLeafInfo.

Definition at line 1576 of file TFormLeafInfo.cxx.

◆ GetCounterValue() [1/2]

Int_t TFormLeafInfoCollection::GetCounterValue ( TLeaf leaf)
overridevirtual

Return the current size of the TClonesArray.

Reimplemented from TFormLeafInfo.

Definition at line 1612 of file TFormLeafInfo.cxx.

◆ GetCounterValue() [2/2]

Int_t TFormLeafInfoCollection::GetCounterValue ( TLeaf leaf,
Int_t  instance 
)
virtual

Return the current size of the TClonesArray.

Definition at line 1640 of file TFormLeafInfo.cxx.

◆ GetLocalValuePointer() [1/2]

void * TFormLeafInfoCollection::GetLocalValuePointer ( char *  thisobj,
Int_t  instance = 0 
)
overridevirtual

Return the address of the local value.

Reimplemented from TFormLeafInfo.

Definition at line 1710 of file TFormLeafInfo.cxx.

◆ GetLocalValuePointer() [2/2]

void * TFormLeafInfoCollection::GetLocalValuePointer ( TLeaf leaf,
Int_t  instance = 0 
)
overridevirtual

Return the pointer to the clonesArray.

Reimplemented from TFormLeafInfo.

Definition at line 1692 of file TFormLeafInfo.cxx.

◆ GetValue()

Double_t TFormLeafInfoCollection::GetValue ( TLeaf leaf,
Int_t  instance = 0 
)
inlineoverridevirtual

Reimplemented from TFormLeafInfo.

Definition at line 292 of file TFormLeafInfo.h.

◆ GetValueImpl()

template<typename T >
T TFormLeafInfoCollection::GetValueImpl ( TLeaf leaf,
Int_t  instance = 0 
)

Return the value of the underlying data member inside the clones array.

Definition at line 1720 of file TFormLeafInfo.cxx.

◆ GetValueLong64()

Long64_t TFormLeafInfoCollection::GetValueLong64 ( TLeaf leaf,
Int_t  instance = 0 
)
inlineoverridevirtual

Reimplemented from TFormLeafInfo.

Definition at line 292 of file TFormLeafInfo.h.

◆ GetValueLongDouble()

LongDouble_t TFormLeafInfoCollection::GetValueLongDouble ( TLeaf leaf,
Int_t  instance = 0 
)
inlineoverridevirtual

Reimplemented from TFormLeafInfo.

Definition at line 292 of file TFormLeafInfo.h.

◆ GetValuePointer() [1/2]

void * TFormLeafInfoCollection::GetValuePointer ( char *  thisobj,
Int_t  instance = 0 
)
overridevirtual

Return the pointer to the clonesArray.

Reimplemented from TFormLeafInfo.

Definition at line 1786 of file TFormLeafInfo.cxx.

◆ GetValuePointer() [2/2]

void * TFormLeafInfoCollection::GetValuePointer ( TLeaf leaf,
Int_t  instance = 0 
)
overridevirtual

Return the pointer to the clonesArray.

Reimplemented from TFormLeafInfo.

Definition at line 1753 of file TFormLeafInfo.cxx.

◆ HasCounter()

Bool_t TFormLeafInfoCollection::HasCounter ( ) const
overridevirtual

Return true if the underlying data has a array size counter.

Reimplemented from TFormLeafInfo.

Definition at line 1604 of file TFormLeafInfo.cxx.

◆ operator=()

TFormLeafInfoCollection & TFormLeafInfoCollection::operator= ( const TFormLeafInfoCollection orig)

Exception safe assignment operator.

Definition at line 1557 of file TFormLeafInfo.cxx.

◆ ReadCounterValue()

Int_t TFormLeafInfoCollection::ReadCounterValue ( char *  where)
overridevirtual

Return the size of the underlying array for the current entry in the TTree.

Reimplemented from TFormLeafInfo.

Definition at line 1627 of file TFormLeafInfo.cxx.

◆ ReadValue()

Double_t TFormLeafInfoCollection::ReadValue ( char *  where,
Int_t  instance = 0 
)
inlineoverridevirtual

Reimplemented from TFormLeafInfo.

Definition at line 293 of file TFormLeafInfo.h.

◆ ReadValueImpl()

template<typename T >
template LongDouble_t TFormLeafInfoCollection::ReadValueImpl< LongDouble_t > ( char *  where,
Int_t  instance = 0 
)

Return the value of the underlying data member inside the clones array.

Definition at line 1657 of file TFormLeafInfo.cxx.

◆ ReadValueLong64()

Long64_t TFormLeafInfoCollection::ReadValueLong64 ( char *  where,
Int_t  instance = 0 
)
inlineoverridevirtual

Reimplemented from TFormLeafInfo.

Definition at line 293 of file TFormLeafInfo.h.

◆ ReadValueLongDouble()

LongDouble_t TFormLeafInfoCollection::ReadValueLongDouble ( char *  where,
Int_t  instance = 0 
)
inlineoverridevirtual

Reimplemented from TFormLeafInfo.

Definition at line 293 of file TFormLeafInfo.h.

◆ Swap()

void TFormLeafInfoCollection::Swap ( TFormLeafInfoCollection other)

Exception safe swap.

Definition at line 1544 of file TFormLeafInfo.cxx.

◆ Update()

Bool_t TFormLeafInfoCollection::Update ( )
overridevirtual

We reloading all cached information in case the underlying class information has changed (for example when changing from the 'emulated' class to the real class.

Reimplemented from TFormLeafInfo.

Definition at line 1586 of file TFormLeafInfo.cxx.

Member Data Documentation

◆ fCollClass

TClass* TFormLeafInfoCollection::fCollClass
private

Definition at line 264 of file TFormLeafInfo.h.

◆ fCollClassName

TString TFormLeafInfoCollection::fCollClassName
private

Definition at line 265 of file TFormLeafInfo.h.

◆ fCollProxy

TVirtualCollectionProxy* TFormLeafInfoCollection::fCollProxy
private

Definition at line 266 of file TFormLeafInfo.h.

◆ fLocalElement

TStreamerElement* TFormLeafInfoCollection::fLocalElement
private

Definition at line 267 of file TFormLeafInfo.h.

◆ fTop

Bool_t TFormLeafInfoCollection::fTop
private

Definition at line 262 of file TFormLeafInfo.h.

Libraries for TFormLeafInfoCollection:

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