A tiny browser helper object (and its generator) for adding a virtual (as in "not actually part of the class", not in C++ virtual) "@size()" method to a collection.

For all collections that derive from TCollection, or have a TVirtualCollectionProxy associated with them, a leaf is created that allows access to the number of elements in the collection. For TClonesArrays and types with an associated TVirtualCollectionProxy, this forwards to TTreeFormula's "@branch.size()" functionality. For all other collections, a method call to the appropriate collection's member function is executed when drawing.

These objects are of course only created for elements containing a collection; the generator has no effect on any other elements.

Definition at line 150 of file TBranchBrowsable.h.

Public Member Functions
	~TCollectionPropertyBrowsable ()

void	Browse (TBrowser *b) override
	Browses a TCollectionPropertyBrowsable.

const char *	GetDraw () const
	return the string passed to TTree::Draw

Public Member Functions inherited from TVirtualBranchBrowsable
	~TVirtualBranchBrowsable ()
	Destructor. Delete our leaves.

void	Browse (TBrowser *b) override
	Calls TTree::Draw on the method if return type is not a class; otherwise expands returned object's "folder".

const TBranch *	GetBranch () const
	return the parent branch (might be many levels up)

TClass *	GetClassType () const
	return the type of this browsable object

const char *	GetIconName () const override
	return icon shown when browsing a TVirtualBranchBrowsable

TList *	GetLeaves () const
	Return list of leaves. If not set up yet we'll create them.

const TVirtualBranchBrowsable *	GetParent () const
	return the parent TVirtualBranchBrowsable

void	GetScope (TString &scope) const
	Returns the full name for TTree::Draw to draw *this.

Bool_t	IsFolder () const override
	check whether we have sub-elements

Bool_t	TypeIsPointer () const
	return whether the type of this browsable object is a pointer

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.

virtual void	Clear (Option_t *option="")
	Set name and title to empty strings ("").

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare two TNamed objects.

virtual void	Copy (TObject &named) const
	Copy this to obj.

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.

virtual const char *	GetName () const
	Returns name of object.

virtual const char *	GetTitle () const
	Returns title of object.

virtual ULong_t	Hash () const
	Return hash value for this object.

virtual Bool_t	IsSortable () const

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

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.

virtual void	Print (Option_t *option="") const
	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.

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.

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 for instance with: `gROOT->SetSelectedPad(gPad)`.

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=0)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	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 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).

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)

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.

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	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=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Public Member Functions
static Int_t	GetBrowsables (TList &list, const TBranch branch, const TVirtualBranchBrowsable parent=nullptr)
	If the element to browse (given by either parent of branch) contains a collection (TClonesArray or something for which a TVirtualCollectionProxy exists), we will add some special objects to the browser.

static void	Register ()
	Wrapper for the registration method.

static void	Unregister ()
	Wrapper for the registration method.

Static Public Member Functions inherited from TVirtualBranchBrowsable
static Int_t	FillListOfBrowsables (TList &list, const TBranch branch, const TVirtualBranchBrowsable parent=nullptr)
	Askes all registered generators to fill their browsables into the list.

Static Public Member Functions inherited from TObject
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
	TCollectionPropertyBrowsable (const char name, const char title, const char draw, const TBranch branch, const TVirtualBranchBrowsable *parent=nullptr)
	constructor, which sets the name and title according to the parameters (and thus differently than our base class TVirtualBranchBrowsable)

Protected Member Functions inherited from TVirtualBranchBrowsable
	TVirtualBranchBrowsable (const TBranch b, TClass type, Bool_t typeIsPointer, const TVirtualBranchBrowsable *parent=nullptr)
	Constructor setting all members according to parameters.

void	SetType (TClass *type)
	sets the type of this browsable object

void	SetTypeIsPointer (Bool_t set=kTRUE)
	sets whether the type of this browsable object is a pointer

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

Private Member Functions
	ClassDefOverride (TCollectionPropertyBrowsable, 0)

Private Attributes
TString	fDraw

Additional Inherited Members
Public Types inherited from TVirtualBranchBrowsable
typedef Int_t(*	MethodCreateListOfBrowsables_t) (TList &, const TBranch branch, const TVirtualBranchBrowsable parent)

Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }

enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }

enum	EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) }

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }

Static Protected Member Functions inherited from TVirtualBranchBrowsable
static TClass *	GetCollectionContainedType (const TBranch b, const TVirtualBranchBrowsable parent, TClass *&contained)
	Check whether the branch (or the parent) contains a collection.

static std::list< MethodCreateListOfBrowsables_t > &	GetRegisteredGenerators ()
	returns the list of registered generator methods

static void	RegisterGenerator (MethodCreateListOfBrowsables_t generator)
	Adds a generator to be called when browsing branches.

static void	UnregisterGenerator (MethodCreateListOfBrowsables_t generator)
	Removes a generator from the list of generators to be called when browsing branches.

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

#include <TBranchBrowsable.h>

Inheritance diagram for TCollectionPropertyBrowsable:

[legend]

Constructor & Destructor Documentation

◆ ~TCollectionPropertyBrowsable()

TCollectionPropertyBrowsable::~TCollectionPropertyBrowsable ( )

inline

Definition at line 152 of file TBranchBrowsable.h.

◆ TCollectionPropertyBrowsable()

TCollectionPropertyBrowsable::TCollectionPropertyBrowsable	(	const char *	name,
		const char *	title,
		const char *	draw,
		const TBranch *	branch,
		const TVirtualBranchBrowsable *	parent = `nullptr`
	)

inlineprotected

constructor, which sets the name and title according to the parameters (and thus differently than our base class TVirtualBranchBrowsable)

Definition at line 165 of file TBranchBrowsable.h.

Member Function Documentation

◆ Browse()

void TCollectionPropertyBrowsable::Browse ( TBrowser * b )

overridevirtual

Browses a TCollectionPropertyBrowsable.

The only difference to the generic TVirtualBranchBrowsable::Browse is our fDraw

Reimplemented from TObject.

Definition at line 761 of file TBranchBrowsable.cxx.

◆ ClassDefOverride()

TCollectionPropertyBrowsable::ClassDefOverride	(	TCollectionPropertyBrowsable	,
		0
	)

private

◆ GetBrowsables()

Int_t TCollectionPropertyBrowsable::GetBrowsables	(	TList &	li,
		const TBranch *	branch,
		const TVirtualBranchBrowsable *	parent = `nullptr`
	)

static

If the element to browse (given by either parent of branch) contains a collection (TClonesArray or something for which a TVirtualCollectionProxy exists), we will add some special objects to the browser.

For now there is just one object "@size", returning the size of the collection (as in std::list::size(), or TClonesArray::GetEntries()). The objects we create are simply used to forward strings (like "@size") to TTreeFormula via our Browse method. These strings are stored in fName.

Definition at line 776 of file TBranchBrowsable.cxx.

◆ GetDraw()

const char * TCollectionPropertyBrowsable::GetDraw ( ) const

inline

return the string passed to TTree::Draw

Definition at line 158 of file TBranchBrowsable.h.

◆ Register()

void TCollectionPropertyBrowsable::Register ( )

static

Wrapper for the registration method.

Needed against MSVC, which assigned different addr to the same method, depending on what translation unit you're in...

Definition at line 871 of file TBranchBrowsable.cxx.

◆ Unregister()

void TCollectionPropertyBrowsable::Unregister ( )

static

Wrapper for the registration method.

Needed against MSVC, which assigned different addr to the same method, depending on what translation unit you're in...

Definition at line 881 of file TBranchBrowsable.cxx.

Member Data Documentation

◆ fDraw

TString TCollectionPropertyBrowsable::fDraw

private

Definition at line 174 of file TBranchBrowsable.h.

Libraries for TCollectionPropertyBrowsable:

[legend]

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

tree/tree/inc/TBranchBrowsable.h
tree/tree/src/TBranchBrowsable.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ~TCollectionPropertyBrowsable()

◆ TCollectionPropertyBrowsable()

Member Function Documentation

◆ Browse()

◆ ClassDefOverride()

◆ GetBrowsables()

◆ GetDraw()

◆ Register()

◆ Unregister()

Member Data Documentation

◆ fDraw