Stopwatch class.

This class returns the real and cpu time between the start and stop events.

Definition at line 28 of file TStopwatch.h.

Public Member Functions
	TStopwatch ()
	Create a stopwatch and start it.

void	Continue ()
	Resume a stopped stopwatch.

Int_t	Counter () const

Double_t	CpuTime ()
	Stop the stopwatch (if it is running) and return the cputime (in seconds) passed between the start and stop events.

TClass *	IsA () const override

void	Print (Option_t *option="") const override
	Print the real and cpu time passed between the start and stop events.

Double_t	RealTime ()
	Stop the stopwatch (if it is running) and return the realtime (in seconds) passed between the start and stop events.

void	Reset ()

void	ResetCpuTime (Double_t time=0)

void	ResetRealTime (Double_t time=0)

void	Start (Bool_t reset=kTRUE)
	Start the stopwatch.

void	Stop ()
	Stop the stopwatch.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

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

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

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

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

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

virtual void	Delete (Option_t *option="")
	Delete this object.

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

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

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

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

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual const char *	GetName () const
	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 const char *	GetTitle () const
	Returns title of object.

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.

virtual ULong_t	Hash () const
	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.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

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

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

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.

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

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

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete (void ptr, void vp)
	Only called by placement new when throwing an exception.

void	operator delete[] (void *ptr)
	Operator delete [].

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

void *	operator new (size_t sz)

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

void *	operator new[] (size_t sz)

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

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

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

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

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

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

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

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

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

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Private Types
enum	EState { kUndefined , kStopped , kRunning }

Static Private Member Functions
static Double_t	GetCPUTime ()
	Private static method returning system CPU time.

static Double_t	GetRealTime ()
	Private static method returning system realtime.

Private Attributes
Int_t	fCounter

Double_t	fStartCpuTime

Double_t	fStartRealTime

EState	fState

Double_t	fStopCpuTime

Double_t	fStopRealTime

Double_t	fTotalCpuTime

Double_t	fTotalRealTime

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

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

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

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

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

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

#include <TStopwatch.h>

Inheritance diagram for TStopwatch:

[legend]

Member Enumeration Documentation

◆ EState

enum TStopwatch::EState

private

Enumerator
kUndefined
kStopped
kRunning

Definition at line 31 of file TStopwatch.h.

Constructor & Destructor Documentation

◆ TStopwatch()

TStopwatch::TStopwatch ( )

Create a stopwatch and start it.

Definition at line 39 of file TStopwatch.cxx.

Member Function Documentation

◆ Class()

static TClass * TStopwatch::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TStopwatch::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TStopwatch::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 58 of file TStopwatch.h.

◆ Continue()

void TStopwatch::Continue ( )

Resume a stopped stopwatch.

The stopwatch continues counting from the last Start() onwards (this is like the laptimer function).

Definition at line 93 of file TStopwatch.cxx.

◆ Counter()

Int_t TStopwatch::Counter ( ) const

inline

Definition at line 50 of file TStopwatch.h.

◆ CpuTime()

Double_t TStopwatch::CpuTime ( )

Stop the stopwatch (if it is running) and return the cputime (in seconds) passed between the start and stop events.

Definition at line 125 of file TStopwatch.cxx.

◆ DeclFileName()

static const char * TStopwatch::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 58 of file TStopwatch.h.

◆ GetCPUTime()

Double_t TStopwatch::GetCPUTime ( )

staticprivate

Private static method returning system CPU time.

Definition at line 158 of file TStopwatch.cxx.

◆ GetRealTime()

Double_t TStopwatch::GetRealTime ( )

staticprivate

Private static method returning system realtime.

Definition at line 139 of file TStopwatch.cxx.

◆ IsA()

TClass * TStopwatch::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 58 of file TStopwatch.h.

◆ Print()

void TStopwatch::Print ( Option_t * opt = "" ) const

overridevirtual

Print the real and cpu time passed between the start and stop events.

and the number of times (slices) this TStopwatch was called (if this number > 1). If opt="m" print out realtime in milli second precision. If opt="u" print out realtime in micro second precision.

Reimplemented from TObject.

Definition at line 219 of file TStopwatch.cxx.

◆ RealTime()

Double_t TStopwatch::RealTime ( )

Stop the stopwatch (if it is running) and return the realtime (in seconds) passed between the start and stop events.

Definition at line 110 of file TStopwatch.cxx.

◆ Reset()

void TStopwatch::Reset ( void )

inline

Definition at line 52 of file TStopwatch.h.

◆ ResetCpuTime()

void TStopwatch::ResetCpuTime ( Double_t time = 0 )

inline

Definition at line 53 of file TStopwatch.h.

◆ ResetRealTime()

void TStopwatch::ResetRealTime ( Double_t time = 0 )

inline

Definition at line 54 of file TStopwatch.h.

◆ Start()

void TStopwatch::Start ( Bool_t reset = kTRUE )

Start the stopwatch.

If reset is kTRUE reset the stopwatch before starting it (including the stopwatch counter). Use kFALSE to continue timing after a Stop() without resetting the stopwatch.

Definition at line 58 of file TStopwatch.cxx.

◆ Stop()

void TStopwatch::Stop ( )

Stop the stopwatch.

Definition at line 77 of file TStopwatch.cxx.

◆ Streamer()

void TStopwatch::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TStopwatch::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 58 of file TStopwatch.h.

Member Data Documentation

◆ fCounter

Int_t TStopwatch::fCounter

private

Definition at line 40 of file TStopwatch.h.

◆ fStartCpuTime

Double_t TStopwatch::fStartCpuTime

private

Definition at line 35 of file TStopwatch.h.

◆ fStartRealTime

Double_t TStopwatch::fStartRealTime

private

Definition at line 33 of file TStopwatch.h.

◆ fState

EState TStopwatch::fState

private

Definition at line 39 of file TStopwatch.h.

◆ fStopCpuTime

Double_t TStopwatch::fStopCpuTime

private

Definition at line 36 of file TStopwatch.h.

◆ fStopRealTime

Double_t TStopwatch::fStopRealTime

private

Definition at line 34 of file TStopwatch.h.

◆ fTotalCpuTime

Double_t TStopwatch::fTotalCpuTime

private

Definition at line 37 of file TStopwatch.h.

◆ fTotalRealTime

Double_t TStopwatch::fTotalRealTime

private

Definition at line 38 of file TStopwatch.h.

Libraries for TStopwatch:

[legend]

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

core/base/inc/TStopwatch.h
core/base/src/TStopwatch.cxx

Public Member Functions

Static Public Member Functions

Private Types

Static Private Member Functions

Private Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ EState

Constructor & Destructor Documentation

◆ TStopwatch()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Continue()

◆ Counter()

◆ CpuTime()

◆ DeclFileName()

◆ GetCPUTime()

◆ GetRealTime()

◆ IsA()

◆ Print()

◆ RealTime()

◆ Reset()

◆ ResetCpuTime()

◆ ResetRealTime()

◆ Start()

◆ Stop()

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ fCounter

◆ fStartCpuTime

◆ fStartRealTime

◆ fState

◆ fStopCpuTime

◆ fStopRealTime

◆ fTotalCpuTime

◆ fTotalRealTime