TRootSniffer Class Reference

Sniffer of ROOT objects, data provider for THttpServer.

Provides methods to scan different structures like folders, directories, files and collections. Can locate objects (or its data member) per name. Can be extended to application-specific classes.

Normally TRootSnifferFull class is used which able to access data from trees, canvases, histograms.

Definition at line 115 of file TRootSniffer.h.

Public Types
enum	{ kSingleKey = (1ULL << (0)) , kOverwrite = (1ULL << (1)) , kWriteDelete = (1ULL << (2)) }
enum	{   kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,   kBitMask = 0x00ffffff }
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
	TRootSniffer (const char *name="sniff", const char *objpath="Objects")
	constructor
virtual	~TRootSniffer ()
	destructor
void	AbstractMethod (const char *method) const
	Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.
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.
Bool_t	CanDrawItem (const char *path)
	Method verifies if object can be drawn.
Bool_t	CanExploreItem (const char *path)
	Method returns true when object has childs or one could try to expand item.
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.
Int_t	CheckRestriction (const char *item_name)
	Checked if restriction is applied to the item full_item_name should have full path to the item.
virtual const char *	ClassName () const
	Returns name of class to which the object belongs.
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.
Bool_t	CreateItem (const char *fullname, const char *title)
	Create item element.
void	CreateOwnTopFolder ()
	Create own TFolder structures independent from gROOT This allows to have many independent TRootSniffer instances At the same time such sniffer lost access to all global lists and folders.
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 void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.
virtual void *	FindInHierarchy (const char *path, TClass **cl=nullptr, TDataMember **member=nullptr, Int_t *chld=nullptr)
	Search element with specified path Returns pointer on element Optionally one could obtain element class, member description and number of childs.
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.
TObject *	FindTObjectInHierarchy (const char *path)
	Search element in hierarchy, derived from TObject.
const char *	GetAutoLoad () const
	return name of configured autoload scripts (or 0)
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.
const char *	GetItemField (const char *fullname, const char *name)
	Return field for specified item.
virtual ULong_t	GetItemHash (const char *itemname)
	Get hash function for specified item used to detect any changes in the specified object.
const char *	GetName () const override
	Returns 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 ULong_t	GetStreamerInfoHash ()
const char *	GetTitle () const override
	Returns title of object.
TFolder *	GetTopFolder (Bool_t force=kFALSE)
	Returns top TFolder instance for the sniffer.
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.
ULong_t	Hash () const override
	Return hash value for this object.
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.
Bool_t	HasRestriction (const char *item_name)
	Made fast check if item with specified name is in restriction list If returns true, requires precise check with CheckRestriction() method.
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)
TClass *	IsA () const override
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).
Bool_t	IsOnHeap () const
Bool_t	IsReadOnly () const
	Returns readonly mode.
Bool_t	IsScanGlobalDir () const
	Returns true when sniffer allowed to scan global directories.
Bool_t	IsSortable () const override
virtual Bool_t	IsStreamerInfoItem (const char *)
Bool_t	IsZombie () const
void	ls (Option_t *option="") const override
	List TNamed name and title.
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 *, size_t)
	Operator delete for sized deallocation.
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 *, size_t)
	Operator delete [] for sized deallocation.
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)
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.
void	Print (Option_t *option="") const override
	Print TNamed name and title.
Bool_t	Produce (const std::string &path, const std::string &file, const std::string &options, std::string &res)
	Method produce different kind of data out of object.
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.
Bool_t	RegisterCommand (const char *cmdname, const char *method, const char *icon)
	Register command which can be executed from web interface.
Bool_t	RegisterObject (const char *subfolder, TObject *obj)
	Register object in subfolder structure.
void	ResetBit (UInt_t f)
void	Restrict (const char *path, const char *options)
	Restrict access to the specified location.
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	ScanHierarchy (const char *topname, const char *path, TRootSnifferStore *store, Bool_t only_fields=kFALSE)
	Method scans normal objects, registered in ROOT.
void	SetAutoLoad (const char *scripts="")
	When specified, _autoload attribute will be always add to top element of h.json/h.hml requests Used to instruct browser automatically load special code.
void	SetBit (UInt_t f)
void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.
THttpCallArg *	SetCurrentCallArg (THttpCallArg *arg)
	set current http arguments, which then used in different process methods For instance, if user authorized with some user name, depending from restrictions some objects will be invisible or user get full access to the element Returns previous argument which was set before
virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.
Bool_t	SetItemField (const char *fullname, const char *name, const char *value)
	Set field for specified item.
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).
void	SetReadOnly (Bool_t on=kTRUE)
	When readonly on (default), sniffer is not allowed to change ROOT structures For instance, it is not allowed to read new objects from files.
void	SetScanGlobalDir (Bool_t on=kTRUE)
	When enabled (default), sniffer scans gROOT for files, canvases, histograms.
virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.
virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.
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)
virtual void	SysError (const char *method, const char *msgfmt,...) const
	Issue system error message.
Bool_t	TestBit (UInt_t f) const
Int_t	TestBits (UInt_t f) const
Bool_t	UnregisterObject (TObject *obj)
	Unregister (remove) object from folders structures.
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 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 Types
enum	{ kOnlyPrepStep = (1ULL << (3)) }

Protected Member Functions
Bool_t	AccessField (TFolder *parent, TObject *item, const char *name, const char *value, TNamed **only_get=nullptr)
	Set or get field for the child.
virtual Bool_t	CallProduceImage (const std::string &kind, const std::string &path, const std::string &options, std::string &res)
	Invokes TRootSniffer::ProduceIamge, converting kind into TImage::EImageFileTypes type.
virtual Bool_t	CanDrawClass (TClass *)
TString	DecodeUrlOptionValue (const char *value, Bool_t remove_quotes=kTRUE)
	Method replaces all kind of special symbols, which could appear in URL options.
virtual void	DoError (int level, const char *location, const char *fmt, va_list va) const
	Interface to ErrorHandler (protected).
virtual Bool_t	ExecuteCmd (const std::string &path, const std::string &options, std::string &res)
	Execute command marked as _kind=='Command'.
TObject *	GetItem (const char *fullname, TFolder *&parent, Bool_t force=kFALSE, Bool_t within_objects=kTRUE)
	Return item from the subfolders structure.
const char *	GetItemField (TFolder *parent, TObject *item, const char *name)
	Return field for specified item.
TFolder *	GetSubFolder (const char *foldername, Bool_t force=kFALSE)
	Creates subfolder where objects can be registered.
virtual Bool_t	HasStreamerInfo () const
Bool_t	IsItemField (TObject *obj) const
	Return true when object is TNamed with kItemField bit set.
void	MakeZombie ()
virtual Bool_t	ProduceBinary (const std::string &path, const std::string &options, std::string &res)
	Produce binary data for specified item.
virtual Bool_t	ProduceExe (const std::string &path, const std::string &options, Int_t reskind, std::string &res)
	Execute command for specified object.
virtual Bool_t	ProduceImage (Int_t kind, const std::string &path, const std::string &options, std::string &res)
	Method to produce image from specified object.
virtual Bool_t	ProduceItem (const std::string &path, const std::string &options, std::string &res, Bool_t asjson=kTRUE)
	Produce JSON/XML for specified item.
virtual Bool_t	ProduceJson (const std::string &path, const std::string &options, std::string &res)
	Produce JSON data for specified item For object conversion TBufferJSON is used.
virtual Bool_t	ProduceMulti (const std::string &path, const std::string &options, std::string &res, Bool_t asjson=kTRUE)
	Process several requests, packing all results into binary or JSON buffer.
virtual Bool_t	ProduceRootFile (const std::string &path, const std::string &options, std::string &res)
	Produce ROOT file for specified item.
virtual Bool_t	ProduceXml (const std::string &path, const std::string &options, std::string &res)
	Produce XML data for specified item.
void	SavePrimitiveNameTitle (std::ostream &out, const char *variable_name)
	Save object name and title into the output stream "out".
void	ScanCollection (TRootSnifferScanRec &rec, TCollection *lst, const char *foldername=nullptr, TCollection *keys_lst=nullptr)
	Scan collection content.
virtual void	ScanKeyProperties (TRootSnifferScanRec &rec, TKey *key, TObject *&obj, TClass *&obj_class)
	Scans TKey properties in special cases load objects from the file.
virtual void	ScanObjectChilds (TRootSnifferScanRec &rec, TObject *obj)
	scans object childs (if any) here one scans collection, branches, trees and so on
void	ScanObjectMembers (TRootSnifferScanRec &rec, TClass *cl, char *ptr)
	scan object data members some members like enum or static members will be excluded
virtual void	ScanObjectProperties (TRootSnifferScanRec &rec, TObject *obj)
	Scans object properties here such fields as _autoload or _icon properties depending on class or object name could be assigned By default properties, coded in the Class title are scanned.
virtual void	ScanRoot (TRootSnifferScanRec &rec)
	scan complete ROOT objects hierarchy For the moment it includes objects in gROOT directory and list of canvases and files Also all registered objects are included.
Int_t	WithCurrentUserName (const char *option)
	return 2 when option match to current user name return 1 when option==all return 0 when option does not match user name

Static Protected Member Functions
static void	SavePrimitiveConstructor (std::ostream &out, TClass *cl, const char *variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
	Save object constructor in the output stream "out".
static void	SavePrimitiveDraw (std::ostream &out, const char *variable_name, Option_t *option=nullptr)
	Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.
static TString	SavePrimitiveVector (std::ostream &out, const char *prefix, Int_t len, Double_t *arr, Int_t flag=0)
	Save array in the output stream "out" as vector.

Protected Attributes
TString	fAutoLoad
	! scripts names, which are add as _autoload parameter to h.json request
TString	fCurrentAllowedMethods
	! list of allowed methods, extracted when analyzed object restrictions
THttpCallArg *	fCurrentArg {nullptr}
	! current http arguments (if any)
Int_t	fCurrentRestrict {0}
	! current restriction for last-found object
TString	fName
TString	fObjectsPath
	! default path for registered objects
Bool_t	fReadOnly {kTRUE}
	! indicate if sniffer allowed to change ROOT structures - like read objects from file
TList	fRestrictions
	! list of restrictions for different locations
Bool_t	fScanGlobalDir {kTRUE}
	! when enabled (default), scan gROOT for histograms, canvases, open files
TString	fTitle
std::unique_ptr< TFolder >	fTopFolder
	! own top TFolder object, used for registering objects

Private Types
enum	{ kItemField = (1ULL << (21)) }

Static Private Member Functions
static void	AddToTObjectTable (TObject *)
	Private helper function which will dispatch to TObjectTable::AddObj.

Private Attributes
UInt_t	fBits
	bit field status word
UInt_t	fUniqueID
	object unique identifier

Static Private Attributes
static Longptr_t	fgDtorOnly = 0
	object for which to call dtor only (i.e. no delete)
static Bool_t	fgObjectStat = kTRUE
	if true keep track of objects in TObjectTable

#include <TRootSniffer.h>

Inheritance diagram for TRootSniffer:

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
kItemField

Definition at line 116 of file TRootSniffer.h.

anonymous enum

anonymous enum

protectedinherited

Enumerator

kOnlyPrepStep

Used to request that the class specific implementation of TObject::Write just prepare the objects to be ready to be written but do not actually write them into the TBuffer. This is just for example by TBufferMerger to request that the TTree inside the file calls TTree::FlushBaskets (outside of the merging lock) and TBufferMerger will later ask for the write (inside the merging lock). To take advantage of this feature the class needs to overload TObject::Write and use this enum value accordingly. (See TTree::Write and TObject::Write) Do not use, this feature will be migrate to the Merge function (See TClass and TTree::Merge)

Definition at line 106 of file TObject.h.

anonymous enum

anonymous enum

inherited

Enumerator
kSingleKey	write collection with single key
kOverwrite	overwrite existing object with same name
kWriteDelete	write object, then delete previous key with same name

Definition at line 99 of file TObject.h.

anonymous enum

anonymous enum

inherited

Enumerator
kIsOnHeap	object is on heap
kNotDeleted	object has not been deleted
kZombie	object ctor failed
kInconsistent	class overload Hash but does call RecursiveRemove in destructor
kBitMask

Definition at line 89 of file TObject.h.

EDeprecatedStatusBits

enum TObject::EDeprecatedStatusBits

inherited

Enumerator
kObjInCanvas	for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

EStatusBits

enum TObject::EStatusBits

inherited

Enumerator
kCanDelete	if object in a list can be deleted
kMustCleanup	if object destructor must call RecursiveRemove()
kIsReferenced	if object is referenced by a TRef or TRefArray
kHasUUID	if object has a TUUID (its fUniqueID=UUIDNumber)
kCannotPick	if object in a pad cannot be picked
kNoContextMenu	if object does not want context menu
kInvalidObject	if object ctor succeeded but object should not be used

Definition at line 70 of file TObject.h.

Constructor & Destructor Documentation

TRootSniffer()

TRootSniffer::TRootSniffer	(	const char *	name = "sniff",
		const char *	objpath = "Objects" )

constructor

Definition at line 413 of file TRootSniffer.cxx.

~TRootSniffer()

TRootSniffer::~TRootSniffer ( )

virtual

destructor

Definition at line 422 of file TRootSniffer.cxx.

Member Function Documentation

AbstractMethod()

void TObject::AbstractMethod ( const char * method ) const

inherited

Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.

In other word, this method acts as a "runtime purely virtual" warning instead of a "compiler purely virtual" error.

Warning

This interface is a legacy function that is no longer recommended to be used by new development code.

Note

The name "AbstractMethod" does not imply that it's an abstract method in the strict C++ sense.

Definition at line 1149 of file TObject.cxx.

AccessField()

Bool_t TRootSniffer::AccessField ( TFolder * parent, TObject * chld, const char * name, const char * value, TNamed ** only_get = nullptr )

protected

Set or get field for the child.

each field coded as TNamed object, placed after chld in the parent hierarchy

Definition at line 1726 of file TRootSniffer.cxx.

AddToTObjectTable()

void TObject::AddToTObjectTable ( TObject * op )

staticprivateinherited

Private helper function which will dispatch to TObjectTable::AddObj.

Included here to avoid circular dependency between header files.

Definition at line 195 of file TObject.cxx.

AppendPad()

void TObject::AppendPad ( Option_t * option = "" )

virtualinherited

Append graphics object to current pad.

In case no current pad is set yet, create a default canvas with the name "c1".

Definition at line 204 of file TObject.cxx.

Browse()

void TObject::Browse ( TBrowser * b )

virtualinherited

Browse object. May be overridden for another default action.

Reimplemented in RooPlot, ROOT::Experimental::XRooFit::xRooNode, ROOT::Internal::THnBaseBrowsable, TApplicationRemote, TASImage, TAxis3D, TBaseClass, TBranch, TBranchClones, TBranchElement, TBranchObject, TBranchSTL, TBrowserObject, TCanvas, TChain, TClass, TCollection, TCollectionPropertyBrowsable, TDatabasePDG, TDirectory, TDirectoryFile, TEfficiency, TF1, TFolder, TGenerator, TGeoManager, TGeometry, TGeoNode, TGeoOverlap, TGeoTrack, TGeoVolume, TGraph2D, TGraph, TH1, THbookBranch, THbookFile, THbookKey, THnBase, THStack, TKey, TKeyMapFile, TLeaf, TMacro, TMapFile, TMultiDimFit, TMultiGraph, TNode, TNtuple, TNtupleD, TPad, TPair, TParticleClassPDG, TPrincipal, TRecorder, TRemoteObject, TROOT, TRootIconList, TSPlot, TStyle, TSystemDirectory, TSystemFile, TTask, TTree, TTreePerfStats, and TVirtualBranchBrowsable.

Definition at line 218 of file TObject.cxx.

CallProduceImage()

Bool_t TRootSniffer::CallProduceImage ( const std::string & kind, const std::string & path, const std::string & options, std::string & res )

protectedvirtual

Invokes TRootSniffer::ProduceIamge, converting kind into TImage::EImageFileTypes type.

Reimplemented in TRootSnifferFull.

Definition at line 1495 of file TRootSniffer.cxx.

CanDrawClass()

virtual Bool_t TRootSniffer::CanDrawClass ( TClass * )

inlineprotectedvirtual

Reimplemented in TRootSnifferFull.

Definition at line 160 of file TRootSniffer.h.

CanDrawItem()

Bool_t TRootSniffer::CanDrawItem

(

const char *

path

)

Method verifies if object can be drawn.

Definition at line 1107 of file TRootSniffer.cxx.

CanExploreItem()

Bool_t TRootSniffer::CanExploreItem

(

const char *

path

)

Method returns true when object has childs or one could try to expand item.

Definition at line 1118 of file TRootSniffer.cxx.

CheckedHash()

ULong_t TObject::CheckedHash ( )

inlineinherited

Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

The intent is for this routine to be called instead of directly calling the function Hash during "insert" operations. See TObject::HasInconsistenTObjectHash();

(*) The setup is consistent when all classes in the class hierarchy that overload TObject::Hash do call ROOT::CallRecursiveRemoveIfNeeded in their destructor. i.e. it is safe to call the Hash virtual function during the RecursiveRemove operation.

Definition at line 332 of file TObject.h.

CheckRestriction()

Int_t TRootSniffer::CheckRestriction

(

const char *

full_item_name

)

Checked if restriction is applied to the item full_item_name should have full path to the item.

Returns:

• -1 - object invisible, cannot be accessed or listed
• 0 - no explicit restrictions, use default
• 1 - read-only access
• 2 - full access

Definition at line 544 of file TRootSniffer.cxx.

Class()

TClass * TRootSniffer::Class ( )

static

Returns

TClass describing this class

Class_Name()

const char * TRootSniffer::Class_Name ( )

static

Returns

Name of this class

Class_Version()

constexpr Version_t TRootSniffer::Class_Version ( )

inlinestaticconstexpr

Returns

Version of this class

Definition at line 249 of file TRootSniffer.h.

ClassName()

const char * TObject::ClassName ( ) const

virtualinherited

Returns name of class to which the object belongs.

Definition at line 227 of file TObject.cxx.

Clear()

void TNamed::Clear ( Option_t * option = "" )

overridevirtualinherited

Set name and title to empty strings ("").

Reimplemented from TObject.

Reimplemented in TPrincipal, TProcessID, TStreamerInfo, TTask, TVirtualFitter, and TVirtualStreamerInfo.

Definition at line 63 of file TNamed.cxx.

Clone()

TObject * TNamed::Clone ( const char * newname = "" ) const

overridevirtualinherited

Make a clone of an object using the Streamer facility.

If newname is specified, this will be the name of the new object.

Reimplemented from TObject.

Reimplemented in TStreamerInfo, and TTreeIndex.

Definition at line 73 of file TNamed.cxx.

Compare()

Int_t TNamed::Compare ( const TObject * obj ) const

overridevirtualinherited

Compare two TNamed objects.

Returns 0 when equal, -1 when this is smaller and +1 when bigger (like strcmp).

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 84 of file TNamed.cxx.

Copy()

void TNamed::Copy ( TObject & named ) const

overridevirtualinherited

Copy this to obj.

Reimplemented from TObject.

Reimplemented in TPieSlice, TProfile2D, TProfile3D, TProfile, TStyle, TSystemDirectory, TSystemFile, TText, and TXTRU.

Definition at line 93 of file TNamed.cxx.

CreateItem()

Bool_t TRootSniffer::CreateItem	(	const char *	fullname,
		const char *	title )

Create item element.

Definition at line 1699 of file TRootSniffer.cxx.

CreateOwnTopFolder()

void TRootSniffer::CreateOwnTopFolder

(

)

Create own TFolder structures independent from gROOT This allows to have many independent TRootSniffer instances At the same time such sniffer lost access to all global lists and folders.

Definition at line 911 of file TRootSniffer.cxx.

DeclFileName()

const char * TRootSniffer::DeclFileName ( )

inlinestatic

Returns

Name of the file containing the class declaration

Definition at line 249 of file TRootSniffer.h.

DecodeUrlOptionValue()

TString TRootSniffer::DecodeUrlOptionValue ( const char * value, Bool_t remove_quotes = kTRUE )

protected

Method replaces all kind of special symbols, which could appear in URL options.

Definition at line 1288 of file TRootSniffer.cxx.

Delete()

void TObject::Delete ( Option_t * option = "" )

virtualinherited

Delete this object.

Typically called as a command via the interpreter. Normally use "delete" operator when object has been allocated on the heap.

Reimplemented in RooLinkedList, TAxis, TBtree, TCanvas, TClonesArray, TCollection, TDirectory, TDirectoryFile, TExMap, TFile, TGFrame, TGItemContext, TGTextEdit, THashList, THashTable, TKey, TKeySQL, TKeyXML, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TMap, TMVA::Results, TObjArray, TObjectTable, TOrdCollection, TProtoClass, TQCommand, TRefArray, TSystemDirectory, TSystemFile, TThread, TTree, TTreeViewer, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 268 of file TObject.cxx.

DistancetoPrimitive()

Int_t TObject::DistancetoPrimitive ( Int_t px, Int_t py )

virtualinherited

Computes distance from point (px,py) to the object.

This member function must be implemented for each graphics primitive. This default function returns a big number (999999).

Reimplemented in TASImage, TAxis3D, TAxis, TBox, TBRIK, TColorWheel, TCrown, TCurlyArc, TCurlyLine, TDiamond, TEfficiency, TEllipse, TF1, TF2, TF3, TFileDrawMap, TGenerator, TGeoBBox, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoEltu, TGeoHalfSpace, TGeoHype, TGeoNode, TGeoOverlap, TGeoParaboloid, TGeoPcon, TGeoPgon, TGeoScaledShape, TGeoShape, TGeoShapeAssembly, TGeoSphere, TGeoTessellated, TGeoTorus, TGeoTrack, TGeoTube, TGeoTubeSeg, TGeoVGShape, TGeoVolume, TGeoXtru, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLScenePad, TGLTH3Composition, TGLViewer, TGraph2D, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TH1, THistPainter, THStack, TLine, TMarker3DBox, TMarker, TMultiGraph, TNode, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPCON, TPie, TPieSlice, TPoints3DABC, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TScatter2D, TScatter, TSPHE, TSpider, TSpline, TStyle, TText, TTreePerfStats, TTUBE, TTUBS, TVirtualHistPainter, and TXTRU.

Definition at line 284 of file TObject.cxx.

DoError()

void TObject::DoError ( int level, const char * location, const char * fmt, va_list va ) const

protectedvirtualinherited

Interface to ErrorHandler (protected).

Reimplemented in TThread, and TTreeViewer.

Definition at line 1059 of file TObject.cxx.

Draw()

void TObject::Draw ( Option_t * option = "" )

virtualinherited

Default Draw method for all objects.

Reimplemented in RooAbsData, RooPlot, RooStats::HypoTestInverterPlot, RooStats::SamplingDistPlot, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoPoint, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoSpace, ROOT::Experimental::XRooFit::xRooNode, ROOT::RGeoPainter, TArrow, TASImage, TBox, TBrowser, TButton, TCanvas, TChain, TClass, TClassTree, TCollection, TColorWheel, TDiamond, TDirectory, TEfficiency, TEllipse, TEveGeoNode, TEveGeoTopNode, TF1, TF2, TF3, TFile, TFITSHDU, TFrame, TGenerator, TGeoBatemanSol, TGeometry, TGeoNode, TGeoOverlap, TGeoPainter, TGeoParallelWorld, TGeoPhysicalNode, TGeoPolygon, TGeoShape, TGeoTrack, TGeoVGShape, TGeoVolume, TGItemContext, TGListTree, TGPicture, TGraph2D, TGraph, TGraphPolar, TGraphPolargram, TGraphStruct, TGraphTime, TH1, THelix, THStack, TLegend, TMarker, TMatrixTBase< Element >, TMatrixTBase< Double_t >, TMatrixTBase< Float_t >, TMultiDimFit, TMultiGraph, TMultiLayerPerceptron, TNode, TNodeDiv, TPad, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TPave, TPaveLabel, TPavesText, TPaveText, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TRatioPlot, TSpider, TSpline, TStructViewer, TStructViewerGUI, TTree, TTreePerfStats, TVectorT< Element >, TVectorT< Double_t >, TVectorT< Float_t >, TVirtualPad, and TWbox.

Definition at line 293 of file TObject.cxx.

DrawClass()

void TObject::DrawClass ( ) const

virtualinherited

Draw class inheritance tree of the class to which this object belongs.

If a class B inherits from a class A, description of B is drawn on the right side of description of A. Member functions overridden by B are shown in class A with a blue line crossing-out the corresponding member function. The following picture is the class inheritance tree of class TPaveLabel:

Reimplemented in TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 308 of file TObject.cxx.

DrawClone()

TObject * TObject::DrawClone ( Option_t * option = "" ) const

virtualinherited

Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).

If pad was not selected - gPad will be used.

Note

For histograms, use the more specialised TH1::DrawCopy().

Reimplemented in TAxis, TCanvas, TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 319 of file TObject.cxx.

Dump()

void TObject::Dump ( ) const

virtualinherited

Dump contents of object on stdout.

Using the information in the object dictionary (class TClass) each data member is interpreted. If a data member is a pointer, the pointer value is printed

The following output is the Dump of a TArrow object:

fAngle                   0           Arrow opening angle (degrees)
fArrowSize               0.2         Arrow Size
fOption.*fData
fX1                      0.1         X of 1st point
fY1                      0.15        Y of 1st point
fX2                      0.67        X of 2nd point
fY2                      0.83        Y of 2nd point
fUniqueID                0           object unique identifier
fBits                    50331648    bit field status word
fLineColor               1           line color
fLineStyle               1           line style
fLineWidth               1           line width
fFillColor               19          fill area color
fFillStyle               1001        fill area style

Reimplemented in TClass, TCollection, TGFrame, TGPack, and TSystemFile.

Definition at line 367 of file TObject.cxx.

Error()

void TObject::Error ( const char * location, const char * fmt, ... ) const

virtualinherited

Issue error message.

Use "location" to specify the method where the error occurred. Accepts standard printf formatting arguments.

Reimplemented in TFitResult.

Definition at line 1098 of file TObject.cxx.

Execute() [1/2]

void TObject::Execute ( const char * method, const char * params, Int_t * error = nullptr )

virtualinherited

Execute method on this object with the given parameter string, e.g.

"3.14,1,\"text\"".

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 378 of file TObject.cxx.

Execute() [2/2]

void TObject::Execute ( TMethod * method, TObjArray * params, Int_t * error = nullptr )

virtualinherited

Execute method on this object with parameters stored in the TObjArray.

The TObjArray should contain an argv vector like:

argv[0] ... argv[n] = the list of TObjString parameters

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 398 of file TObject.cxx.

ExecuteCmd()

Bool_t TRootSniffer::ExecuteCmd ( const std::string & path, const std::string & options, std::string & res )

protectedvirtual

Execute command marked as _kind=='Command'.

Definition at line 1162 of file TRootSniffer.cxx.

ExecuteEvent()

void TObject::ExecuteEvent ( Int_t event, Int_t px, Int_t py )

virtualinherited

Execute action corresponding to an event at (px,py).

This method must be overridden if an object can react to graphics events.

Reimplemented in TASImage, TASPaletteEditor::LimitLine, TAxis3D, TAxis, TBox, TButton, TCanvas, TCrown, TCurlyArc, TCurlyLine, TDiamond, TEfficiency, TEllipse, TF1, TF2, TF3, TFrame, TGenerator, TGeoManager, TGeoNode, TGeoOverlap, TGeoShape, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLEventHandler, TGLHistPainter, TGLParametricEquation, TGLScenePad, TGLTH3Composition, TGLViewer, TGraph2D, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TGroupButton, TH1, THistPainter, TLine, TLink, TMarker3DBox, TMarker, TNode, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TScatter2D, TScatter, TSliderBox, TSpider, TSpline, TText, TTreePerfStats, TView3D, TView, TVirtualHistPainter, and TWbox.

Definition at line 415 of file TObject.cxx.

Fatal()

void TObject::Fatal ( const char * location, const char * fmt, ... ) const

virtualinherited

Issue fatal error message.

Use "location" to specify the method where the fatal error occurred. Accepts standard printf formatting arguments.

Definition at line 1126 of file TObject.cxx.

FillBuffer()

void TNamed::FillBuffer ( char *& buffer )

virtualinherited

Encode TNamed into output buffer.

Reimplemented in TDirectoryFile, TFile, TKey, TKeySQL, TKeyXML, TSQLFile, and TXMLFile.

Definition at line 103 of file TNamed.cxx.

FindInHierarchy()

void * TRootSniffer::FindInHierarchy ( const char * path, TClass ** cl = nullptr, TDataMember ** member = nullptr, Int_t * chld = nullptr )

virtual

Search element with specified path Returns pointer on element Optionally one could obtain element class, member description and number of childs.

When chld!=nullptr, not only element is searched, but also number of childs are counted. When member!=0, any object will be scanned for its data members (disregard of extra options)

Reimplemented in TRootSnifferFull.

Definition at line 1039 of file TRootSniffer.cxx.

FindObject() [1/2]

TObject * TObject::FindObject ( const char * name ) const

virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object by name inside this object.

Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 425 of file TObject.cxx.

FindObject() [2/2]

TObject * TObject::FindObject ( const TObject * obj ) const

virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object inside this object.

Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 435 of file TObject.cxx.

FindTObjectInHierarchy()

TObject * TRootSniffer::FindTObjectInHierarchy

(

const char *

path

)

Search element in hierarchy, derived from TObject.

Definition at line 1084 of file TRootSniffer.cxx.

GetAutoLoad()

const char * TRootSniffer::GetAutoLoad

(

)

const

return name of configured autoload scripts (or 0)

Definition at line 488 of file TRootSniffer.cxx.

GetDrawOption()

Option_t * TObject::GetDrawOption ( ) const

virtualinherited

Get option used by the graphics system to draw this object.

Note that before calling object.GetDrawOption(), you must have called object.Draw(..) before in the current pad.

Reimplemented in TBrowser, TFitEditor, TGedFrame, TGFileBrowser, TRootBrowser, and TRootBrowserLite.

Definition at line 445 of file TObject.cxx.

GetDtorOnly()

Longptr_t TObject::GetDtorOnly ( )

staticinherited

Return destructor only flag.

Definition at line 1196 of file TObject.cxx.

GetIconName()

const char * TObject::GetIconName ( ) const

virtualinherited

Returns mime type name of object.

Used by the TBrowser (via TGMimeTypes class). Override for class of which you would like to have different icons for objects of the same class.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TASImage, TBranch, TBranchElement, TGeoVolume, TGMainFrame, TKey, TMethodBrowsable, TSystemFile, and TVirtualBranchBrowsable.

Definition at line 472 of file TObject.cxx.

GetItem()

TObject * TRootSniffer::GetItem ( const char * fullname, TFolder *& parent, Bool_t force = kFALSE, Bool_t within_objects = kTRUE )

protected

Return item from the subfolders structure.

Definition at line 1578 of file TRootSniffer.cxx.

GetItemField() [1/2]

const char * TRootSniffer::GetItemField	(	const char *	fullname,
		const char *	name )

Return field for specified item.

Definition at line 1844 of file TRootSniffer.cxx.

GetItemField() [2/2]

const char * TRootSniffer::GetItemField ( TFolder * parent, TObject * item, const char * name )

protected

Return field for specified item.

Definition at line 1828 of file TRootSniffer.cxx.

GetItemHash()

ULong_t TRootSniffer::GetItemHash ( const char * itemname )

virtual

Get hash function for specified item used to detect any changes in the specified object.

Reimplemented in TRootSnifferFull.

Definition at line 1097 of file TRootSniffer.cxx.

GetName()

const char * TNamed::GetName ( ) const

inlineoverridevirtualinherited

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 49 of file TNamed.h.

GetObjectInfo()

char * TObject::GetObjectInfo ( Int_t px, Int_t py ) const

virtualinherited

Returns string containing info about the object at position (px,py).

This method is typically overridden by classes of which the objects can report peculiarities for different positions. Returned string will be re-used (lock in MT environment).

Reimplemented in TASImage, TAxis3D, TColorWheel, TF1, TF2, TFileDrawMap, TGeoNode, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph, TH1, THistPainter, TNode, TPaletteAxis, TParallelCoordVar, and TVirtualHistPainter.

Definition at line 491 of file TObject.cxx.

GetObjectStat()

Bool_t TObject::GetObjectStat ( )

staticinherited

Get status of object stat flag.

Definition at line 1181 of file TObject.cxx.

GetOption()

virtual Option_t * TObject::GetOption ( ) const

inlinevirtualinherited

Reimplemented in TArrow, TAxis3D, TFile, TGaxis, TGeoVolume, TH1, THelix, TLegendEntry, TMapFile, TNode, TPave, TPoints3DABC, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPSocket, TSelector, TSocket, and TUDPSocket.

Definition at line 147 of file TObject.h.

GetStreamerInfoHash()

virtual ULong_t TRootSniffer::GetStreamerInfoHash ( )

inlinevirtual

Reimplemented in TRootSnifferFull.

Definition at line 243 of file TRootSniffer.h.

GetSubFolder()

TFolder * TRootSniffer::GetSubFolder ( const char * foldername, Bool_t force = kFALSE )

protected

Creates subfolder where objects can be registered.

Definition at line 1629 of file TRootSniffer.cxx.

GetTitle()

const char * TNamed::GetTitle ( ) const

inlineoverridevirtualinherited

Returns title of object.

This default method returns the class title (i.e. description). Classes that give objects a title should override this method.

Reimplemented from TObject.

Definition at line 50 of file TNamed.h.

GetTopFolder()

TFolder * TRootSniffer::GetTopFolder

(

Bool_t

force = kFALSE

)

Returns top TFolder instance for the sniffer.

Definition at line 930 of file TRootSniffer.cxx.

GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const

virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

HandleTimer()

Bool_t TObject::HandleTimer ( TTimer * timer )

virtualinherited

Execute action in response of a timer timing out.

This method must be overridden if an object has to react to timers.

Reimplemented in TGCommandPlugin, TGDNDManager, TGFileContainer, TGHtml, TGLEventHandler, TGPopupMenu, TGraphTime, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGuiBldDragManager, TGWindow, and TTreeViewer.

Definition at line 516 of file TObject.cxx.

Hash()

ULong_t TNamed::Hash ( ) const

inlineoverridevirtualinherited

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

ROOT::CallRecursiveRemoveIfNeeded(*this)

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides
TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.

Reimplemented from TObject.

Definition at line 51 of file TNamed.h.

HasInconsistentHash()

Bool_t TObject::HasInconsistentHash ( ) const

inlineinherited

Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

missing call to RecursiveRemove in destructor).

Note: Since the consistency is only tested for during inserts, this routine will return true for object that have never been inserted whether or not they have a consistent setup. This has no negative side-effect as searching for the object with the right or wrong Hash will always yield a not-found answer (Since anyway no hash can be guaranteed unique, there is always a check)

Definition at line 366 of file TObject.h.

HasRestriction()

Bool_t TRootSniffer::HasRestriction

(

const char *

item_name

)

Made fast check if item with specified name is in restriction list If returns true, requires precise check with CheckRestriction() method.

Definition at line 497 of file TRootSniffer.cxx.

HasStreamerInfo()

virtual Bool_t TRootSniffer::HasStreamerInfo ( ) const

inlineprotectedvirtual

Reimplemented in TRootSnifferFull.

Definition at line 162 of file TRootSniffer.h.

Info()

void TObject::Info ( const char * location, const char * fmt, ... ) const

virtualinherited

Issue info message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1072 of file TObject.cxx.

InheritsFrom() [1/2]

Bool_t TObject::InheritsFrom ( const char * classname ) const

virtualinherited

Returns kTRUE if object inherits from class "classname".

Reimplemented in TClass.

Definition at line 549 of file TObject.cxx.

InheritsFrom() [2/2]

Bool_t TObject::InheritsFrom ( const TClass * cl ) const

virtualinherited

Returns kTRUE if object inherits from TClass cl.

Reimplemented in TClass.

Definition at line 557 of file TObject.cxx.

Inspect()

void TObject::Inspect ( ) const

virtualinherited

Dump contents of this object in a graphics canvas.

Same action as Dump but in a graphical form. In addition pointers to other objects can be followed.

The following picture is the Inspect of a histogram object:

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TGFrame, TInspectorObject, and TSystemFile.

Definition at line 570 of file TObject.cxx.

InvertBit()

void TObject::InvertBit ( UInt_t f )

inlineinherited

Definition at line 206 of file TObject.h.

IsA()

TClass * TRootSniffer::IsA ( ) const

inlineoverridevirtual

Returns

TClass describing current object

Reimplemented from TNamed.

Definition at line 249 of file TRootSniffer.h.

IsDestructed()

Bool_t TObject::IsDestructed ( ) const

inlineinherited

IsDestructed.

Note

This function must be non-virtual as it can be used on destructed (but not yet modified) memory. This is used for example in TClonesArray to record the element that have been destructed but not deleted and thus are ready for re-use (by operator new with placement).

Returns

true if this object's destructor has been run.

Definition at line 186 of file TObject.h.

IsEqual()

Bool_t TObject::IsEqual ( const TObject * obj ) const

virtualinherited

Default equal comparison (objects are equal if they have the same address in memory).

More complicated classes might want to override this function.

Reimplemented in TGObject, TObjString, TPair, and TQCommand.

Definition at line 589 of file TObject.cxx.

IsFolder()

Bool_t TObject::IsFolder ( ) const

virtualinherited

Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, ROOT::Internal::THnBaseBrowsable, TApplicationRemote, TAxis3D, TBaseClass, TBranch, TBranchClones, TBranchElement, TBranchObject, TBranchSTL, TBrowserObject, TCanvas, TClass, TCollection, TDatabasePDG, TDirectory, TFolder, TGeoManager, TGeometry, TGeoNode, TGeoNodeMatrix, TGeoOverlap, TGeoTrack, TGeoVolume, THbookFile, THbookKey, THnBase, TKey, TMapFile, TMultiDimFit, TNode, TPad, TPair, TParticleClassPDG, TPrincipal, TRemoteObject, TROOT, TRootIconList, TSPlot, TSystemDirectory, TTask, TTree, and TVirtualBranchBrowsable.

Definition at line 579 of file TObject.cxx.

IsItemField()

Bool_t TRootSniffer::IsItemField ( TObject * obj ) const

protected

Return true when object is TNamed with kItemField bit set.

such objects used to keep field values for item

Definition at line 1716 of file TRootSniffer.cxx.

IsOnHeap()

Bool_t TObject::IsOnHeap ( ) const

inlineinherited

Definition at line 160 of file TObject.h.

IsReadOnly()

Bool_t TRootSniffer::IsReadOnly ( ) const

inline

Returns readonly mode.

Definition at line 193 of file TRootSniffer.h.

IsScanGlobalDir()

Bool_t TRootSniffer::IsScanGlobalDir ( ) const

inline

Returns true when sniffer allowed to scan global directories.

Definition at line 213 of file TRootSniffer.h.

IsSortable()

Bool_t TNamed::IsSortable ( ) const

inlineoverridevirtualinherited

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 52 of file TNamed.h.

IsStreamerInfoItem()

virtual Bool_t TRootSniffer::IsStreamerInfoItem ( const char * )

inlinevirtual

Reimplemented in TRootSnifferFull.

Definition at line 241 of file TRootSniffer.h.

IsZombie()

Bool_t TObject::IsZombie ( ) const

inlineinherited

Definition at line 161 of file TObject.h.

ls()

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

overridevirtualinherited

List TNamed name and title.

Reimplemented from TObject.

Reimplemented in ROOT::Experimental::XRooFit::xRooBrowser, TNode, TROOT, TStreamerBase, TStreamerElement, TStreamerInfo, TStreamerSTL, TTask, TText, and TVirtualStreamerInfo.

Definition at line 112 of file TNamed.cxx.

MakeZombie()

void TObject::MakeZombie ( )

inlineprotectedinherited

Definition at line 55 of file TObject.h.

MayNotUse()

void TObject::MayNotUse ( const char * method ) const

inherited

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

Definition at line 1160 of file TObject.cxx.

Notify()

Bool_t TObject::Notify ( )

virtualinherited

This method must be overridden to handle object notification (the base implementation is no-op).

Different objects in ROOT use the Notify method for different purposes, in coordination with other objects that call this method at the appropriate time.

For example, TLeaf uses it to load class information; TBranchRef to load contents of referenced branches TBranchRef; most notably, based on Notify, TChain implements a callback mechanism to inform interested parties when it switches to a new sub-tree.

Reimplemented in h1analysis, h1analysisTreeReader, TARInterruptHandler, TASInputHandler, TASInterruptHandler, TASLogHandler, TASSigPipeHandler, TBlinkTimer, TBranchElement, TBranchRef, TBreakLineCom, TBrowserTimer, TCollection, TDelCharCom, TDelTextCom, TFileHandler, TGContainerKeyboardTimer, TGContainerScrollTimer, TGInputHandler, TGLRedrawTimer, TGTextEditHist, TGuiBldDragManagerRepeatTimer, TIdleTimer, TInsCharCom, TInsTextCom, TInterruptHandler, TLeafObject, TMessageHandler, TNotifyLink< Type >, TNotifyLink< RNoCleanupNotifierHelper >, TNotifyLink< ROOT::Detail::TBranchProxy >, TNotifyLink< TTreeReader >, TPopupDelayTimer, TProcessEventTimer, TRefTable, TRepeatTimer, TSBRepeatTimer, TSelector, TSelectorDraw, TSelectorEntries, TSignalHandler, TSingleShotCleaner, TSocketHandler, TStdExceptionHandler, TSysEvtHandler, TTermInputHandler, TThreadTimer, TTimeOutTimer, TTimer, TTipDelayTimer, TTree, TTreeFormula, TTreeFormulaManager, TTreeReader, TViewTimer, and TViewUpdateTimer.

Definition at line 618 of file TObject.cxx.

Obsolete()

void TObject::Obsolete ( const char * method, const char * asOfVers, const char * removedFromVers ) const

inherited

Use this method to declare a method obsolete.

Specify as of which version the method is obsolete and as from which version it will be removed.

Definition at line 1169 of file TObject.cxx.

operator delete() [1/3]

void TObject::operator delete ( void * ptr, size_t size )

inherited

Operator delete for sized deallocation.

Definition at line 1234 of file TObject.cxx.

operator delete() [2/3]

void TObject::operator delete ( void * ptr )

inherited

Operator delete.

Definition at line 1212 of file TObject.cxx.

operator delete() [3/3]

void TObject::operator delete ( void * ptr, void * vp )

inherited

Only called by placement new when throwing an exception.

Definition at line 1266 of file TObject.cxx.

operator delete[]() [1/3]

void TObject::operator delete[] ( void * ptr, size_t size )

inherited

Operator delete [] for sized deallocation.

Definition at line 1245 of file TObject.cxx.

operator delete[]() [2/3]

void TObject::operator delete[] ( void * ptr )

inherited

Operator delete [].

Definition at line 1223 of file TObject.cxx.

operator delete[]() [3/3]

void TObject::operator delete[] ( void * ptr, void * vp )

inherited

Only called by placement new[] when throwing an exception.

Definition at line 1274 of file TObject.cxx.

operator new() [1/2]

void * TObject::operator new ( size_t sz )

inlineinherited

Definition at line 189 of file TObject.h.

operator new() [2/2]

void * TObject::operator new ( size_t sz, void * vp )

inlineinherited

Definition at line 191 of file TObject.h.

operator new[]() [1/2]

void * TObject::operator new[] ( size_t sz )

inlineinherited

Definition at line 190 of file TObject.h.

operator new[]() [2/2]

void * TObject::operator new[] ( size_t sz, void * vp )

inlineinherited

Definition at line 192 of file TObject.h.

Paint()

void TObject::Paint ( Option_t * option = "" )

virtualinherited

This method must be overridden if a class wants to paint itself.

The difference between Paint() and Draw() is that when a object draws itself it is added to the display list of the pad in which it is drawn (and automatically redrawn whenever the pad is redrawn). While paint just draws the object without adding it to the pad display list.

Reimplemented in ROOT::Experimental::RTreeMapPainter, ROOT::RGeoPainter, TAnnotation, TArrow, TASImage, TASPaletteEditor::LimitLine, TASPaletteEditor::PaintPalette, TAxis3D, TBits, TBox, TButton, TCanvas, TClassTree, TCollection, TColorWheel, TCrown, TDiamond, TDirectory, TEfficiency, TEllipse, TEveArrow, TEveCaloViz, TEveDigitSet, TEveGeoShape, TEveGeoTopNode, TEvePlot3D, TEvePointSet, TEveProjectionAxes, TEveScene, TEveShape, TEveStraightLineSet, TEveText, TEveTriangleSet, TExec, TF1, TF2, TF3, TFile, TFileDrawMap, TFrame, TGaxis, TGenerator, TGeoBoolNode, TGeoIntersection, TGeoNode, TGeoOverlap, TGeoPainter, TGeoPhysicalNode, TGeoShape, TGeoSubtraction, TGeoTrack, TGeoUnion, TGeoVGShape, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph2D, TGraph2DPainter, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TGraphTime, TH1, THistPainter, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TNode, TNodeDiv, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TRatioPlot, TScatter2D, TScatter, TShape, TSpectrum2Painter, TSpider, TSpline, TSQLFile, TStyle, TText, TTreePerfStats, TVirtualGeoPainter, TVirtualGeoTrack, TVirtualHistPainter, TVirtualPad, TWbox, and TXMLFile.

Definition at line 631 of file TObject.cxx.

Pop()

void TObject::Pop ( )

virtualinherited

Pop on object drawn in a pad to the top of the display list.

I.e. it will be drawn last and on top of all other primitives.

Reimplemented in TFrame, TPad, and TVirtualPad.

Definition at line 640 of file TObject.cxx.

Print()

void TNamed::Print ( Option_t * option = "" ) const

overridevirtualinherited

Print TNamed name and title.

Reimplemented from TObject.

Reimplemented in ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoPoint, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoSpace, ROOT::Experimental::XRooFit::xRooNode, TParallelCoordRange, TParallelCoordVar, TParticleClassPDG, TParticlePDG, TPrincipal, TScatter2D, TScatter, TSpectrum2, TSpectrum3, TSpectrum, TSQLColumnInfo, TSQLFile, TSQLTableInfo, TText, TTree, TTreeIndex, TXMLFile, and TXTRU.

Definition at line 127 of file TNamed.cxx.

Produce()

Bool_t TRootSniffer::Produce	(	const std::string &	path,
		const std::string &	file,
		const std::string &	options,
		std::string &	res )

Method produce different kind of data out of object.

Parameters

path	specifies object or object member
file	can be:

• "root.bin" - binary data
• "root.png" - png image
• "root.jpeg" - jpeg image
• "root.gif" - gif image
• "root.xml" - xml representation
• "root.json" - json representation
• "file.root" - ROOT file with stored object
• "exe.json" - method execution with json reply
• "exe.bin" - method execution with binary reply
• "exe.txt" - method execution with debug output
• "cmd.json" - execution of registered commands

Parameters

options	specific options
res	returns result - binary or text.

Definition at line 1521 of file TRootSniffer.cxx.

ProduceBinary()

Bool_t TRootSniffer::ProduceBinary ( const std::string & path, const std::string & options, std::string & res )

protectedvirtual

Produce binary data for specified item.

If "zipped" option specified in query, buffer will be compressed

Implemented only in TRootSnifferFull class

Reimplemented in TRootSnifferFull.

Definition at line 1448 of file TRootSniffer.cxx.

ProduceExe()

Bool_t TRootSniffer::ProduceExe ( const std::string & path, const std::string & options, Int_t reskind, std::string & res )

protectedvirtual

Execute command for specified object.

Options include method and extra list of parameters sniffer should be not-readonly to allow execution of the commands reskind defines kind of result 0 - debug, 1 - json, 2 - binary

Method implemented only in TRootSnifferFull class

Reimplemented in TRootSnifferFull.

Definition at line 1322 of file TRootSniffer.cxx.

ProduceImage()

Bool_t TRootSniffer::ProduceImage ( Int_t kind, const std::string & path, const std::string & options, std::string & res )

protectedvirtual

Method to produce image from specified object.

Parameters:

kind - image kind TImage::kPng, TImage::kJpeg, TImage::kGif
path - path to object
options - extra options

By default, image 300x200 is produced In options string one could provide following parameters:

w - image width
h - image height
opt - draw options

For instance:

http://localhost:8080/Files/hsimple.root/hpx/get.png?w=500&h=500&opt=lego1

Returns produced image in the res string

Method implemented only in TRootSnifferFull class

Reimplemented in TRootSnifferFull.

Definition at line 1487 of file TRootSniffer.cxx.

ProduceItem()

Bool_t TRootSniffer::ProduceItem ( const std::string & path, const std::string & options, std::string & res, Bool_t asjson = kTRUE )

protectedvirtual

Produce JSON/XML for specified item.

Contrary to h.json request, only fields for specified item are stored

Definition at line 1260 of file TRootSniffer.cxx.

ProduceJson()

Bool_t TRootSniffer::ProduceJson ( const std::string & path, const std::string & options, std::string & res )

protectedvirtual

Produce JSON data for specified item For object conversion TBufferJSON is used.

Definition at line 1130 of file TRootSniffer.cxx.

ProduceMulti()

Bool_t TRootSniffer::ProduceMulti ( const std::string & path, const std::string & options, std::string & str, Bool_t asjson = kTRUE )

protectedvirtual

Process several requests, packing all results into binary or JSON buffer.

Input parameters should be coded in the POST block and has individual request relative to current path, separated with '
' symbol like item1/root.bin
item2/exe.bin?method=GetList
item3/exe.bin?method=GetTitle
Request requires 'number' URL option which contains number of requested items

In case of binary request output buffer looks like:

4bytes length + payload,
4bytes length + payload, ...

In case of JSON request output is array with results for each item multi.json request do not support binary requests for the items

Definition at line 1346 of file TRootSniffer.cxx.

ProduceRootFile()

Bool_t TRootSniffer::ProduceRootFile ( const std::string & path, const std::string & options, std::string & res )

protectedvirtual

Produce ROOT file for specified item.

Implemented only in TRootSnifferFull class

Reimplemented in TRootSnifferFull.

Definition at line 1458 of file TRootSniffer.cxx.

ProduceXml()

Bool_t TRootSniffer::ProduceXml ( const std::string & path, const std::string & options, std::string & res )

protectedvirtual

Produce XML data for specified item.

For object conversion TBufferXML is used Method implemented only in TRootSnifferFull class

Reimplemented in TRootSnifferFull.

Definition at line 1280 of file TRootSniffer.cxx.

Read()

Int_t TObject::Read ( const char * name )

virtualinherited

Read contents of object with specified name from the current directory.

First the key with the given name is searched in the current directory, next the key buffer is deserialized into the object. The object must have been created before via the default constructor. See TObject::Write().

Reimplemented in TBuffer, TKey, TKeySQL, and TKeyXML.

Definition at line 673 of file TObject.cxx.

RecursiveRemove()

void TObject::RecursiveRemove ( TObject * obj )

virtualinherited

Recursively remove this object from a list.

Typically implemented by classes that can contain multiple references to a same object.

Reimplemented in RooAbsCollection, RooAbsData, RooLinkedList, RooMCStudy, ROOT::Internal::TCheckHashRecursiveRemoveConsistency, ROOT::RBrowserDataCleanup, RooWorkspace, TBrowser, TChain, TCling, TCollection, TDialogCanvas, TDirectory, TEfficiency, TFileMerger, TFitEditor, TFolder, TFriendElement, TGedEditor, TGeometry, TGFileBrowser, TGraph2D, TGraph, TH1, TH1Editor, TH2Editor, THashList, THistPainter, THStack, TInspectCanvas, TLegend, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TMultiGraph, TNode, TObjArray, TObjectRefSpy, TObjectSpy, TPad, TProcessID, TROOT, TRootBrowser, TRootBrowserHistory, TRootBrowserLite, TRootContextMenu, TTree, TTreePlayer, TViewPubDataMembers, TViewPubFunctions, and TVirtualPad.

Definition at line 684 of file TObject.cxx.

RegisterCommand()

Bool_t TRootSniffer::RegisterCommand	(	const char *	cmdname,
		const char *	method,
		const char *	icon )

Register command which can be executed from web interface.

As method one typically specifies string, which is executed with gROOT->ProcessLine() method. For instance:

serv->RegisterCommand("Invoke","InvokeFunction()");

Or one could specify any method of the object which is already registered to the server. For instance:

serv->Register("/", hpx);
serv->RegisterCommand("/ResetHPX", "/hpx/->Reset()");

Here symbols '/->' separates item name from method to be executed

One could specify additional arguments in the command with syntax like arg1%, arg2% and so on. For example:

serv->RegisterCommand("/ResetHPX", "/hpx/->SetTitle(\"%arg1%\")");
serv->RegisterCommand("/RebinHPXPY", "/hpxpy/->Rebin2D(%arg1%,%arg2%)");

Such parameter(s) will be requested when command clicked in the browser.

Once command is registered, one could specify icon which will appear in the browser:

serv->SetIcon("/ResetHPX", "rootsys/icons/ed_execute.png");

One also can set extra property '_fastcmd', that command appear as tool button on the top of the browser tree:

serv->SetItemField("/ResetHPX", "_fastcmd", "true");

Or it is equivalent to specifying extra argument when register command:

serv->RegisterCommand("/ResetHPX", "/hpx/->Reset()", "button;rootsys/icons/ed_delete.png"); 

Definition at line 1892 of file TRootSniffer.cxx.

RegisterObject()

Bool_t TRootSniffer::RegisterObject	(	const char *	subfolder,
		TObject *	obj )

Register object in subfolder structure.

Parameters

obj	pointer to TObject
subfolder	can have many levels like: TRootSniffer* sniff = new TRootSniffer("sniff"); sniff->RegisterObject("my/sub/subfolder", h1);

Such objects can be later found in "Objects" folder of sniffer like

auto h1 = sniff->FindTObjectInHierarchy("/Objects/my/sub/subfolder/h1");

If subfolder name starts with '/', object will be registered starting from top folder.

One could provide additional fields for registered objects For instance, setting "_more" field to true let browser explore objects members. For instance:

TEvent* ev = new TEvent("ev");
sniff->RegisterObject("Events", ev);
sniff->SetItemField("Events/ev", "_more", "true"); 

Definition at line 1659 of file TRootSniffer.cxx.

ResetBit()

void TObject::ResetBit ( UInt_t f )

inlineinherited

Definition at line 203 of file TObject.h.

Restrict()

void TRootSniffer::Restrict	(	const char *	path,
		const char *	options )

Restrict access to the specified location.

Hides or provides read-only access to different parts of the hierarchy Restriction done base on user-name specified with http requests Options can be specified in URL style (separated with &) Following parameters can be specified:

visible = [all|user(s)] - make item visible for all users or only specified user
hidden = [all|user(s)] - make item hidden from all users or only specified user
readonly = [all|user(s)] - make item read-only for all users or only specified user
allow = [all|user(s)] - make full access for all users or only specified user
allow_method = method(s)  - allow method(s) execution even when readonly flag specified for the object

Like make command seen by all but can be executed only by admin

sniff->Restrict("/CmdReset","allow=admin");

Or fully hide command from guest account

sniff->Restrict("/CmdRebin","hidden=guest"); 

Definition at line 464 of file TRootSniffer.cxx.

SaveAs()

void TObject::SaveAs ( const char * filename = "", Option_t * option = "" ) const

virtualinherited

Save this object in the file specified by filename.

• if "filename" contains ".root" the object is saved in filename as root binary file.
• if "filename" contains ".xml" the object is saved in filename as a xml ascii file.
• if "filename" contains ".cc" the object is saved in filename as C code independent from ROOT. The code is generated via SavePrimitive(). Specific code should be implemented in each object to handle this option. Like in TF1::SavePrimitive().

• otherwise the object is written to filename as a CINT/C++ script. The C++ code to rebuild this object is generated via SavePrimitive(). The "option" parameter is passed to SavePrimitive. By default it is an empty string. It can be used to specify the Draw option in the code generated by SavePrimitive.

  The function is available via the object context menu.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TClassTree, TFolder, TGeoVolume, TGObject, TGraph, TH1, TPad, TPaveClass, TSpline3, TSpline5, TSpline, TTreePerfStats, and TVirtualPad.

Definition at line 708 of file TObject.cxx.

SavePrimitive()

void TObject::SavePrimitive ( std::ostream & out, Option_t * option = "" )

virtualinherited

Save a primitive as a C++ statement(s) on output stream "out".

Reimplemented in TAnnotation, TArc, TArrow, TASImage, TAxis3D, TBox, TButton, TCanvas, TChain, TCrown, TCurlyArc, TCurlyLine, TCutG, TDiamond, TEfficiency, TEllipse, TExec, TF12, TF1, TF2, TF3, TFrame, TGaxis, TGButton, TGButtonGroup, TGCanvas, TGCheckButton, TGColorSelect, TGColumnLayout, TGComboBox, TGCompositeFrame, TGContainer, TGDockableFrame, TGDoubleHSlider, TGDoubleVSlider, TGedMarkerSelect, TGedPatternSelect, TGeoArb8, TGeoBBox, TGeoBoolNode, TGeoCombiTrans, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoCtub, TGeoDecayChannel, TGeoElementRN, TGeoEltu, TGeoGtra, TGeoHalfSpace, TGeoHMatrix, TGeoHype, TGeoIdentity, TGeoIntersection, TGeoMaterial, TGeoMedium, TGeoMixture, TGeoPara, TGeoParaboloid, TGeoPatternCylPhi, TGeoPatternCylR, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternSphPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternTrapZ, TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPcon, TGeoPgon, TGeoRotation, TGeoScaledShape, TGeoShapeAssembly, TGeoSphere, TGeoSubtraction, TGeoTessellated, TGeoTorus, TGeoTranslation, TGeoTrap, TGeoTrd1, TGeoTrd2, TGeoTube, TGeoTubeSeg, TGeoUnion, TGeoVolume, TGeoXtru, TGFileContainer, TGFont, TGFrame, TGFSComboBox, TGGC, TGGroupFrame, TGHButtonGroup, TGHorizontal3DLine, TGHorizontalFrame, TGHorizontalLayout, TGHProgressBar, TGHScrollBar, TGHSlider, TGHSplitter, TGHtml, TGIcon, TGLabel, TGLayoutHints, TGLineStyleComboBox, TGLineWidthComboBox, TGListBox, TGListDetailsLayout, TGListLayout, TGListTree, TGListView, TGLVContainer, TGMainFrame, TGMatrixLayout, TGMdiFrame, TGMdiMainFrame, TGMdiMenuBar, TGMenuBar, TGMenuTitle, TGNumberEntry, TGNumberEntryField, TGPictureButton, TGPopupMenu, TGProgressBar, TGRadioButton, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraph, TGraphAsymmErrors, TGraphBentErrors, TGraphEdge, TGraphErrors, TGraphMultiErrors, TGraphNode, TGraphPolar, TGraphPolargram, TGraphStruct, TGroupButton, TGRowLayout, TGShapedFrame, TGShutter, TGShutterItem, TGSplitFrame, TGStatusBar, TGTab, TGTabLayout, TGTableLayout, TGTableLayoutHints, TGTextButton, TGTextEdit, TGTextEntry, TGTextLBEntry, TGTextView, TGTileLayout, TGToolBar, TGTransientFrame, TGTripleHSlider, TGTripleVSlider, TGVButtonGroup, TGVertical3DLine, TGVerticalFrame, TGVerticalLayout, TGVFileSplitter, TGVProgressBar, TGVScrollBar, TGVSlider, TGVSplitter, TGXYLayout, TGXYLayoutHints, TH1, TH2Poly, THelix, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TPad, TPaletteAxis, TParallelCoord, TParallelCoordVar, TPave, TPaveClass, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPieSlice, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TProfile2D, TProfile3D, TProfile, TRootContainer, TRootEmbeddedCanvas, TScatter2D, TScatter, TSlider, TSliderBox, TSpline3, TSpline5, TStyle, TText, TTreePerfStats, and TWbox.

Definition at line 858 of file TObject.cxx.

SavePrimitiveConstructor()

void TObject::SavePrimitiveConstructor ( std::ostream & out, TClass * cl, const char * variable_name, const char * constructor_agrs = "", Bool_t empty_line = kTRUE )

staticprotectedinherited

Save object constructor in the output stream "out".

Can be used as first statement when implementing SavePrimitive() method for the object

Definition at line 777 of file TObject.cxx.

SavePrimitiveDraw()

void TObject::SavePrimitiveDraw ( std::ostream & out, const char * variable_name, Option_t * option = nullptr )

staticprotectedinherited

Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.

Definition at line 845 of file TObject.cxx.

SavePrimitiveNameTitle()

void TNamed::SavePrimitiveNameTitle ( std::ostream & out, const char * variable_name )

protectedinherited

Save object name and title into the output stream "out".

Definition at line 135 of file TNamed.cxx.

SavePrimitiveVector()

TString TObject::SavePrimitiveVector ( std::ostream & out, const char * prefix, Int_t len, Double_t * arr, Int_t flag = 0 )

staticprotectedinherited

Save array in the output stream "out" as vector.

Create unique variable name based on prefix value Returns name of vector which can be used in constructor or in other places of C++ code If flag === kTRUE, just add empty line If flag === 111, check if array is empty and return nullptr or <vectorname>.data()

Definition at line 796 of file TObject.cxx.

ScanCollection()

void TRootSniffer::ScanCollection ( TRootSnifferScanRec & rec, TCollection * lst, const char * foldername = nullptr, TCollection * keys_lst = nullptr )

protected

Scan collection content.

Definition at line 774 of file TRootSniffer.cxx.

ScanHierarchy()

void TRootSniffer::ScanHierarchy	(	const char *	topname,
		const char *	path,
		TRootSnifferStore *	store,
		Bool_t	only_fields = kFALSE )

Method scans normal objects, registered in ROOT.

scan ROOT hierarchy with provided store object

Definition at line 999 of file TRootSniffer.cxx.

ScanKeyProperties()

void TRootSniffer::ScanKeyProperties ( TRootSnifferScanRec & rec, TKey * key, TObject *& obj, TClass *& obj_class )

protectedvirtual

Scans TKey properties in special cases load objects from the file.

Reimplemented in TRootSnifferFull.

Definition at line 739 of file TRootSniffer.cxx.

ScanObjectChilds()

void TRootSniffer::ScanObjectChilds ( TRootSnifferScanRec & rec, TObject * obj )

protectedvirtual

scans object childs (if any) here one scans collection, branches, trees and so on

Reimplemented in TRootSnifferFull.

Definition at line 759 of file TRootSniffer.cxx.

ScanObjectMembers()

void TRootSniffer::ScanObjectMembers ( TRootSnifferScanRec & rec, TClass * cl, char * ptr )

protected

scan object data members some members like enum or static members will be excluded

Definition at line 606 of file TRootSniffer.cxx.

ScanObjectProperties()

void TRootSniffer::ScanObjectProperties ( TRootSnifferScanRec & rec, TObject * obj )

protectedvirtual

Scans object properties here such fields as _autoload or _icon properties depending on class or object name could be assigned By default properties, coded in the Class title are scanned.

Example:

ClassDef(UserClassName, 1) //  class comments *SNIFF*  _field1=value _field2="string value"

Here SNIFF mark is important. After it all expressions like field=value are parsed One could use double quotes to code string values with spaces. Fields separated from each other with spaces

Reimplemented in TRootSnifferFull.

Definition at line 698 of file TRootSniffer.cxx.

ScanRoot()

void TRootSniffer::ScanRoot ( TRootSnifferScanRec & rec )

protectedvirtual

scan complete ROOT objects hierarchy For the moment it includes objects in gROOT directory and list of canvases and files Also all registered objects are included.

One could re-implement this method to provide alternative scan methods or to extend some collection kinds

Definition at line 963 of file TRootSniffer.cxx.

SetAutoLoad()

void TRootSniffer::SetAutoLoad

(

const char *

scripts = ""

)

When specified, _autoload attribute will be always add to top element of h.json/h.hml requests Used to instruct browser automatically load special code.

Definition at line 480 of file TRootSniffer.cxx.

SetBit() [1/2]

void TObject::SetBit ( UInt_t f )

inlineinherited

Definition at line 202 of file TObject.h.

SetBit() [2/2]

void TObject::SetBit ( UInt_t f, Bool_t set )

inherited

Set or unset the user status bits as specified in f.

Definition at line 888 of file TObject.cxx.

SetCurrentCallArg()

THttpCallArg * TRootSniffer::SetCurrentCallArg

(

THttpCallArg *

arg

)

set current http arguments, which then used in different process methods For instance, if user authorized with some user name, depending from restrictions some objects will be invisible or user get full access to the element Returns previous argument which was set before

Definition at line 433 of file TRootSniffer.cxx.

SetDrawOption()

void TObject::SetDrawOption ( Option_t * option = "" )

virtualinherited

Set drawing option for object.

This option only affects the drawing style and is stored in the option field of the TObjOptLink supporting a TPad's primitive list (TList). Note that it does not make sense to call object.SetDrawOption(option) before having called object.Draw().

Reimplemented in RooPlot, TAxis, TBrowser, TGedFrame, TGFrame, TPad, TPaveStats, TRootBrowserLite, TSystemDirectory, and TSystemFile.

Definition at line 871 of file TObject.cxx.

SetDtorOnly()

void TObject::SetDtorOnly ( void * obj )

staticinherited

Set destructor only flag.

Definition at line 1204 of file TObject.cxx.

SetItemField()

Bool_t TRootSniffer::SetItemField	(	const char *	fullname,
		const char *	name,
		const char *	value )

Set field for specified item.

Definition at line 1803 of file TRootSniffer.cxx.

SetName()

void TNamed::SetName ( const char * name )

virtualinherited

Set the name of the TNamed.

WARNING: if the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, ROOT::Experimental::XRooFit::xRooNode, TChain, TColor, TDirectory, TEfficiency, TEventList, TEveScene, TFormula, TGraph2D, TGraph, TH1, TNode, TRotMatrix, TShape, TSystemDirectory, TSystemFile, and TTree.

Definition at line 149 of file TNamed.cxx.

SetNameTitle()

void TNamed::SetNameTitle ( const char * name, const char * title )

virtualinherited

Set all the TNamed parameters (name and title).

WARNING: if the name is changed and the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, TContextMenu, TGraph2D, TGraph, TH1, and TNode.

Definition at line 163 of file TNamed.cxx.

SetObjectStat()

void TObject::SetObjectStat ( Bool_t stat )

staticinherited

Turn on/off tracking of objects in the TObjectTable.

Definition at line 1188 of file TObject.cxx.

SetReadOnly()

void TRootSniffer::SetReadOnly ( Bool_t on = kTRUE )

inline

When readonly on (default), sniffer is not allowed to change ROOT structures For instance, it is not allowed to read new objects from files.

Definition at line 190 of file TRootSniffer.h.

SetScanGlobalDir()

void TRootSniffer::SetScanGlobalDir ( Bool_t on = kTRUE )

inline

When enabled (default), sniffer scans gROOT for files, canvases, histograms.

Definition at line 206 of file TRootSniffer.h.

SetTitle()

void TNamed::SetTitle ( const char * title = "" )

virtualinherited

Set the title of the TNamed.

Reimplemented in Axis2, RooPlot, ROOT::Experimental::XRooFit::xRooNode, ROOT::TSchemaRule::TSources, TASImage, TEfficiency, TF1, TGraph2D, TGraph, TH1, THnBase, TParallelCoordVar, TSystemDirectory, and TSystemFile.

Definition at line 173 of file TNamed.cxx.

SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid )

virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

Sizeof()

Int_t TNamed::Sizeof ( ) const

virtualinherited

Return size of the TNamed part of the TObject.

Reimplemented in TDirectory, TDirectoryFile, TFile, TKey, TSQLFile, and TXMLFile.

Definition at line 182 of file TNamed.cxx.

Streamer()

void TRootSniffer::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TNamed.

StreamerNVirtual()

void TRootSniffer::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 249 of file TRootSniffer.h.

SysError()

void TObject::SysError ( const char * location, const char * fmt, ... ) const

virtualinherited

Issue system error message.

Use "location" to specify the method where the system error occurred. Accepts standard printf formatting arguments.

Definition at line 1112 of file TObject.cxx.

TestBit()

Bool_t TObject::TestBit ( UInt_t f ) const

inlineinherited

Definition at line 204 of file TObject.h.

TestBits()

Int_t TObject::TestBits ( UInt_t f ) const

inlineinherited

Definition at line 205 of file TObject.h.

UnregisterObject()

Bool_t TRootSniffer::UnregisterObject

(

TObject *

obj

)

Unregister (remove) object from folders structures.

Folder itself will remain even when it will be empty

Definition at line 1678 of file TRootSniffer.cxx.

UseCurrentStyle()

void TObject::UseCurrentStyle ( )

virtualinherited

Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

Reimplemented in TAxis3D, TCanvas, TFrame, TGraph, TH1, TPad, TPaveStats, TPaveText, and TTree.

Definition at line 909 of file TObject.cxx.

Warning()

void TObject::Warning ( const char * location, const char * fmt, ... ) const

virtualinherited

Issue warning message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1084 of file TObject.cxx.

WithCurrentUserName()

Int_t TRootSniffer::WithCurrentUserName ( const char * option )

protected

return 2 when option match to current user name return 1 when option==all return 0 when option does not match user name

Definition at line 510 of file TRootSniffer.cxx.

Write() [1/2]

Int_t TObject::Write ( const char * name = nullptr, Int_t option = 0, Int_t bufsize = 0 )

virtualinherited

Write this object to the current directory.

For more see the const version of this method.

Reimplemented in ROOT::TBufferMergerFile, TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 989 of file TObject.cxx.

Write() [2/2]

Int_t TObject::Write ( const char * name = nullptr, Int_t option = 0, Int_t bufsize = 0 ) const

virtualinherited

Write this object to the current directory.

The data structure corresponding to this object is serialized. The corresponding buffer is written to the current directory with an associated key with name "name".

Writing an object to a file involves the following steps:

• Creation of a support TKey object in the current directory. The TKey object creates a TBuffer object.
• The TBuffer object is filled via the class::Streamer function.
• If the file is compressed (default) a second buffer is created to hold the compressed buffer.
• Reservation of the corresponding space in the file by looking in the TFree list of free blocks of the file.
• The buffer is written to the file.

Bufsize can be given to force a given buffer size to write this object. By default, the buffersize will be taken from the average buffer size of all objects written to the current file so far.

If a name is specified, it will be the name of the key. If name is not given, the name of the key will be the name as returned by GetName().

The option can be a combination of: kSingleKey, kOverwrite or kWriteDelete Using the kOverwrite option a previous key with the same name is overwritten. The previous key is deleted before writing the new object. Using the kWriteDelete option a previous key with the same name is deleted only after the new object has been written. This option is safer than kOverwrite but it is slower. NOTE: Neither kOverwrite nor kWriteDelete reduces the size of a TFile– the space is simply freed up to be overwritten; in the case of a TTree, it is more complicated. If one opens a TTree, appends some entries, then writes it out, the behaviour is effectively the same. If, however, one creates a new TTree and writes it out in this way, only the metadata is replaced, effectively making the old data invisible without deleting it. TTree::Delete() can be used to mark all disk space occupied by a TTree as free before overwriting its metadata this way. The kSingleKey option is only used by TCollection::Write() to write a container with a single key instead of each object in the container with its own key.

An object is read from the file into memory via TKey::Read() or via TObject::Read().

The function returns the total number of bytes written to the file. It returns 0 if the object cannot be written.

Reimplemented in TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 964 of file TObject.cxx.

Member Data Documentation

fAutoLoad

TString TRootSniffer::fAutoLoad

protected

! scripts names, which are add as _autoload parameter to h.json request

Definition at line 129 of file TRootSniffer.h.

fBits

UInt_t TObject::fBits

privateinherited

bit field status word

Definition at line 47 of file TObject.h.

fCurrentAllowedMethods

TString TRootSniffer::fCurrentAllowedMethods

protected

! list of allowed methods, extracted when analyzed object restrictions

Definition at line 127 of file TRootSniffer.h.

fCurrentArg

THttpCallArg* TRootSniffer::fCurrentArg {nullptr}

protected

! current http arguments (if any)

Definition at line 125 of file TRootSniffer.h.

fCurrentRestrict

Int_t TRootSniffer::fCurrentRestrict {0}

protected

! current restriction for last-found object

Definition at line 126 of file TRootSniffer.h.

fgDtorOnly

Longptr_t TObject::fgDtorOnly = 0

staticprivateinherited

object for which to call dtor only (i.e. no delete)

Definition at line 49 of file TObject.h.

fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE

staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.h.

fName

TString TNamed::fName

protectedinherited

Definition at line 32 of file TNamed.h.

fObjectsPath

TString TRootSniffer::fObjectsPath

protected

! default path for registered objects

Definition at line 121 of file TRootSniffer.h.

fReadOnly

Bool_t TRootSniffer::fReadOnly {kTRUE}

protected

! indicate if sniffer allowed to change ROOT structures - like read objects from file

Definition at line 122 of file TRootSniffer.h.

fRestrictions

TList TRootSniffer::fRestrictions

protected

! list of restrictions for different locations

Definition at line 128 of file TRootSniffer.h.

fScanGlobalDir

Bool_t TRootSniffer::fScanGlobalDir {kTRUE}

protected

! when enabled (default), scan gROOT for histograms, canvases, open files

Definition at line 123 of file TRootSniffer.h.

fTitle

TString TNamed::fTitle

protectedinherited

Definition at line 33 of file TNamed.h.

fTopFolder

std::unique_ptr<TFolder> TRootSniffer::fTopFolder

protected

! own top TFolder object, used for registering objects

Definition at line 124 of file TRootSniffer.h.

fUniqueID

UInt_t TObject::fUniqueID

privateinherited

object unique identifier

Definition at line 46 of file TObject.h.

---

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

• net/http/inc/TRootSniffer.h
• net/http/src/TRootSniffer.cxx