Logo ROOT   6.10/09
Reference Guide
List of all members | Classes | Public Member Functions | Public Attributes | Protected Attributes | List of all members
TFormLeafInfo Class Reference

This class is a small helper class to implement reading a data member on an object stored in a TTree.

TTreeFormula now relies on a variety of TFormLeafInfo classes to handle the reading of the information. Here is the list of theses classes:

The following method are available from the TFormLeafInfo interface:

Definition at line 49 of file TFormLeafInfo.h.

Classes

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

Public Member Functions

 TFormLeafInfo (TClass *classptr=0, Long_t offset=0, TStreamerElement *element=0)
 Constructor. More...
 
 TFormLeafInfo (const TFormLeafInfo &orig)
 Constructor. More...
 
virtual ~TFormLeafInfo ()
 Delete this object and all its content. More...
 
virtual void AddOffset (Int_t offset, TStreamerElement *element)
 Increase the offset of this element. More...
 
virtual TFormLeafInfoDeepCopy () const
 Make a complete copy of this FormLeafInfo and all its content. More...
 
virtual Int_t GetArrayLength ()
 Return the current length of the array. More...
 
virtual TClassGetClass () const
 Get the class of the underlying data. More...
 
virtual Int_t GetCounterValue (TLeaf *leaf)
 Return the size of the underlying array for the current entry in the TTree. More...
 
virtual voidGetLocalValuePointer (TLeaf *leaf, Int_t instance=0)
 returns the address of the value pointed to by the TFormLeafInfo. More...
 
virtual voidGetLocalValuePointer (char *from, Int_t instance=0)
 returns the address of the value pointed to by the TFormLeafInfo. More...
 
Int_t GetMultiplicity ()
 Reminder of the meaning of fMultiplicity: More...
 
Int_t GetNdata (TLeaf *leaf)
 
virtual Int_t GetNdata ()
 Get the number of element in the entry. More...
 
char * GetObjectAddress (TLeafElement *leaf, Int_t &instance)
 Returns the the location of the object pointed to. More...
 
virtual Int_t GetPrimaryIndex ()
 Method for multiple variable dimensions. More...
 
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'. More...
 
virtual Int_t GetSumOfSizes ()
 Total all the elements that are available for the current entry for the secondary variable dimension. More...
 
template<typename T >
GetTypedValue (TLeaf *leaf, Int_t instance=0)
 
virtual voidGetValuePointer (TLeaf *leaf, Int_t instance=0)
 returns the address of the value pointed to by the serie of TFormLeafInfo. More...
 
virtual voidGetValuePointer (char *from, Int_t instance=0)
 returns the address of the value pointed to by the TFormLeafInfo. More...
 
virtual Int_t GetVarDim ()
 Return the index of the dimension which varies for each elements of an enclosing array (typically a TClonesArray) More...
 
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) More...
 
virtual Bool_t HasCounter () const
 Return true if any of underlying data has a array size counter. More...
 
virtual Bool_t IsInteger () const
 Return true if the underlying data is an integral value. More...
 
virtual Bool_t IsReference () const
 
virtual Bool_t IsString () const
 Return true if the underlying data is a string. More...
 
virtual void LoadSizes (TBranch *branch)
 Load the current array sizes. More...
 
TFormLeafInfooperator= (const TFormLeafInfo &orig)
 Exception safe assignment operator. More...
 
virtual Int_t ReadCounterValue (char *where)
 Return the size of the underlying array for the current entry in the TTree. More...
 
template<typename T >
ReadTypedValue (char *where, Int_t instance=0)
 
virtual void SetBranch (TBranch *br)
 
virtual void SetPrimaryIndex (Int_t index)
 Set the primary index value. More...
 
virtual void SetSecondaryIndex (Int_t index)
 Set the primary index value. More...
 
virtual void SetSize (Int_t index, Int_t val)
 Set the current size of the arrays. More...
 
void Swap (TFormLeafInfo &other)
 
virtual Bool_t Update ()
 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. More...
 
virtual void UpdateSizes (TArrayI *garr)
 Set the current sizes of the arrays. 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...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
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 abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. 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 const char * GetName () const
 Returns 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 const char * GetTitle () const
 Returns title of object. More...
 
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...
 
virtual ULong_t Hash () const
 Return hash value for this object. 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...
 
Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
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 void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. 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...
 
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...
 

Public Attributes

 DECLARE_GETVAL
 
 DECLARE_READVAL
 
TClassfClass
 
TString fClassName
 
TFormLeafInfofCounter
 Descriptor of the data pointed to. More...
 
TStreamerElementfElement
 Offset of the data pointed inside the class fClass. More...
 
TString fElementName
 
TFormLeafInfofNext
 
Long_t fOffset
 This is the class of the data pointed to. More...
 

Protected Attributes

Int_t fMultiplicity
 

Additional Inherited Members

- Public Types inherited from TObject
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- 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 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 <TFormLeafInfo.h>

Inheritance diagram for TFormLeafInfo:
[legend]

Constructor & Destructor Documentation

◆ TFormLeafInfo() [1/2]

TFormLeafInfo::TFormLeafInfo ( TClass classptr = 0,
Long_t  offset = 0,
TStreamerElement element = 0 
)

Constructor.

Definition at line 74 of file TFormLeafInfo.cxx.

◆ TFormLeafInfo() [2/2]

TFormLeafInfo::TFormLeafInfo ( const TFormLeafInfo orig)

Constructor.

Definition at line 88 of file TFormLeafInfo.cxx.

◆ ~TFormLeafInfo()

TFormLeafInfo::~TFormLeafInfo ( )
virtual

Delete this object and all its content.

Definition at line 135 of file TFormLeafInfo.cxx.

Member Function Documentation

◆ AddOffset()

void TFormLeafInfo::AddOffset ( Int_t  offset,
TStreamerElement element 
)
virtual

Increase the offset of this element.

This intended to be the offset from the start of the object to which the data member belongs.

Definition at line 145 of file TFormLeafInfo.cxx.

◆ DeepCopy()

TFormLeafInfo * TFormLeafInfo::DeepCopy ( ) const
virtual

◆ GetArrayLength()

Int_t TFormLeafInfo::GetArrayLength ( )
virtual

Return the current length of the array.

Reimplemented in TFormLeafInfoMultiVarDimClones, and TFormLeafInfoMultiVarDimCollection.

Definition at line 158 of file TFormLeafInfo.cxx.

◆ GetClass()

TClass * TFormLeafInfo::GetClass ( ) const
virtual

Get the class of the underlying data.

Reimplemented in TFormLeafInfoMethod, and TFormLeafInfoReference.

Definition at line 173 of file TFormLeafInfo.cxx.

◆ GetCounterValue()

Int_t TFormLeafInfo::GetCounterValue ( TLeaf leaf)
virtual

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

Reimplemented in TFormLeafInfoCollection, TFormLeafInfoClones, TFormLeafInfoCollectionObject, and TFormLeafInfoReference.

Definition at line 575 of file TFormLeafInfo.cxx.

◆ GetLocalValuePointer() [1/2]

void * TFormLeafInfo::GetLocalValuePointer ( TLeaf leaf,
Int_t  instance = 0 
)
virtual

◆ GetLocalValuePointer() [2/2]

void * TFormLeafInfo::GetLocalValuePointer ( char *  thisobj,
Int_t  instance = 0 
)
virtual

◆ GetMultiplicity()

Int_t TFormLeafInfo::GetMultiplicity ( )

Reminder of the meaning of fMultiplicity:

  • -1: Only one or 0 element per entry but contains variable length array!
  • 0: Only one element per entry, no variable length array
  • 1: loop over the elements of a variable length array
  • 2: loop over elements of fixed length array (nData is the same for all entry)

Definition at line 314 of file TFormLeafInfo.cxx.

◆ GetNdata() [1/2]

Int_t TFormLeafInfo::GetNdata ( TLeaf leaf)

Definition at line 320 of file TFormLeafInfo.cxx.

◆ GetNdata() [2/2]

Int_t TFormLeafInfo::GetNdata ( )
virtual

Get the number of element in the entry.

Reimplemented in TFormLeafInfoCast.

Definition at line 332 of file TFormLeafInfo.cxx.

◆ GetObjectAddress()

char * TFormLeafInfo::GetObjectAddress ( TLeafElement leaf,
Int_t instance 
)

Returns the the location of the object pointed to.

Modify instance if the object is part of an array.

Definition at line 184 of file TFormLeafInfo.cxx.

◆ GetPrimaryIndex()

Int_t TFormLeafInfo::GetPrimaryIndex ( )
virtual

Method for multiple variable dimensions.

Reimplemented in TFormLeafInfoMultiVarDim.

Definition at line 418 of file TFormLeafInfo.cxx.

◆ GetSize()

Int_t TFormLeafInfo::GetSize ( Int_t  index)
virtual

For the current entry, and the value 'index' for the main array, return the size of the secondary variable dimension of the 'array'.

Reimplemented in TFormLeafInfoMultiVarDim.

Definition at line 448 of file TFormLeafInfo.cxx.

◆ GetSumOfSizes()

Int_t TFormLeafInfo::GetSumOfSizes ( )
virtual

Total all the elements that are available for the current entry for the secondary variable dimension.

Reimplemented in TFormLeafInfoMultiVarDim.

Definition at line 458 of file TFormLeafInfo.cxx.

◆ GetTypedValue()

template<typename T >
T TFormLeafInfo::GetTypedValue ( TLeaf leaf,
Int_t  instance = 0 
)
inline

Definition at line 135 of file TFormLeafInfo.h.

◆ GetValuePointer() [1/2]

void * TFormLeafInfo::GetValuePointer ( TLeaf leaf,
Int_t  instance = 0 
)
virtual

returns the address of the value pointed to by the serie of TFormLeafInfo.

Reimplemented in TFormLeafInfoCollectionSize, TFormLeafInfoCollection, TFormLeafInfoClones, and TFormLeafInfoCollectionObject.

Definition at line 619 of file TFormLeafInfo.cxx.

◆ GetValuePointer() [2/2]

void * TFormLeafInfo::GetValuePointer ( char *  thisobj,
Int_t  instance = 0 
)
virtual

returns the address of the value pointed to by the TFormLeafInfo.

Reimplemented in TFormLeafInfoCollectionSize, TFormLeafInfoCollection, TFormLeafInfoClones, and TFormLeafInfoCollectionObject.

Definition at line 630 of file TFormLeafInfo.cxx.

◆ GetVarDim()

Int_t TFormLeafInfo::GetVarDim ( )
virtual

Return the index of the dimension which varies for each elements of an enclosing array (typically a TClonesArray)

Reimplemented in TFormLeafInfoMultiVarDim.

Definition at line 428 of file TFormLeafInfo.cxx.

◆ GetVirtVarDim()

Int_t TFormLeafInfo::GetVirtVarDim ( )
virtual

Return the virtual index (for this expression) of the dimension which varies for each elements of an enclosing array (typically a TClonesArray)

Reimplemented in TFormLeafInfoMultiVarDim.

Definition at line 438 of file TFormLeafInfo.cxx.

◆ HasCounter()

Bool_t TFormLeafInfo::HasCounter ( ) const
virtual

Return true if any of underlying data has a array size counter.

Reimplemented in TFormLeafInfoCollection, and TFormLeafInfoReference.

Definition at line 341 of file TFormLeafInfo.cxx.

◆ IsInteger()

Bool_t TFormLeafInfo::IsInteger ( ) const
virtual

Return true if the underlying data is an integral value.

Reimplemented in TFormLeafInfoMethod, and TFormLeafInfoReference.

Definition at line 374 of file TFormLeafInfo.cxx.

◆ IsReference()

virtual Bool_t TFormLeafInfo::IsReference ( ) const
inlinevirtual

Reimplemented in TFormLeafInfoReference.

Definition at line 101 of file TFormLeafInfo.h.

◆ IsString()

Bool_t TFormLeafInfo::IsString ( ) const
virtual

Return true if the underlying data is a string.

Reimplemented in TFormLeafInfoMethod, TFormLeafInfoNumerical, and TFormLeafInfoReference.

Definition at line 351 of file TFormLeafInfo.cxx.

◆ LoadSizes()

void TFormLeafInfo::LoadSizes ( TBranch branch)
virtual

Load the current array sizes.

Reimplemented in TFormLeafInfoMultiVarDimClones, TFormLeafInfoMultiVarDimCollection, and TFormLeafInfoMultiVarDim.

Definition at line 467 of file TFormLeafInfo.cxx.

◆ operator=()

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

Exception safe assignment operator.

Definition at line 98 of file TFormLeafInfo.cxx.

◆ ReadCounterValue()

Int_t TFormLeafInfo::ReadCounterValue ( char *  where)
virtual

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

Reimplemented in TFormLeafInfoCollection, TFormLeafInfoClones, and TFormLeafInfoReference.

Definition at line 588 of file TFormLeafInfo.cxx.

◆ ReadTypedValue()

template<typename T >
T TFormLeafInfo::ReadTypedValue ( char *  where,
Int_t  instance = 0 
)
inline

Definition at line 126 of file TFormLeafInfo.h.

◆ SetBranch()

virtual void TFormLeafInfo::SetBranch ( TBranch br)
inlinevirtual

Reimplemented in TFormLeafInfoReference.

Definition at line 113 of file TFormLeafInfo.h.

◆ SetPrimaryIndex()

void TFormLeafInfo::SetPrimaryIndex ( Int_t  index)
virtual

Set the primary index value.

Reimplemented in TFormLeafInfoMultiVarDim.

Definition at line 475 of file TFormLeafInfo.cxx.

◆ SetSecondaryIndex()

void TFormLeafInfo::SetSecondaryIndex ( Int_t  index)
virtual

Set the primary index value.

Reimplemented in TFormLeafInfoMultiVarDim.

Definition at line 483 of file TFormLeafInfo.cxx.

◆ SetSize()

void TFormLeafInfo::SetSize ( Int_t  index,
Int_t  val 
)
virtual

Set the current size of the arrays.

Reimplemented in TFormLeafInfoMultiVarDim.

Definition at line 491 of file TFormLeafInfo.cxx.

◆ Swap()

void TFormLeafInfo::Swap ( TFormLeafInfo other)

Definition at line 107 of file TFormLeafInfo.cxx.

◆ Update()

Bool_t TFormLeafInfo::Update ( )
virtual

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 in TFormLeafInfoTTree, TFormLeafInfoCast, TFormLeafInfoMultiVarDim, TFormLeafInfoMethod, TFormLeafInfoCollectionSize, TFormLeafInfoCollection, TFormLeafInfoNumerical, and TFormLeafInfoReference.

Definition at line 509 of file TFormLeafInfo.cxx.

◆ UpdateSizes()

void TFormLeafInfo::UpdateSizes ( TArrayI garr)
virtual

Set the current sizes of the arrays.

Reimplemented in TFormLeafInfoMultiVarDim.

Definition at line 499 of file TFormLeafInfo.cxx.

Member Data Documentation

◆ DECLARE_GETVAL

TFormLeafInfo::DECLARE_GETVAL

Definition at line 118 of file TFormLeafInfo.h.

◆ DECLARE_READVAL

TFormLeafInfo::DECLARE_READVAL

Definition at line 119 of file TFormLeafInfo.h.

◆ fClass

TClass* TFormLeafInfo::fClass

Definition at line 62 of file TFormLeafInfo.h.

◆ fClassName

TString TFormLeafInfo::fClassName

Definition at line 70 of file TFormLeafInfo.h.

◆ fCounter

TFormLeafInfo* TFormLeafInfo::fCounter

Descriptor of the data pointed to.

Definition at line 68 of file TFormLeafInfo.h.

◆ fElement

TStreamerElement* TFormLeafInfo::fElement

Offset of the data pointed inside the class fClass.

Definition at line 65 of file TFormLeafInfo.h.

◆ fElementName

TString TFormLeafInfo::fElementName

Definition at line 71 of file TFormLeafInfo.h.

◆ fMultiplicity

Int_t TFormLeafInfo::fMultiplicity
protected

Definition at line 74 of file TFormLeafInfo.h.

◆ fNext

TFormLeafInfo* TFormLeafInfo::fNext

Definition at line 69 of file TFormLeafInfo.h.

◆ fOffset

Long_t TFormLeafInfo::fOffset

This is the class of the data pointed to.

Definition at line 64 of file TFormLeafInfo.h.


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