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

A TChainElement describes a component of a TChain.

Definition at line 28 of file TChainElement.h.

Public Member Functions

 TChainElement ()
 Default constructor for a chain element.
 
 TChainElement (const char *title, const char *filename)
 Create a chain element.
 
virtual ~TChainElement ()
 Default destructor for a chain element.
 
virtual void CreatePackets ()
 Initialize the packet descriptor string.
 
virtual void * GetBaddress () const
 
virtual const char * GetBaddressClassName () const
 
virtual Bool_t GetBaddressIsPtr () const
 
virtual UInt_t GetBaddressType () const
 
virtual TBranch ** GetBranchPtr () const
 
Bool_t GetCheckedType () const
 
Bool_t GetDecomposedObj () const
 
virtual Long64_t GetEntries () const
 
Int_t GetLoadResult () const
 
virtual char * GetPackets () const
 
virtual Int_t GetPacketSize () const
 
virtual Int_t GetStatus () const
 
virtual Bool_t HasBeenLookedUp ()
 
virtual TClassIsA () const
 
virtual void ls (Option_t *option="") const
 List files in the chain.
 
virtual void SetBaddress (void *add)
 
virtual void SetBaddressClassName (const char *clname)
 
virtual void SetBaddressIsPtr (Bool_t isptr)
 
virtual void SetBaddressType (UInt_t type)
 
virtual void SetBranchPtr (TBranch **ptr)
 
void SetCheckedType (Bool_t m)
 
void SetDecomposedObj (Bool_t m)
 
void SetLoadResult (Int_t result)
 
virtual void SetLookedUp (Bool_t y=kTRUE)
 Set/Reset the looked-up bit.
 
virtual void SetNumberEntries (Long64_t n)
 
virtual void SetPacketSize (Int_t size=100)
 Set number of entries per packet for parallel root.
 
virtual void SetStatus (Int_t status)
 
virtual void Streamer (TBuffer &)
 Stream an object of class TObject.
 
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.
 
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 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.
 
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)
 Operator delete [].
 
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 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

void * fBaddress
 ! branch address when used as a branch
 
TString fBaddressClassName
 ! Name of the class pointed to by fBaddress
 
Bool_t fBaddressIsPtr: 1
 ! True if the address is a pointer to an address
 
UInt_t fBaddressType
 ! Type of the value pointed to by fBaddress
 
TBranch ** fBranchPtr
 ! Address of user branch pointer (to updated upon loading a file)
 
Bool_t fCheckedType: 1
 ! True if the branch type and the address type have been checked.
 
Bool_t fDecomposedObj: 1
 ! True if the address needs the branch in MakeClass/DecomposedObj mode.
 
Long64_t fEntries
 Number of entries in the tree of this chain element.
 
Int_t fLoadResult
 ! Return value of TChain::LoadTree(); 0 means success
 
Int_t fNPackets
 Number of packets.
 
char * fPackets
 ! Packet descriptor string
 
Int_t fPacketSize
 Number of events in one packet for parallel root.
 
Int_t fStatus
 branch status when used as a branch
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Private Types

enum  EStatusBits { kHasBeenLookedUp = (1ULL << ( 15 )) }
 TChainElement status bits. More...
 

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

#include <TChainElement.h>

Inheritance diagram for TChainElement:
[legend]

Member Enumeration Documentation

◆ EStatusBits

TChainElement status bits.

Enumerator
kHasBeenLookedUp 

Definition at line 31 of file TChainElement.h.

Constructor & Destructor Documentation

◆ TChainElement() [1/2]

TChainElement::TChainElement ( )

Default constructor for a chain element.

Definition at line 28 of file TChainElement.cxx.

◆ TChainElement() [2/2]

TChainElement::TChainElement ( const char *  title,
const char *  filename 
)

Create a chain element.

Definition at line 42 of file TChainElement.cxx.

◆ ~TChainElement()

TChainElement::~TChainElement ( )
virtual

Default destructor for a chain element.

Definition at line 57 of file TChainElement.cxx.

Member Function Documentation

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 82 of file TChainElement.h.

◆ CreatePackets()

void TChainElement::CreatePackets ( )
virtual

Initialize the packet descriptor string.

Definition at line 65 of file TChainElement.cxx.

◆ DeclFileName()

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

Definition at line 82 of file TChainElement.h.

◆ GetBaddress()

virtual void * TChainElement::GetBaddress ( ) const
inlinevirtual

Definition at line 55 of file TChainElement.h.

◆ GetBaddressClassName()

virtual const char * TChainElement::GetBaddressClassName ( ) const
inlinevirtual

Definition at line 56 of file TChainElement.h.

◆ GetBaddressIsPtr()

virtual Bool_t TChainElement::GetBaddressIsPtr ( ) const
inlinevirtual

Definition at line 57 of file TChainElement.h.

◆ GetBaddressType()

virtual UInt_t TChainElement::GetBaddressType ( ) const
inlinevirtual

Definition at line 58 of file TChainElement.h.

◆ GetBranchPtr()

virtual TBranch ** TChainElement::GetBranchPtr ( ) const
inlinevirtual

Definition at line 59 of file TChainElement.h.

◆ GetCheckedType()

Bool_t TChainElement::GetCheckedType ( ) const
inline

Definition at line 62 of file TChainElement.h.

◆ GetDecomposedObj()

Bool_t TChainElement::GetDecomposedObj ( ) const
inline

Definition at line 63 of file TChainElement.h.

◆ GetEntries()

virtual Long64_t TChainElement::GetEntries ( ) const
inlinevirtual

Definition at line 60 of file TChainElement.h.

◆ GetLoadResult()

Int_t TChainElement::GetLoadResult ( ) const
inline

Definition at line 61 of file TChainElement.h.

◆ GetPackets()

virtual char * TChainElement::GetPackets ( ) const
inlinevirtual

Definition at line 64 of file TChainElement.h.

◆ GetPacketSize()

virtual Int_t TChainElement::GetPacketSize ( ) const
inlinevirtual

Definition at line 65 of file TChainElement.h.

◆ GetStatus()

virtual Int_t TChainElement::GetStatus ( ) const
inlinevirtual

Definition at line 66 of file TChainElement.h.

◆ HasBeenLookedUp()

virtual Bool_t TChainElement::HasBeenLookedUp ( )
inlinevirtual

Definition at line 67 of file TChainElement.h.

◆ IsA()

virtual TClass * TChainElement::IsA ( ) const
inlinevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 82 of file TChainElement.h.

◆ ls()

void TChainElement::ls ( Option_t option = "") const
virtual

List files in the chain.

Reimplemented from TObject.

Definition at line 78 of file TChainElement.cxx.

◆ SetBaddress()

virtual void TChainElement::SetBaddress ( void *  add)
inlinevirtual

Definition at line 69 of file TChainElement.h.

◆ SetBaddressClassName()

virtual void TChainElement::SetBaddressClassName ( const char *  clname)
inlinevirtual

Definition at line 70 of file TChainElement.h.

◆ SetBaddressIsPtr()

virtual void TChainElement::SetBaddressIsPtr ( Bool_t  isptr)
inlinevirtual

Definition at line 71 of file TChainElement.h.

◆ SetBaddressType()

virtual void TChainElement::SetBaddressType ( UInt_t  type)
inlinevirtual

Definition at line 72 of file TChainElement.h.

◆ SetBranchPtr()

virtual void TChainElement::SetBranchPtr ( TBranch **  ptr)
inlinevirtual

Definition at line 73 of file TChainElement.h.

◆ SetCheckedType()

void TChainElement::SetCheckedType ( Bool_t  m)
inline

Definition at line 74 of file TChainElement.h.

◆ SetDecomposedObj()

void TChainElement::SetDecomposedObj ( Bool_t  m)
inline

Definition at line 75 of file TChainElement.h.

◆ SetLoadResult()

void TChainElement::SetLoadResult ( Int_t  result)
inline

Definition at line 76 of file TChainElement.h.

◆ SetLookedUp()

void TChainElement::SetLookedUp ( Bool_t  y = kTRUE)
virtual

Set/Reset the looked-up bit.

Definition at line 100 of file TChainElement.cxx.

◆ SetNumberEntries()

virtual void TChainElement::SetNumberEntries ( Long64_t  n)
inlinevirtual

Definition at line 78 of file TChainElement.h.

◆ SetPacketSize()

void TChainElement::SetPacketSize ( Int_t  size = 100)
virtual

Set number of entries per packet for parallel root.

Definition at line 92 of file TChainElement.cxx.

◆ SetStatus()

virtual void TChainElement::SetStatus ( Int_t  status)
inlinevirtual

Definition at line 80 of file TChainElement.h.

◆ Streamer()

virtual void TChainElement::Streamer ( TBuffer R__b)
virtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TChainElement::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 82 of file TChainElement.h.

Member Data Documentation

◆ fBaddress

void* TChainElement::fBaddress
protected

! branch address when used as a branch

Definition at line 40 of file TChainElement.h.

◆ fBaddressClassName

TString TChainElement::fBaddressClassName
protected

! Name of the class pointed to by fBaddress

Definition at line 41 of file TChainElement.h.

◆ fBaddressIsPtr

Bool_t TChainElement::fBaddressIsPtr
protected

! True if the address is a pointer to an address

Definition at line 43 of file TChainElement.h.

◆ fBaddressType

UInt_t TChainElement::fBaddressType
protected

! Type of the value pointed to by fBaddress

Definition at line 42 of file TChainElement.h.

◆ fBranchPtr

TBranch** TChainElement::fBranchPtr
protected

! Address of user branch pointer (to updated upon loading a file)

Definition at line 47 of file TChainElement.h.

◆ fCheckedType

Bool_t TChainElement::fCheckedType
protected

! True if the branch type and the address type have been checked.

Definition at line 45 of file TChainElement.h.

◆ fDecomposedObj

Bool_t TChainElement::fDecomposedObj
protected

! True if the address needs the branch in MakeClass/DecomposedObj mode.

Definition at line 44 of file TChainElement.h.

◆ fEntries

Long64_t TChainElement::fEntries
protected

Number of entries in the tree of this chain element.

Definition at line 36 of file TChainElement.h.

◆ fLoadResult

Int_t TChainElement::fLoadResult
protected

! Return value of TChain::LoadTree(); 0 means success

Definition at line 48 of file TChainElement.h.

◆ fNPackets

Int_t TChainElement::fNPackets
protected

Number of packets.

Definition at line 37 of file TChainElement.h.

◆ fPackets

char* TChainElement::fPackets
protected

! Packet descriptor string

Definition at line 46 of file TChainElement.h.

◆ fPacketSize

Int_t TChainElement::fPacketSize
protected

Number of events in one packet for parallel root.

Definition at line 38 of file TChainElement.h.

◆ fStatus

Int_t TChainElement::fStatus
protected

branch status when used as a branch

Definition at line 39 of file TChainElement.h.

Libraries for TChainElement:

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