Logo ROOT  
Reference Guide
TObject Class Reference

Mother of all ROOT objects.

The TObject class provides default behaviour and protocol for all objects in the ROOT system. It provides protocol for object I/O, error handling, sorting, inspection, printing, drawing, etc. Every object which inherits from TObject can be stored in the ROOT collection classes.

TObject's bits can be used as flags, bits 0 - 13 and 24-31 are reserved as global bits while bits 14 - 23 can be used in different class hierarchies (watch out for overlaps).

Definition at line 37 of file TObject.h.

Public Types

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

Public Member Functions

 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Static Public Member Functions

static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

Protected Types

enum  { kOnlyPrepStep = BIT(3) }
 

Protected Member Functions

virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

Static Private Member Functions

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

Private Attributes

UInt_t fBits
 bit field status word More...
 
UInt_t fUniqueID
 object unique identifier More...
 

Static Private Attributes

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

Friends

class TClonesArray
 

#include <TObject.h>

Inherited by TEveRecTrackT< Float_t >, TMatrixTBase< Double_t >, TMatrixTBase< AReal >, TParameter< Long64_t >, TVectorT< Double_t >, Hit, Jet, JetEvent, Memstat::TMemStatMng, MonitoredTFileInfo, PyROOT::TMemoryRegulator, ROOT::Detail::TSchemaRuleSet, ROOT::Experimental::REveRGBAPalette, ROOT::Experimental::REveTrans, ROOT::Experimental::REveVSD, ROOT::Experimental::TTreeReaderFast, ROOT::Internal::TCheckHashRecursiveRemoveConsistency, ROOT::Internal::TTreeReaderDescriptor, ROOT::R::TRDataFrame, ROOT::R::TRFunctionExport, ROOT::R::TRFunctionImport, ROOT::R::TRInterface, ROOT::R::TRObject, ROOT::TSchemaRule, RooAbsCollection, RooAbsIntegrator, RooCFunction1Ref< VO, VI >, RooCFunction2Ref< VO, VI1, VI2 >, RooCFunction3Ref< VO, VI1, VI2, VI3 >, RooCFunction4Ref< VO, VI1, VI2, VI3, VI4 >, RooCatType, RooCmdConfig, RooExpensiveObjectCache, RooGrid, RooHashTable, RooLinkedList, RooMinimizer, RooMinuit, RooMsgService, RooNameSet, RooNumGenConfig, RooNumGenFactory, RooNumIntConfig, RooNumIntFactory, RooSetPair, RooSharedProperties, RooSimPdfBuilder, RooStats::AcceptanceRegion, RooStats::HistFactory::EstimateSummary, RooStats::HistFactory::HistoToWorkspaceFactory, RooStats::HistFactory::HistoToWorkspaceFactoryFast, RooStats::MetropolisHastings, RooStats::ProposalFunction, RooStats::ProposalHelper, RooStats::SamplingSummary, RooStats::SamplingSummaryLookup, RooWorkspace::CodeRepo, TASPaletteEditor::PaintPalette, TAliEnFind, TApplication, TArchiveFile, TArchiveMember, TAuthenticate, TAxisModLab, TBinomialEfficiencyFitter, TBits, TBox, TBuffer, TBuffer3D, TClassDocInfo, TClassGenerator, TClassMenuItem, TClassTable, TCollection, TCondition, TConditionImp, TCondor, TCondorSlave, TConfidenceLevel, TDNDData, TDataSetManager, TDecayChannel, TDecompBase, TDictAttributeMap, TDimensionInfo, TDocMethodWrapper, TDocOutput, TDocParser, TDrawFeedback, TEllipse, TEntryListBlock, TEnv, TEnvRec, TEveCluster, TEveFrameBox, TEveGeoNode, TEveGridStepper, TEveHit, TEveMCRecCrossRef, TEveRGBAPalette, TEveRecCascade, TEveRecKink, TEveRecTrackT< TT >, TEveRecV0, TEveTrans, TEveVSD, TEventIter, TExMap, TF1AbsComposition, TFPBlock, TFTP, TFeldmanCousins, TFileCacheRead, TFileCacheWrite, TFileMerger, TFilePrefetch, TFoam, TFoamCell, TFoamIntegrand, TFoamMaxwt, TFoamVect, TFormLeafInfo, TFractionFitter, TFree, TGClient, TGDMLParse, TGDMLRefl, TGDMLWrite, TGDNDManager, TGFrameElement, TGGC, TGHtmlElement, TGHtmlImage, TGHtmlLayoutContext, TGHtmlUri, TGIdleHandler, TGItemContext, TGLAutoRotator, TGLCamera, TGLLightSet, TGLPShapeObj, TGLayoutHints, TGLayoutManager, TGMainFrame::TGMapKey, TGMenuEntry, TGMime, TGMimeTypes, TGObject, TGPicture, TGPicturePool, TGRectMap, TGRegion, TGTextEditCommand, TGTextLayout, TGUnknownWindowHandler, TGWin32CallBackObject, TGedFrame::TGedSubFrame, TGedTabInfo, TGenPhaseSpace, TGeoBatemanSol, TGeoBoolNode, TGeoBranchArray, TGeoBuilder, TGeoCacheState, TGeoChecker, TGeoDecayChannel, TGeoElementTable, TGeoExtension, TGeoGlobalMagField, TGeoHelix, TGeoIteratorPlugin, TGeoNavigator, TGeoNodeCache, TGeoPatternFinder, TGeoPolygon, TGeoTabManager, TGeoVoxelFinder, TGraph2DPainter, TGraphEdge, TGraphStruct, TGrid, TGridCollection, TGridJDL, TGridJob, TH2PolyBin, THLimitsFinder, THnChain, THnIter, THnSparseArrayChunk, THostAuth, THtml, THtml::TFileSysEntry, THtml::THelperBase, THttpCallArg, TIconBoxThumb, TImagePalette, TImagePlugin, TInetAddress, TInspectorObject, TJSONStackObj, TKDTree< Index, Value >, TKDTreeBinning, TLegendEntry, TLimitDataSource, TLine, TLockFile, TLockPath, TLorentzRotation, TLorentzVector, TMCParticle, TMCVerbose, TMLPAnalyzer, TMVA::DataInputHandler, TMVA::DataSetFactory, TMVA::DataSetInfo, TMVA::DataSetManager, TMVA::Event, TMVA::Experimental::ClassificationResult, TMVA::MsgLogger, TMVA::OptionBase, TMVA::PDEFoam, TMVA::PDEFoamCell, TMVA::PDEFoamDensityBase, TMVA::PDEFoamKernelBase, TMVA::PDEFoamVect, TMVA::Results, TMVA::RootFinder, TMVA::TNeuron, TMVA::TSynapse, TMVA::TreeInfo, TMVA::VariableTransformBase, TMapFile, TMarker, TMarker3DBox, TMatrixTBase< Element >, TMatrixTLazy< Element >, TMatrixTSymLazy< Element >, TMemStat, TMemStatShow, TMergerInfo, TMethodCall, TMonitor, TMrbSubevent_Caen, TMultiLayerPerceptron, TMutexImp, TNDArray, TNamed, TNotifyLinkBase, TObjString, TObjectRefSpy, TObjectSpy, TObjectTable, TOptionListItem, TOutputListSelectorDataMap, TPBHandleDSType, TPBHistType, TPBReadType, TPackageDescription, TPacketizer::TFileNode, TPacketizer::TFileStat, TPacketizerAdaptive::TFileNode, TPacketizerAdaptive::TFileStat, TPacketizerFile::TIterObj, TPair, TParameter< AParamType >, TParticle, TPerfEvent, TPluginHandler, TPluginManager, TPoints3DABC, TPolyLine, TPolyLine3D, TPolyMarker, TPolyMarker3D, TPrimary, TProofBench, TProofBenchDataSet, TProofBenchRun, TProofNodeInfo, TProofNodes, TProofPerfAnalysis::TWrkEntry, TProofProgressInfo, TProofProgressStatus, TProofResources, TPyDispatcher, TQSlot, TQpDataBase, TQpLinSolverBase, TQpProbBase, TQpResidual, TQpSolverBase, TQpVar, TQuaternion, TQueryDescription, TQueryResultManager, TRWLock, TRatioPlot, TRealData, TRecEvent, TRecWinPair, TRecorder, TRef, TRefTable, TRobustEstimator, TRolke, TRootBrowserHistoryCursor, TRootSnifferStore, TRotation, TS3HTTPRequest, TSPlot, TSQLClassColumnInfo, TSQLClassInfo, TSQLColumnData, TSQLObjectData, TSQLObjectDataPool, TSQLObjectInfo, TSQLResult, TSQLRow, TSQLServer, TSQLStatement, TSQLStructure, TSQLTableData, TSVDUnfold, TSecContext, TSecContextCleanup, TSelector, TSemaphore, TSessionDescription, TSlave, TSlaveInfo, TSpectrum2Transform, TSpider, TSplinePoly, TSqlCmdsBuffer, TSqlRawBuffer, TSqlRegistry, TStatistic, TStatsFeedback, TStopwatch, TStreamerInfoActions::TActionSequence, TStreamerInfoActions::TConfiguredAction, TStructNode, TStructViewer, TSynapse, TSysEvtHandler, TTVRecord, TTVSession, TThreadImp, TTreeDrawArgsParser, TTreeFormulaManager, TTreeReader, TUnfold, TUri, TUrl, TUsrHit, TUsrHitBuffer, TVector2, TVector3, TVectorT< Element >, TView, TVirtualFFT, TVirtualGeoConverter, TVirtualGeoPainter, TVirtualGeoTrack, TVirtualGraphPainter, TVirtualHistPainter, TVirtualMCDecayer, TVirtualMCStack, TVirtualPacketizer, TVirtualPacketizer::TVirtualSlaveStat, TVirtualPad, TVirtualPerfStats, TVirtualProofPlayer, TVirtualTreePlayer, TVirtualViewer3D, TXMLAttr, TXMLDocument, TXMLEngine, TXMLNode, TXMLParser, TXMLPlayer, and Track.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
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 76 of file TObject.h.

◆ anonymous enum

anonymous enum
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 86 of file TObject.h.

◆ anonymous enum

anonymous enum
protected
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 93 of file TObject.h.

◆ EDeprecatedStatusBits

Enumerator
kObjInCanvas 

for backward compatibility only, use kMustCleanup

Definition at line 71 of file TObject.h.

◆ EStatusBits

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 57 of file TObject.h.

Constructor & Destructor Documentation

◆ TObject() [1/2]

TObject::TObject ( )
inline

TObject constructor.

It sets the two data words of TObject to their initial values. The unique ID is set to 0 and the status word is set depending if the object is created on the stack or allocated on the heap. Depending on the ROOT environment variable "Root.MemStat" (see TEnv) the object is added to the global TObjectTable for bookkeeping.

Definition at line 241 of file TObject.h.

◆ TObject() [2/2]

TObject::TObject ( const TObject object)
inline

TObject copy ctor.

Definition at line 259 of file TObject.h.

◆ ~TObject()

TObject::~TObject ( )
virtual

TObject destructor.

Removes object from all canvases and object browsers if observer bit is on and remove from the global object table.

Definition at line 79 of file TObject.cxx.

Member Function Documentation

◆ AbstractMethod()

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

Use this method to implement an "abstract" method that you don't want to leave purely abstract.

Definition at line 933 of file TObject.cxx.

◆ AddToTObjectTable()

void TObject::AddToTObjectTable ( TObject op)
staticprivate

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

Included here to avoid circular dependency between header files.

Definition at line 96 of file TObject.cxx.

◆ AppendPad()

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

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 105 of file TObject.cxx.

◆ Browse()

◆ CheckedHash()

ULong_t TObject::CheckedHash ( )
inline

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 311 of file TObject.h.

◆ ClassName()

const char * TObject::ClassName ( ) const
virtual

Returns name of class to which the object belongs.

Definition at line 128 of file TObject.cxx.

◆ Clear()

◆ Clone()

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

Make a clone of an object using the Streamer facility.

If the object derives from TNamed, this function is called by TNamed::Clone. TNamed::Clone uses the optional argument to set a new name to the newly created object.

If the object class has a DirectoryAutoAdd function, it will be called at the end of the function with the parameter gDirectory. This usually means that the object will be appended to the current ROOT directory.

Reimplemented in TMVA::MinuitWrapper, TImage, RooCatType, RooNameSet, RooStudyPackage, RooLinkedList, RooStats::ModelConfig, TASImage, TNamed, TCollection, TClass, TFunction, TFunctionTemplate, TMethod, TMethodCall, TH2Poly, TStreamerInfo, TMinuit, RooAbsStudy, RooDataHist, RooDataSet, TF1, TH1, RooAbsArg, RooAbsBinning, RooAbsCollection, RooCmdArg, RooFitResult, RooTemplateProxy< T >, RooTemplateProxy< RooAbsReal >, RooTemplateProxy< RooAbsCategory >, RooTemplateProxy< RooAbsRealLValue >, RooTemplateProxy< RooAbsPdf >, RooTemplateProxy< RooRealVar >, RooTemplateProxy< RooMultiCategory >, and RooFormula.

Definition at line 144 of file TObject.cxx.

◆ Compare()

Int_t TObject::Compare ( const TObject obj) const
virtual

Compare abstract method.

Must be overridden if a class wants to be able to compare itself with other objects. Must return -1 if this is smaller than obj, 0 if objects are equal and 1 if this is larger than obj.

Reimplemented in TEnvRec, TFileInfo, TNamed, TObjString, TParameter< AParamType >, TParameter< Long64_t >, TUrl, TCollection, TGeoBranchArray, TGeoOverlap, TStructNode, TStructNodeProperty, TClassDocInfo, TDSetElement, TSlaveInfo, TSlave, TPerfEvent, RooAbsArg, RooDouble, and RooInt.

Definition at line 159 of file TObject.cxx.

◆ Copy()

◆ Delete()

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

◆ DistancetoPrimitive()

◆ DoError()

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

Interface to ErrorHandler (protected).

Reimplemented in TSlaveLite, TXSlave, TXSocket, TTreeViewer, and TThread.

Definition at line 852 of file TObject.cxx.

◆ Draw()

◆ DrawClass()

void TObject::DrawClass ( ) const
virtual

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 TSystemDirectory, TSystemFile, and TGFrame.

Definition at line 210 of file TObject.cxx.

◆ DrawClone()

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

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

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

Definition at line 219 of file TObject.cxx.

◆ Dump()

void TObject::Dump ( ) const
virtual

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
include TDocParser_001 C image html pict1_TDocParser_001 png width
Definition: TDocParser.cxx:121
UInt_t fUniqueID
object unique identifier
Definition: TObject.h:40
UInt_t fBits
bit field status word
Definition: TObject.h:41
TLine * line
fill
Definition: fit1_py.py:6
const char * Size
Definition: TXMLSetup.cxx:55
TCanvas * style()
Definition: style.C:1

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

Definition at line 266 of file TObject.cxx.

◆ Error()

void TObject::Error ( const char *  method,
const char *  msgfmt,
  ... 
) const
virtual

Issue error message.

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

Reimplemented in TFitResult.

Definition at line 891 of file TObject.cxx.

◆ Execute() [1/2]

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

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

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

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

Definition at line 277 of file TObject.cxx.

◆ Execute() [2/2]

void TObject::Execute ( TMethod method,
TObjArray params,
Int_t error = 0 
)
virtual

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
Collectable string class.
Definition: TObjString.h:28
const Int_t n
Definition: legend1.C:16

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

Definition at line 295 of file TObject.cxx.

◆ ExecuteEvent()

◆ Fatal()

void TObject::Fatal ( const char *  method,
const char *  msgfmt,
  ... 
) const
virtual

Issue fatal error message.

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

Definition at line 919 of file TObject.cxx.

◆ FindObject() [1/2]

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

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 TMap, TFolder, TROOT, TListOfTypes, TListOfTypes, TBtree, TCollection, THashList, THashTable, TList, TObjArray, TListOfDataMembers, TListOfDataMembers, TListOfFunctions, TListOfFunctionTemplates, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, TPad, TGeometry, THbookFile, TGraph, TGraph2D, TH1, RooLinkedList, TDirectory, and TListOfEnumsWithLock.

Definition at line 321 of file TObject.cxx.

◆ FindObject() [2/2]

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

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 TMap, TFolder, TROOT, TListOfTypes, TBtree, TCollection, THashList, THashTable, TList, TObjArray, TListOfDataMembers, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, TPad, TGeometry, THbookFile, TGraph, TGraph2D, TH1, RooLinkedList, TDirectory, and TListOfEnumsWithLock.

Definition at line 331 of file TObject.cxx.

◆ GetDrawOption()

Option_t * TObject::GetDrawOption ( ) const
virtual

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 341 of file TObject.cxx.

◆ GetDtorOnly()

Long_t TObject::GetDtorOnly ( )
static

Return destructor only flag.

Definition at line 980 of file TObject.cxx.

◆ GetIconName()

const char * TObject::GetIconName ( ) const
virtual

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 TSystemFile, TGeoVolume, TASImage, TGMainFrame, TKey, TBranch, TVirtualBranchBrowsable, TMethodBrowsable, and TBranchElement.

Definition at line 367 of file TObject.cxx.

◆ GetName()

◆ GetObjectInfo()

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

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 TGeoNode, TGeoVolume, TGeoTrack, TASImage, TColorWheel, TAxis3D, TNode, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TF1, TF2, TGraph, TH1, THistPainter, TPaletteAxis, TFileDrawMap, TParallelCoordVar, and TVirtualHistPainter.

Definition at line 386 of file TObject.cxx.

◆ GetObjectStat()

Bool_t TObject::GetObjectStat ( )
static

Get status of object stat flag.

Definition at line 965 of file TObject.cxx.

◆ GetOption()

virtual Option_t * TObject::GetOption ( ) const
inlinevirtual

◆ GetTitle()

const char * TObject::GetTitle ( ) const
virtual

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 in TNamed, TQCommand, TPair, TClassMenuItem, TBaseClass, TASImage, TPad, TGaxis, TPaveLabel, TEveGeoNode, TEvePointSet, TGTextButton, TGGroupFrame, TGLabel, TGTextLBEntry, TGLVEntry, TGTextEntry, TAxis, TKey, TMapFile, TParticle, TPrimary, TPackMgr, TParallelCoordSelect, and TVirtualPad.

Definition at line 401 of file TObject.cxx.

◆ GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const
virtual

Return the unique object id.

Definition at line 375 of file TObject.cxx.

◆ HandleTimer()

Bool_t TObject::HandleTimer ( TTimer timer)
virtual

Execute action in response of a timer timing out.

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

Reimplemented in TGWindow, TGuiBldDragManager, TSessionViewer, TGLEventHandler, TGCommandPlugin, TGDNDManager, TGFileContainer, TGPopupMenu, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGHtml, TVirtualPacketizer, TProofPlayerRemote, TProofPlayerSlave, TProofPlayerSuperMaster, TProofPlayerLite, and TTreeViewer.

Definition at line 411 of file TObject.cxx.

◆ Hash()

ULong_t TObject::Hash ( ) const
virtual

Return hash value for this object.

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

void CallRecursiveRemoveIfNeeded(TObject &obj)
call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.
Definition: TROOT.h:395

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.
Mother of all ROOT objects.
Definition: TObject.h:37
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition: TObject.cxx:891
virtual ULong_t Hash() const
Return hash value for this object.
Definition: TObject.cxx:433
void RecursiveRemove(TObject *obj)
Recursively remove this object from the list of Cleanups.
Definition: TROOT.cxx:2429

Reimplemented in TEnvRec, TNamed, TObjString, TParameter< AParamType >, TParameter< Long64_t >, TCollection, TPair, TPad, TImagePlugin, TPave, TGObject, TGPicture, TClassDocInfo, THtml::TFileSysEntry, TStatistic, TDrawFeedback, TStatsFeedback, RooLinkedList, and RooSetPair.

Definition at line 433 of file TObject.cxx.

◆ HasInconsistentHash()

Bool_t TObject::HasInconsistentHash ( ) const
inline

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 345 of file TObject.h.

◆ Info()

void TObject::Info ( const char *  method,
const char *  msgfmt,
  ... 
) const
virtual

Issue info message.

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

Definition at line 865 of file TObject.cxx.

◆ InheritsFrom() [1/2]

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

Returns kTRUE if object inherits from class "classname".

Reimplemented in TClass.

Definition at line 443 of file TObject.cxx.

◆ InheritsFrom() [2/2]

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

Returns kTRUE if object inherits from TClass cl.

Reimplemented in TClass.

Definition at line 451 of file TObject.cxx.

◆ Inspect()

void TObject::Inspect ( ) const
virtual

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 TSystemFile, and TGFrame.

Definition at line 464 of file TObject.cxx.

◆ InvertBit()

void TObject::InvertBit ( UInt_t  f)
inline

Definition at line 189 of file TObject.h.

◆ IsEqual()

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

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 TObjString, TQCommand, TPair, TGObject, and TSlaveInfo.

Definition at line 483 of file TObject.cxx.

◆ IsFolder()

◆ IsOnHeap()

R__ALWAYS_INLINE Bool_t TObject::IsOnHeap ( ) const
inline

Definition at line 148 of file TObject.h.

◆ IsSortable()

◆ IsZombie()

R__ALWAYS_INLINE Bool_t TObject::IsZombie ( ) const
inline

Definition at line 149 of file TObject.h.

◆ ls()

◆ MakeZombie()

void TObject::MakeZombie ( )
inlineprotected

Definition at line 49 of file TObject.h.

◆ MayNotUse()

void TObject::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).

Definition at line 944 of file TObject.cxx.

◆ Notify()

◆ Obsolete()

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

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 953 of file TObject.cxx.

◆ operator delete()

void TObject::operator delete ( void ptr)

Operator delete.

Definition at line 996 of file TObject.cxx.

◆ operator delete[]()

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

Operator delete [].

Definition at line 1007 of file TObject.cxx.

◆ operator new() [1/2]

void * TObject::operator new ( size_t  sz)
inline

Definition at line 167 of file TObject.h.

◆ operator new() [2/2]

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

Definition at line 169 of file TObject.h.

◆ operator new[]() [1/2]

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

Definition at line 168 of file TObject.h.

◆ operator new[]() [2/2]

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

Definition at line 170 of file TObject.h.

◆ operator=()

TObject & TObject::operator= ( const TObject rhs)
inline

TObject assignment operator.

Definition at line 283 of file TObject.h.

◆ Paint()

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

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

Definition at line 519 of file TObject.cxx.

◆ Pop()

void TObject::Pop ( )
virtual

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 TPad, TFrame, and TVirtualPad.

Definition at line 528 of file TObject.cxx.

◆ Print()

void TObject::Print ( Option_t option = "") const
virtual

This method must be overridden when a class wants to print itself.

Reimplemented in RooCmdArg, TPad, TVirtualPad, RooLinkedList, RooStats::HistFactory::EstimateSummary, TObjString, TParameter< AParamType >, TParameter< Long64_t >, TRolke, TAlienJobStatus, TAlienMasterJob, TAlienMasterJobStatus, TGridCollection, TBranchSTL, TGTextEdit, TStreamerInfoActions::TActionSequence, TStatistic, TMVA::TNeuron, TSQLFile, TXMLFile, TGraph, TGraph2D, TGraph2DErrors, TGraphAsymmErrors, TGraphBentErrors, TGraphErrors, TGraphMultiErrors, THStack, TMultiGraph, TBenchmark, TMatrixTBase< Element >, TMatrixTBase< Double_t >, TMatrixTBase< AReal >, TAlienCollection, TGeoDecayChannel, TPluginHandler, TPluginManager, TDecompBase, TDecompBK, TDecompChol, TDecompLU, TDecompQRH, TDecompSparse, TDecompSVD, TQpDataDens, TQpDataSparse, TDatabasePDG, TParticleClassPDG, TParticlePDG, TFTP, TAliEnFind, TProofDesc, TQueryResult, TPrincipal, TProofLog, TProofLogElem, TFoamCell, TFoamVect, TNetFile, TMVA::PDEFoamCell, TMVA::PDEFoamVect, TColor, TEnv, TFileCollection, TInetAddress, TMacro, TMessageHandler, TNamed, TStopwatch, TUri, TUrl, TBits, TClassTable, TCollection, THashTable, TObjectTable, TFunction, TGDMLMatrix, TGeoBranchArray, TGeoElement, TGeoIsotope, TGeoElementRN, TGeoBatemanSol, TGeoElementTable, TGeoMatrix, TGeoOpticalSurface, TGeoSkinSurface, TGeoBorderSurface, TGeoPhysicalNode, TGeoRegion, TGeoTessellated, TGeoVolume, TGeoVoxelFinder, TGeoOverlap, TGeoTrack, TBox, TEllipse, TLegend, TLegendEntry, TLine, TMarker, TPave, TPaveText, TPolyLine, TText, TEveTrans, ROOT::Experimental::REveTrans, THelix, TPolyLine3D, TPolyMarker3D, TXTRU, TGFont, TGFontPool, TGFrame, TGCompositeFrame, TGGC, TGGCPool, TGLayoutHints, TGFrameElement, TGMimeTypes, TGPicture, TGPicturePool, TGWindow, THbookTree, TF1, TFitResult, TFormula, TH1, THnBase, TPolyMarker, ROOT::v5::TFormula, TSpectrum, TSpectrum2, TSpectrum3, TFileCacheRead, TFileCacheWrite, TKey, TMapFile, TZIPFile, TZIPMember, TSQLStructure, TVectorT< Element >, TVectorT< Double_t >, TLorentzVector, TQuaternion, TVector2, TVector3, TQpVar, TAttParticle, TParticle, TPrimary, TAlienResult, TAlienResult, THostAuth, TMonaLisaWriter, TApplicationRemote, TNetFileStager, TSQLColumnInfo, TSQLTableInfo, TXNetFile, TXNetFileStager, TCondorSlave, TCondor, TDSet, TSlaveInfo, TProof, TProofLite, TProofOutputFile, TProofOutputList, TProofProgressStatus, TProofServ, TSlave, TSlaveLite, TProofBenchRunCPU, TProofBenchRunDataRead, TProofNodes, TSelEventGen, TPerfEvent, TStatus, TMVA::Event, TMVA::OptionBase, TMVA::Option< T >, TBranch, TBranchClones, TBranchElement, TBranchObject, TBranchRef, TChain, TEventList, TTree, TTreeCache, TTreeCacheUnzip, TTreeIndex, TTreePerfStats, TParallelCoordVar, TProofBenchRun, TDirectory, TFile, TMemFile, RooStats::ModelConfig, TRootSecContext, TSecContext, TMultiDimFit, TParallelCoordRange, TFileInfo, TFileInfoMeta, TDSetElement, Roo1DTable, RooAbsArg, RooAbsBinning, RooAbsCollection, RooAbsData, RooAbsDataStore, RooAbsGenContext, RooAbsNumGenerator, RooCurve, RooCustomizer, RooEllipse, RooCatType, RooFitResult, RooFormula, RooGenFitStudy, RooGrid, RooHist, RooMsgService, RooNameSet, RooNumGenConfig, RooNumIntConfig, RooPlot, RooSharedProperties, and RooWorkspace.

Definition at line 550 of file TObject.cxx.

◆ Read()

Int_t TObject::Read ( const char *  name)
virtual

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 562 of file TObject.cxx.

◆ RecursiveRemove()

◆ ResetBit()

void TObject::ResetBit ( UInt_t  f)
inline

Definition at line 186 of file TObject.h.

◆ SaveAs()

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

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 independant 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 TSpline, TGeoVolume, TSpline3, TSpline5, TFolder, TClassTree, TPad, TPaveClass, TGObject, TTreePerfStats, and TVirtualPad.

Definition at line 599 of file TObject.cxx.

◆ SavePrimitive()

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

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

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

Definition at line 664 of file TObject.cxx.

◆ SetBit() [1/2]

void TObject::SetBit ( UInt_t  f)
inline

Definition at line 185 of file TObject.h.

◆ SetBit() [2/2]

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

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

Definition at line 694 of file TObject.cxx.

◆ SetDrawOption()

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

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 TSystemDirectory, TSystemFile, TGFrame, TAxis, TBrowser, TPad, TGedFrame, TRootBrowserLite, and RooPlot.

Definition at line 677 of file TObject.cxx.

◆ SetDtorOnly()

void TObject::SetDtorOnly ( void obj)
static

Set destructor only flag.

Definition at line 988 of file TObject.cxx.

◆ SetObjectStat()

void TObject::SetObjectStat ( Bool_t  stat)
static

Turn on/off tracking of objects in the TObjectTable.

Definition at line 972 of file TObject.cxx.

◆ SetUniqueID()

void TObject::SetUniqueID ( UInt_t  uid)
virtual

Set the unique object id.

Definition at line 705 of file TObject.cxx.

◆ SysError()

void TObject::SysError ( const char *  method,
const char *  msgfmt,
  ... 
) const
virtual

Issue system error message.

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

Definition at line 905 of file TObject.cxx.

◆ TestBit()

R__ALWAYS_INLINE Bool_t TObject::TestBit ( UInt_t  f) const
inline

Definition at line 187 of file TObject.h.

◆ TestBits()

Int_t TObject::TestBits ( UInt_t  f) const
inline

Definition at line 188 of file TObject.h.

◆ UseCurrentStyle()

void TObject::UseCurrentStyle ( )
virtual

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

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

Definition at line 715 of file TObject.cxx.

◆ Warning()

void TObject::Warning ( const char *  method,
const char *  msgfmt,
  ... 
) const
virtual

Issue warning message.

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

Definition at line 877 of file TObject.cxx.

◆ Write() [1/2]

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

Write this object to the current directory.

For more see the const version of this method.

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

Definition at line 796 of file TObject.cxx.

◆ Write() [2/2]

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

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 TSQLFile, TXMLFile, TDirectory, TBuffer, TParallelMergingFile, TCollection, TMap, TTree, TFile, and TDirectoryFile.

Definition at line 772 of file TObject.cxx.

Friends And Related Function Documentation

◆ TClonesArray

friend class TClonesArray
friend

Definition at line 228 of file TObject.h.

Member Data Documentation

◆ fBits

UInt_t TObject::fBits
private

bit field status word

Definition at line 41 of file TObject.h.

◆ fgDtorOnly

Long_t TObject::fgDtorOnly = 0
staticprivate

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

Definition at line 43 of file TObject.h.

◆ fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE
staticprivate

if true keep track of objects in TObjectTable

Definition at line 44 of file TObject.h.

◆ fUniqueID

UInt_t TObject::fUniqueID
private

object unique identifier

Definition at line 40 of file TObject.h.


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