A TFriendElement TF describes a TTree object TF in a file.

When a TFriendElement TF is added to the list of friends of an existing TTree T, any variable from TF can be referenced in a query to T.

To add a TFriendElement to an existing TTree T, do:

T.AddFriend("friendTreename","friendTreeFile");

See TTree::AddFriend for more information.

Definition at line 33 of file TFriendElement.h.

Public Types
enum	EStatusBits { kFromChain = (1ULL << ( 9 )) , kUpdated = (1ULL << ( 10 )) }

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

Public Member Functions
	TFriendElement ()
	Default constructor for a friend element.

	TFriendElement (TTree tree, const char treename, const char *filename)
	Create a friend element.

	TFriendElement (TTree tree, const char treename, TFile *file)
	Create a friend element.

	TFriendElement (TTree tree, TTree friendtree, const char *alias)
	Create a friend element.

	~TFriendElement () override
	Destructor. Disconnect from the owning tree if needed.

virtual TTree *	Connect ()
	Connect file and return TTree.

virtual TTree *	DisConnect ()
	DisConnect file and TTree.

virtual TFile *	GetFile ()
	Return pointer to TFile containing this friend TTree.

virtual TTree *	GetParentTree () const

virtual TTree *	GetTree ()
	Return pointer to friend TTree.

virtual const char *	GetTreeName () const
	Get the actual TTree name of the friend.

TClass *	IsA () const override

Bool_t	IsUpdated () const

void	ls (Option_t *option="") const override
	List this friend element.

void	MarkUpdated ()

void	RecursiveRemove (TObject *obj) override
	Forget deleted elements.

void	Reset ()

void	ResetUpdated ()

void	Streamer (TBuffer &) override
	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 ("").

TObject *	Clone (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.

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List TNamed name and title.

TNamed &	operator= (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 TObject *	DrawClone (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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () 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_t *	GetOption () 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)

TObject &	operator= (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.

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 TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

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 Member Functions
	TFriendElement (const TFriendElement &)=delete

TFriendElement &	operator= (const TFriendElement &)=delete

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
TFile *	fFile
	! pointer to the file containing the friend TTree

Bool_t	fOwnFile
	true if file is managed by this class

TTree *	fParentTree
	! pointer to the parent TTree

TTree *	fTree
	! pointer to the TTree described by this element

TString	fTreeName
	name of the friend TTree

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Friends
void	TFriendElement__SetTree (TTree tree, TList frlist)
	Set the fTree member for all friend elements.

Additional Inherited Members
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

#include <TFriendElement.h>

Inheritance diagram for TFriendElement:

[legend]

Member Enumeration Documentation

◆ EStatusBits

enum TFriendElement::EStatusBits

Enumerator
kFromChain
kUpdated

Definition at line 48 of file TFriendElement.h.

Constructor & Destructor Documentation

◆ TFriendElement() [1/5]

TFriendElement::TFriendElement ( const TFriendElement & )

protecteddelete

◆ TFriendElement() [2/5]

TFriendElement::TFriendElement ( )

Default constructor for a friend element.

Definition at line 38 of file TFriendElement.cxx.

◆ TFriendElement() [3/5]

TFriendElement::TFriendElement	(	TTree *	tree,
		const char *	treename,
		const char *	filename
	)

Create a friend element.

If treename is of the form "a=b", an alias called "a" is created for treename = "b" by default the alias name is the name of the tree.

Definition at line 52 of file TFriendElement.cxx.

◆ TFriendElement() [4/5]

TFriendElement::TFriendElement	(	TTree *	tree,
		const char *	treename,
		TFile *	file
	)

Create a friend element.

If treename is of the form "a=b", an alias called "a" is created for treename = "b" by default the alias name is the name of the tree. The passed TFile is managed by the user (i.e. user must delete the TFile).

Definition at line 80 of file TFriendElement.cxx.

◆ TFriendElement() [5/5]

TFriendElement::TFriendElement	(	TTree *	tree,
		TTree *	friendtree,
		const char *	alias
	)

Create a friend element.

Definition at line 110 of file TFriendElement.cxx.

◆ ~TFriendElement()

TFriendElement::~TFriendElement ( )

override

Destructor. Disconnect from the owning tree if needed.

Definition at line 151 of file TFriendElement.cxx.

Member Function Documentation

◆ Class()

static TClass * TFriendElement::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TFriendElement::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TFriendElement::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 73 of file TFriendElement.h.

◆ Connect()

TTree * TFriendElement::Connect ( )

virtual

Connect file and return TTree.

Definition at line 159 of file TFriendElement.cxx.

◆ DeclFileName()

static const char * TFriendElement::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 73 of file TFriendElement.h.

◆ DisConnect()

TTree * TFriendElement::DisConnect ( )

virtual

DisConnect file and TTree.

Definition at line 170 of file TFriendElement.cxx.

◆ GetFile()

TFile * TFriendElement::GetFile ( )

virtual

Return pointer to TFile containing this friend TTree.

Definition at line 185 of file TFriendElement.cxx.

◆ GetParentTree()

virtual TTree * TFriendElement::GetParentTree ( ) const

inlinevirtual

Definition at line 60 of file TFriendElement.h.

◆ GetTree()

TTree * TFriendElement::GetTree ( )

virtual

Return pointer to friend TTree.

Definition at line 211 of file TFriendElement.cxx.

◆ GetTreeName()

virtual const char * TFriendElement::GetTreeName ( ) const

inlinevirtual

Get the actual TTree name of the friend.

If an alias is present, it can be retrieved with GetName().

Definition at line 64 of file TFriendElement.h.

◆ IsA()

TClass * TFriendElement::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 73 of file TFriendElement.h.

◆ IsUpdated()

Bool_t TFriendElement::IsUpdated ( ) const

inline

Definition at line 67 of file TFriendElement.h.

◆ ls()

void TFriendElement::ls ( Option_t * option = "" ) const

overridevirtual

List this friend element.

Reimplemented from TObject.

Definition at line 239 of file TFriendElement.cxx.

◆ MarkUpdated()

void TFriendElement::MarkUpdated ( )

inline

Definition at line 69 of file TFriendElement.h.

◆ operator=()

TFriendElement & TFriendElement::operator= ( const TFriendElement & )

protecteddelete

◆ RecursiveRemove()

void TFriendElement::RecursiveRemove ( TObject * obj )

overridevirtual

Forget deleted elements.

Reimplemented from TObject.

Definition at line 247 of file TFriendElement.cxx.

◆ Reset()

void TFriendElement::Reset ( )

inline

Definition at line 66 of file TFriendElement.h.

◆ ResetUpdated()

void TFriendElement::ResetUpdated ( )

inline

Definition at line 68 of file TFriendElement.h.

◆ Streamer()

void TFriendElement::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TFriendElement::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 73 of file TFriendElement.h.

Friends And Related Symbol Documentation

◆ TFriendElement__SetTree

void TFriendElement__SetTree	(	TTree *	tree,
		TList *	frlist
	)

friend

Set the fTree member for all friend elements.

Definition at line 9517 of file TTree.cxx.

Member Data Documentation

◆ fFile

TFile* TFriendElement::fFile

protected

! pointer to the file containing the friend TTree

Definition at line 38 of file TFriendElement.h.

◆ fOwnFile

Bool_t TFriendElement::fOwnFile

protected

true if file is managed by this class

Definition at line 40 of file TFriendElement.h.

◆ fParentTree

TTree* TFriendElement::fParentTree

protected

! pointer to the parent TTree

Definition at line 36 of file TFriendElement.h.

◆ fTree

TTree* TFriendElement::fTree

protected

! pointer to the TTree described by this element

Definition at line 37 of file TFriendElement.h.

◆ fTreeName

TString TFriendElement::fTreeName

protected

name of the friend TTree

Definition at line 39 of file TFriendElement.h.

Libraries for TFriendElement:

[legend]

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

tree/tree/inc/TFriendElement.h
tree/tree/src/TFriendElement.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Member Enumeration Documentation

◆ EStatusBits

Constructor & Destructor Documentation

◆ TFriendElement() [1/5]

◆ TFriendElement() [2/5]

◆ TFriendElement() [3/5]

◆ TFriendElement() [4/5]

◆ TFriendElement() [5/5]

◆ ~TFriendElement()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Connect()

◆ DeclFileName()

◆ DisConnect()

◆ GetFile()

◆ GetParentTree()

◆ GetTree()

◆ GetTreeName()

◆ IsA()

◆ IsUpdated()

◆ ls()

◆ MarkUpdated()

◆ operator=()

◆ RecursiveRemove()

◆ Reset()

◆ ResetUpdated()

◆ Streamer()

◆ StreamerNVirtual()

Friends And Related Symbol Documentation

◆ TFriendElement__SetTree

Member Data Documentation

◆ fFile

◆ fOwnFile

◆ fParentTree

◆ fTree

◆ fTreeName