Logo ROOT  
Reference Guide
TRecorder Class Reference

Definition at line 422 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 = 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

 TRecorder ()
 Creates initial INACTIVE state for the recorder. More...
 
 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) More...
 
virtual ~TRecorder ()
 Destructor. More...
 
void Browse (TBrowser *)
 Browse the recorder from a ROOT file. More...
 
virtual TRecorder::ERecorderState GetState () const
 Get current state of recorder. More...
 
void ListCmd (const char *filename)
 Prints out recorded commandline events. More...
 
void ListGui (const char *filename)
 Prints out recorded GUI events. More...
 
void Pause ()
 Pauses replaying. More...
 
void PrevCanvases (const char *filename, Option_t *option)
 Save previous canvases in a .root file. More...
 
void Replay ()
 
Bool_t Replay (const char *filename, Bool_t showMouseCursor=kTRUE, TRecorder::EReplayModes mode=kRealtime)
 Replays events from 'filename'. More...
 
void ReplayStop ()
 Cancells replaying. More...
 
void Resume ()
 Resumes replaying. More...
 
void Start (const char *filename, Option_t *option="RECREATE", Window_t *w=0, Int_t winCount=0)
 Starts recording events. More...
 
void Stop (Bool_t guiCommand=kFALSE)
 Stopps recording events. More...
 
- Public Member Functions inherited from TObject
 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...
 

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. More...
 
- 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). More...
 
void MakeZombie ()
 

Protected Attributes

TString fFilename
 

Private Member Functions

 TRecorder (const TRecorder &)
 Current state of recorder. More...
 
TRecorderoperator= (const TRecorder &)
 

Private Attributes

TRecorderStatefRecorderState
 

Friends

class TRecorderInactive
 
class TRecorderPaused
 
class TRecorderRecording
 
class TRecorderReplaying
 
class TRecorderState
 

Additional Inherited Members

- Static Public Member Functions inherited from TObject
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 inherited from TObject
enum  { kOnlyPrepStep = BIT(3) }
 

#include <TRecorder.h>

Inheritance diagram for TRecorder:
[legend]

Member Enumeration Documentation

◆ ERecorderState

Enumerator
kInactive 
kRecording 
kPaused 
kReplaying 

Definition at line 449 of file TRecorder.h.

◆ EReplayModes

Enumerator
kRealtime 

Definition at line 444 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 227 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 238 of file TRecorder.cxx.

◆ ~TRecorder()

TRecorder::~TRecorder ( )
virtual

Destructor.

Definition at line 252 of file TRecorder.cxx.

Member Function Documentation

◆ Browse()

void TRecorder::Browse ( TBrowser )
virtual

Browse the recorder from a ROOT file.

This allows to replay a session from the browser.

Reimplemented from TObject.

Definition at line 261 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 336 of file TRecorder.cxx.

◆ GetState()

TRecorder::ERecorderState TRecorder::GetState ( ) const
virtual

Get current state of recorder.

Definition at line 347 of file TRecorder.cxx.

◆ ListCmd()

void TRecorder::ListCmd ( const char *  filename)

Prints out recorded commandline events.

Definition at line 319 of file TRecorder.cxx.

◆ ListGui()

void TRecorder::ListGui ( const char *  filename)

Prints out recorded GUI events.

Definition at line 327 of file TRecorder.cxx.

◆ operator=()

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

◆ Pause()

void TRecorder::Pause ( )

Pauses replaying.

Definition at line 295 of file TRecorder.cxx.

◆ PrevCanvases()

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

Save previous canvases in a .root file.

Definition at line 356 of file TRecorder.cxx.

◆ Replay() [1/2]

void TRecorder::Replay ( )
inline

Definition at line 475 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 286 of file TRecorder.cxx.

◆ ReplayStop()

void TRecorder::ReplayStop ( )

Cancells replaying.

Definition at line 311 of file TRecorder.cxx.

◆ Resume()

void TRecorder::Resume ( )

Resumes replaying.

Definition at line 303 of file TRecorder.cxx.

◆ Start()

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

Starts recording events.

Definition at line 269 of file TRecorder.cxx.

◆ Stop()

void TRecorder::Stop ( Bool_t  guiCommand = kFALSE)

Stopps recording events.

Definition at line 278 of file TRecorder.cxx.

Friends And Related Function Documentation

◆ TRecorderInactive

friend class TRecorderInactive
friend

Definition at line 432 of file TRecorder.h.

◆ TRecorderPaused

friend class TRecorderPaused
friend

Definition at line 433 of file TRecorder.h.

◆ TRecorderRecording

friend class TRecorderRecording
friend

Definition at line 434 of file TRecorder.h.

◆ TRecorderReplaying

friend class TRecorderReplaying
friend

Definition at line 435 of file TRecorder.h.

◆ TRecorderState

friend class TRecorderState
friend

Definition at line 431 of file TRecorder.h.

Member Data Documentation

◆ fFilename

TString TRecorder::fFilename
protected

Definition at line 437 of file TRecorder.h.

◆ fRecorderState

TRecorderState* TRecorder::fRecorderState
private

Definition at line 425 of file TRecorder.h.

Libraries for TRecorder:
[legend]

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