Logo ROOT   6.11/01
Reference Guide
List of all members | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
TFriendElement Class Reference

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

When a TFriendElement TF is added to the 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  { kFromChain = BIT(11) }
 
- 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)
}
 

Public Member Functions

 TFriendElement ()
 Default constructor for a friend element. More...
 
 TFriendElement (TTree *tree, const char *treename, const char *filename)
 Create a friend element. More...
 
 TFriendElement (TTree *tree, const char *treename, TFile *file)
 Create a friend element. More...
 
 TFriendElement (TTree *tree, TTree *friendtree, const char *alias)
 Create a friend element. More...
 
virtual ~TFriendElement ()
 Destructor. Disconnect from the owning tree if needed. More...
 
virtual TTreeConnect ()
 Connect file and return TTree. More...
 
virtual TTreeDisConnect ()
 DisConnect file and TTree. More...
 
virtual TFileGetFile ()
 Return pointer to TFile containing this friend TTree. More...
 
virtual TTreeGetParentTree () const
 
virtual TTreeGetTree ()
 Return pointer to friend TTree. More...
 
virtual const char * GetTreeName () const
 
virtual void ls (Option_t *option="") const
 List this friend element. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
virtual ~TNamed ()
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
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 two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. 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 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 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 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 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
 
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). 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 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...
 

Protected Member Functions

 TFriendElement (const TFriendElement &)
 Copy constructor. More...
 
TFriendElementoperator= (const TFriendElement &)
 Equal operator. 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 ()
 

Protected Attributes

TFilefFile
 ! pointer to the file containing the friend TTree More...
 
Bool_t fOwnFile
 true if file is managed by this class More...
 
TTreefParentTree
 ! pointer to the parent TTree More...
 
TTreefTree
 ! pointer to the TTree described by this element More...
 
TString fTreeName
 name of the friend TTree More...
 
- 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. More...
 

Additional Inherited Members

- 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...
 

#include <TFriendElement.h>

Inheritance diagram for TFriendElement:
[legend]

Member Enumeration Documentation

anonymous enum
Enumerator
kFromChain 

Definition at line 48 of file TFriendElement.h.

Constructor & Destructor Documentation

TFriendElement::TFriendElement ( const TFriendElement tfe)
protected

Copy constructor.

Definition at line 149 of file TFriendElement.cxx.

TFriendElement::TFriendElement ( )

Default constructor for a friend element.

Definition at line 38 of file TFriendElement.cxx.

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::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::TFriendElement ( TTree tree,
TTree friendtree,
const char *  alias 
)

Create a friend element.

Definition at line 110 of file TFriendElement.cxx.

TFriendElement::~TFriendElement ( )
virtual

Destructor. Disconnect from the owning tree if needed.

Definition at line 177 of file TFriendElement.cxx.

Member Function Documentation

TTree * TFriendElement::Connect ( )
virtual

Connect file and return TTree.

Definition at line 185 of file TFriendElement.cxx.

TTree * TFriendElement::DisConnect ( )
virtual

DisConnect file and TTree.

Definition at line 196 of file TFriendElement.cxx.

TFile * TFriendElement::GetFile ( )
virtual

Return pointer to TFile containing this friend TTree.

Definition at line 207 of file TFriendElement.cxx.

virtual TTree* TFriendElement::GetParentTree ( ) const
inlinevirtual

Definition at line 57 of file TFriendElement.h.

TTree * TFriendElement::GetTree ( )
virtual

Return pointer to friend TTree.

Definition at line 233 of file TFriendElement.cxx.

virtual const char* TFriendElement::GetTreeName ( ) const
inlinevirtual

Definition at line 59 of file TFriendElement.h.

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

List this friend element.

Reimplemented from TNamed.

Definition at line 251 of file TFriendElement.cxx.

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

Equal operator.

Definition at line 162 of file TFriendElement.cxx.

Friends And Related Function Documentation

void TFriendElement__SetTree ( TTree tree,
TList frlist 
)
friend

Set the fTree member for all friend elements.

Definition at line 8939 of file TTree.cxx.

Member Data Documentation

TFile* TFriendElement::fFile
protected

! pointer to the file containing the friend TTree

Definition at line 38 of file TFriendElement.h.

Bool_t TFriendElement::fOwnFile
protected

true if file is managed by this class

Definition at line 40 of file TFriendElement.h.

TTree* TFriendElement::fParentTree
protected

! pointer to the parent TTree

Definition at line 36 of file TFriendElement.h.

TTree* TFriendElement::fTree
protected

! pointer to the TTree described by this element

Definition at line 37 of file TFriendElement.h.

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: