Class provides direct recorder/replayer interface for a user.

See 'ROOT EVENT RECORDING SYSTEM' for more information about usage.

Implementation uses C++ design pattern State. Functionality of recorder is divided into 4 classes according to the current state of recorder.

Internally, there is a pointer to TRecorderState object. This object changes whenever state of recorder is changed. States of recorder are the following:

INACTIVE Implemented in TRecorderInactive class. Default state after TRecorder object is created.
RECORDING Implemented in TRecorderRecording class.
REPLAYING Implemented in TRecorderReplaying class.
PAUSED Implemented in TRecorderPause class. Pause of replaying.

Every command for TRecorder is just passed to TRecordeState object. Depending on the current state of recorder, this command is passed to some of the above mentioned classes and if valid, handled there.

Switching between states is not possible from outside. States are switched directly by state objects via:

ChangeState(TRecorderState* newstate, Bool_t deletePreviousState);

When recorder is switched to a new state, the old state object is typically deleted. The only exception is switching from REPLAYING state to PAUSED state. The previous state (REPLAYING) is not deleted in order to be used again after TRecorder::Resume call.

STATE TRANSITIONS:

INACTIVE -> RECORDING via TRecorder::Start (Starts recording)
RECORDING -> INACTIVE via TRecorder::Stop (Stops recording)
INACTIVE -> REPLAYING via TRecorder::Replay (Starts replaying)
REPLAYING -> INACTIVE via TRecorder::ReplayStop (Stops replaying)
REPLAYING -> PAUSED via TRecorder::Pause (Pause replaying)
PAUSED -> REPLAYING via TRecorder::Resume (Resumes replaying)
PAUSED -> INACTIVE via TRecorder::ReplayStop (Stops paused replaying)

Definition at line 265 of file TRecorder.h.

Public Types
enum	ERecorderState { kInactive , kRecording , kPaused , kReplaying }

enum	EReplayModes { kRealtime }

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

Public Member Functions
	TRecorder ()
	Creates initial INACTIVE state for the recorder.

	TRecorder (const char filename, Option_t option="READ")
	Creates a recorder with filename to replay or to record, depending on option (NEW or RECREATE will start recording, READ will start replaying)

	~TRecorder () override
	Destructor.

void	Browse (TBrowser *) override
	Browse the recorder from a ROOT file.

virtual TRecorder::ERecorderState	GetState () const
	Get current state of recorder.

TClass *	IsA () const override

void	ListCmd (const char *filename)
	Prints out recorded commandline events.

void	ListGui (const char *filename)
	Prints out recorded GUI events.

void	Pause ()
	Pauses replaying.

void	PrevCanvases (const char filename, Option_t option)
	Save previous canvases in a .root file.

void	Replay ()

Bool_t	Replay (const char *filename, Bool_t showMouseCursor=kTRUE, TRecorder::EReplayModes mode=kRealtime)
	Replays events from 'filename'.

void	ReplayStop ()
	Cancels replaying.

void	Resume ()
	Resumes replaying.

void	Start (const char filename, Option_t option="RECREATE", Window_t *w=nullptr, Int_t winCount=0)
	Starts recording events.

void	Stop (Bool_t guiCommand=kFALSE)
	Stopps recording events.

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.

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)
	Operator delete [].

void *	operator new (size_t sz)

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

void *	operator new[] (size_t sz)

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

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

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

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

virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself.

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.

Protected Member Functions
void	ChangeState (TRecorderState *newstate, Bool_t deletePreviousState=kTRUE)
	Changes state from the current to the passed one (newstate) Deletes the old state if delPreviousState = KTRUE.

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

Protected Attributes
TString	fFilename

Private Member Functions
	TRecorder (const TRecorder &)
	Current state of recorder.

TRecorder &	operator= (const TRecorder &)

Private Attributes
TRecorderState *	fRecorderState

Friends
class	TRecorderInactive

class	TRecorderPaused

class	TRecorderRecording

class	TRecorderReplaying

class	TRecorderState

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

#include <TRecorder.h>

Inheritance diagram for TRecorder:

[legend]

Member Enumeration Documentation

◆ ERecorderState

enum TRecorder::ERecorderState

Enumerator
kInactive
kRecording
kPaused
kReplaying

Definition at line 292 of file TRecorder.h.

◆ EReplayModes

enum TRecorder::EReplayModes

Enumerator
kRealtime

Definition at line 287 of file TRecorder.h.

Constructor & Destructor Documentation

◆ TRecorder() [1/3]

TRecorder::TRecorder ( const TRecorder & )

private

Current state of recorder.

◆ TRecorder() [2/3]

TRecorder::TRecorder ( )

Creates initial INACTIVE state for the recorder.

Definition at line 179 of file TRecorder.cxx.

◆ TRecorder() [3/3]

TRecorder::TRecorder	(	const char *	filename,
		Option_t *	option = `"READ"`
	)

Creates a recorder with filename to replay or to record, depending on option (NEW or RECREATE will start recording, READ will start replaying)

Definition at line 190 of file TRecorder.cxx.

◆ ~TRecorder()

TRecorder::~TRecorder ( )

override

Destructor.

Definition at line 204 of file TRecorder.cxx.

Member Function Documentation

◆ Browse()

void TRecorder::Browse ( TBrowser * )

overridevirtual

Browse the recorder from a ROOT file.

This allows to replay a session from the browser.

Reimplemented from TObject.

Definition at line 213 of file TRecorder.cxx.

◆ ChangeState()

void TRecorder::ChangeState	(	TRecorderState *	newstate,
		Bool_t	deletePreviousState = `kTRUE`
	)

protected

Changes state from the current to the passed one (newstate) Deletes the old state if delPreviousState = KTRUE.

Definition at line 288 of file TRecorder.cxx.

◆ Class()

static TClass * TRecorder::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TRecorder::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TRecorder::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 341 of file TRecorder.h.

◆ DeclFileName()

static const char * TRecorder::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 341 of file TRecorder.h.

◆ GetState()

TRecorder::ERecorderState TRecorder::GetState ( ) const

virtual

Get current state of recorder.

Definition at line 299 of file TRecorder.cxx.

◆ IsA()

TClass * TRecorder::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 341 of file TRecorder.h.

◆ ListCmd()

void TRecorder::ListCmd ( const char * filename )

Prints out recorded commandline events.

Definition at line 271 of file TRecorder.cxx.

◆ ListGui()

void TRecorder::ListGui ( const char * filename )

Prints out recorded GUI events.

Definition at line 279 of file TRecorder.cxx.

◆ operator=()

TRecorder & TRecorder::operator= ( const TRecorder & )

private

◆ Pause()

void TRecorder::Pause ( )

Pauses replaying.

Definition at line 247 of file TRecorder.cxx.

◆ PrevCanvases()

void TRecorder::PrevCanvases	(	const char *	filename,
		Option_t *	option
	)

Save previous canvases in a .root file.

Definition at line 308 of file TRecorder.cxx.

◆ Replay() [1/2]

void TRecorder::Replay ( )

inline

Definition at line 318 of file TRecorder.h.

◆ Replay() [2/2]

Bool_t TRecorder::Replay	(	const char *	filename,
		Bool_t	showMouseCursor = `kTRUE`,
		TRecorder::EReplayModes	mode = `kRealtime`
	)

Replays events from 'filename'.

Definition at line 238 of file TRecorder.cxx.

◆ ReplayStop()

void TRecorder::ReplayStop ( )

Cancels replaying.

Definition at line 263 of file TRecorder.cxx.

◆ Resume()

void TRecorder::Resume ( )

Resumes replaying.

Definition at line 255 of file TRecorder.cxx.

◆ Start()

void TRecorder::Start	(	const char *	filename,
		Option_t *	option = `"RECREATE"`,
		Window_t *	w = `nullptr`,
		Int_t	winCount = `0`
	)

Starts recording events.

Definition at line 221 of file TRecorder.cxx.

◆ Stop()

void TRecorder::Stop ( Bool_t guiCommand = kFALSE )

Stopps recording events.

Definition at line 230 of file TRecorder.cxx.

◆ Streamer()

void TRecorder::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TRecorder::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 341 of file TRecorder.h.

Friends And Related Symbol Documentation

◆ TRecorderInactive

friend class TRecorderInactive

friend

Definition at line 275 of file TRecorder.h.

◆ TRecorderPaused

friend class TRecorderPaused

friend

Definition at line 276 of file TRecorder.h.

◆ TRecorderRecording

friend class TRecorderRecording

friend

Definition at line 277 of file TRecorder.h.

◆ TRecorderReplaying

friend class TRecorderReplaying

friend

Definition at line 278 of file TRecorder.h.

◆ TRecorderState

friend class TRecorderState

friend

Definition at line 274 of file TRecorder.h.

Member Data Documentation

◆ fFilename

TString TRecorder::fFilename

protected

Definition at line 280 of file TRecorder.h.

◆ fRecorderState

TRecorderState* TRecorder::fRecorderState

private

Definition at line 268 of file TRecorder.h.

Libraries for TRecorder:

[legend]

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

gui/recorder/inc/TRecorder.h
gui/recorder/src/TRecorder.cxx

STATE TRANSITIONS:

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Enumeration Documentation

◆ ERecorderState

◆ EReplayModes

Constructor & Destructor Documentation

◆ TRecorder() [1/3]

◆ TRecorder() [2/3]

◆ TRecorder() [3/3]

◆ ~TRecorder()

Member Function Documentation

◆ Browse()

◆ ChangeState()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ GetState()

◆ IsA()

◆ ListCmd()

◆ ListGui()

◆ operator=()

◆ Pause()

◆ PrevCanvases()

◆ Replay() [1/2]

◆ Replay() [2/2]

◆ ReplayStop()

◆ Resume()

◆ Start()

◆ Stop()

◆ Streamer()

◆ StreamerNVirtual()

Friends And Related Symbol Documentation

◆ TRecorderInactive

◆ TRecorderPaused

◆ TRecorderRecording

◆ TRecorderReplaying

◆ TRecorderState

Member Data Documentation

◆ fFilename

◆ fRecorderState