Logo ROOT   6.21/01
Reference Guide
TProofPlayer Class Reference

Internal class steering processing in PROOF.

Instances of the TProofPlayer class are created on the worker nodes per session and do the processing. Instances of its subclass - TProofPlayerRemote are created per each query on the master(s) and on the client. On the master(s), TProofPlayerRemote coordinate processing, check the dataset, create the packetizer and take care of merging the results of the workers. The instance on the client collects information on the input (dataset and selector), it invokes the Begin() method and finalizes the query by calling Terminate().

Definition at line 60 of file TProofPlayer.h.

Classes

class  TCleanup
 

Public Types

enum  EStatusBits { kDispatchOneEvent = BIT(15), kIsProcessing = BIT(16), kMaxProcTimeReached = BIT(17), kMaxProcTimeExtended = BIT(18) }
 
- Public Types inherited from TVirtualProofPlayer
enum  EExitStatus { kFinished, kStopped, kAborted }
 
enum  EStatusBits { kIsSubmerger = BIT(14) }
 
- 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

 TProofPlayer (TProof *proof=0)
 Default ctor. More...
 
virtual ~TProofPlayer ()
 Destructor. More...
 
void AddEventsProcessed (Long64_t ev)
 
void AddInput (TObject *inp)
 Add object to input list. More...
 
void AddOutput (TList *out)
 Incorporate output list (may not be used in this class). More...
 
Int_t AddOutputObject (TObject *obj)
 Incorporate output object (may not be used in this class). More...
 
void AddQueryResult (TQueryResult *q)
 Add query result to the list, making sure that there are no duplicates. More...
 
void ClearInput ()
 Clear input list. More...
 
TDrawFeedbackCreateDrawFeedback (TProof *p)
 Draw feedback creation proxy. More...
 
void DeleteDrawFeedback (TDrawFeedback *f)
 Delete draw feedback object. More...
 
Long64_t DrawSelect (TDSet *set, const char *varexp, const char *selection, Option_t *option="", Long64_t nentries=-1, Long64_t firstentry=0)
 Draw (may not be used in this class). More...
 
void Feedback (TList *objs)
 Set feedback list (may not be used in this class). More...
 
void FeedBackCanvas (const char *name, Bool_t create)
 Create/destroy a named canvas for feedback. More...
 
Long64_t Finalize (Bool_t force=kFALSE, Bool_t sync=kFALSE)
 Finalize query (may not be used in this class). More...
 
Long64_t Finalize (TQueryResult *qr)
 Finalize query (may not be used in this class). More...
 
Long64_t GetCacheSize ()
 Return the size in bytes of the cache. More...
 
TQueryResultGetCurrentQuery () const
 
Int_t GetDrawArgs (const char *var, const char *sel, Option_t *opt, TString &selector, TString &objname)
 Parse the arguments from var, sel and opt and fill the selector and object name accordingly. More...
 
Long64_t GetEventsProcessed () const
 
EExitStatus GetExitStatus () const
 
TListGetInputList () const
 
Int_t GetLearnEntries ()
 Return the number of entries in the learning phase. More...
 
TListGetListOfResults () const
 
TDSetElementGetNextPacket (TSlave *slave, TMessage *r)
 Get next packet (may not be used in this class). More...
 
TObjectGetOutput (const char *name) const
 Get output object by name. More...
 
TListGetOutputList () const
 Get output list. More...
 
TVirtualPacketizerGetPacketizer () const
 
TProofProgressStatusGetProgressStatus () const
 
TQueryResultGetQueryResult (const char *ref)
 Get query result instances referenced 'ref' from the list of results. More...
 
void HandleGetTreeHeader (TMessage *mess)
 Handle tree header request. More...
 
void HandleRecvHisto (TMessage *mess)
 Receive histo from slave. More...
 
Bool_t IsClient () const
 
virtual Bool_t JoinProcess (TList *workers)
 Not implemented: meaningful only in the remote player. Returns kFALSE. More...
 
Long64_t Process (TDSet *set, const char *selector, Option_t *option="", Long64_t nentries=-1, Long64_t firstentry=0)
 Process specified TDSet on PROOF worker. More...
 
Long64_t Process (TDSet *set, TSelector *selector, Option_t *option="", Long64_t nentries=-1, Long64_t firstentry=0)
 Process specified TDSet on PROOF worker with TSelector object The return value is -1 in case of error and TSelector::GetStatus() in case of success. More...
 
void Progress (Long64_t total, Long64_t processed)
 Report progress (may not be used in this class). More...
 
void Progress (TSlave *, Long64_t total, Long64_t processed)
 
void Progress (Long64_t total, Long64_t processed, Long64_t bytesread, Float_t initTime, Float_t procTime, Float_t evtrti, Float_t mbrti)
 Report progress (may not be used in this class). More...
 
void Progress (TSlave *, Long64_t total, Long64_t processed, Long64_t bytesread, Float_t initTime, Float_t procTime, Float_t evtrti, Float_t mbrti)
 
void Progress (TProofProgressInfo *pi)
 Report progress (may not be used in this class). More...
 
void Progress (TSlave *, TProofProgressInfo *pi)
 
Int_t ReinitSelector (TQueryResult *qr)
 Reinitialize fSelector using the selector files in the query result. More...
 
void RemoveQueryResult (const char *ref)
 Remove all query result instances referenced 'ref' from the list of results. More...
 
void RestorePreviousQuery ()
 
Int_t SavePartialResults (Bool_t queryend=kFALSE, Bool_t force=kFALSE)
 Save the partial results of this query to a dedicated file under the user data directory. More...
 
void SetCurrentQuery (TQueryResult *q)
 Set current query and save previous value. More...
 
void SetDispatchTimer (Bool_t on=kTRUE)
 Enable/disable the timer to dispatch pening events while processing. More...
 
void SetDrawFeedbackOption (TDrawFeedback *f, Option_t *opt)
 Set draw feedback option. More...
 
void SetExitStatus (EExitStatus st)
 
virtual void SetInitTime ()
 
void SetMaxDrawQueries (Int_t max)
 
virtual void SetMerging (Bool_t=kTRUE)
 
void SetOutputFilePath (const char *fp)
 
void SetProcessing (Bool_t on=kTRUE)
 Set processing bit according to 'on'. More...
 
void SetStopTimer (Bool_t on=kTRUE, Bool_t abort=kFALSE, Int_t timeout=0)
 Enable/disable the timer to stop/abort processing. More...
 
virtual void StopFeedback ()
 Stop feedback (may not be used in this class). More...
 
void StopProcess (Bool_t abort, Int_t timeout=-1)
 Stop the process after this event. More...
 
void StoreFeedback (TObject *slave, TList *out)
 Store feedback list (may not be used in this class). More...
 
void StoreOutput (TList *out)
 Store output list (may not be used in this class). More...
 
void UpdateAutoBin (const char *name, Double_t &xmin, Double_t &xmax, Double_t &ymin, Double_t &ymax, Double_t &zmin, Double_t &zmax)
 Update automatic binning parameters for given object "name". More...
 
void UpdateProgressInfo ()
 Update fProgressStatus. More...
 
- Public Member Functions inherited from TVirtualProofPlayer
 TVirtualProofPlayer ()
 
virtual ~TVirtualProofPlayer ()
 
- 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, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
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...
 
- Public Member Functions inherited from TQObject
 TQObject ()
 TQObject Constructor. More...
 
virtual ~TQObject ()
 TQObject Destructor. More...
 
Bool_t AreSignalsBlocked () const
 
Bool_t BlockSignals (Bool_t b)
 
virtual void ChangedBy (const char *method)
 
void CollectClassSignalLists (TList &list, TClass *cls)
 Collect class signal lists from class cls and all its base-classes. More...
 
Bool_t Connect (const char *signal, const char *receiver_class, void *receiver, const char *slot)
 Non-static method is used to connect from the signal of this object to the receiver slot. More...
 
virtual void Connected (const char *)
 
virtual void Destroyed ()
 
Bool_t Disconnect (const char *signal=0, void *receiver=0, const char *slot=0)
 Disconnects signal of this object from slot of receiver. More...
 
virtual void Disconnected (const char *)
 
template<typename T >
void Emit (const char *signal, const T &arg)
 Activate signal with single parameter. More...
 
void Emit (const char *signal)
 Acitvate signal without args. More...
 
template<typename... T>
void EmitVA (const char *signal_name, Int_t, const T &... params)
 Emit a signal with a varying number of arguments. More...
 
TListGetListOfClassSignals () const
 Returns pointer to list of signals of this class. More...
 
TListGetListOfConnections () const
 
TListGetListOfSignals () const
 
virtual Bool_t HasConnection (const char *signal_name) const
 Return true if there is any object connected to this signal. More...
 
virtual void HighPriority (const char *signal_name, const char *slot_name=0)
 
virtual void LowPriority (const char *signal_name, const char *slot_name=0)
 
virtual void Message (const char *msg)
 
virtual Int_t NumberOfConnections () const
 Return number of connections for this object. More...
 
virtual Int_t NumberOfSignals () const
 Return number of signals for this object. More...
 

Protected Member Functions

Int_t AssertSelector (const char *selector_file)
 Make sure that a valid selector object Return -1 in case of problems, 0 otherwise. More...
 
Bool_t CheckMemUsage (Long64_t &mfreq, Bool_t &w80r, Bool_t &w80v, TString &wmsg)
 Check the memory usage, if requested. More...
 
virtual Int_t DrawCanvas (TObject *obj)
 Draw the object if it is a canvas. More...
 
voidGetSender ()
 
void MapOutputListToDataMembers () const
 
virtual void MergeOutput (Bool_t savememvalues=kFALSE)
 Merge output (may not be used in this class). More...
 
virtual void SetupFeedback ()
 Set up feedback (may not be used in this class). 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 Member Functions inherited from TQObject
virtual const char * GetSenderClassName () const
 

Protected Attributes

Bool_t fCreateSelObj
 the latest selector More...
 
TTimerfDispatchTimer
 
Int_t fDrawQueries
 
TEventIterfEvIter
 period (ms) for sending intermediate results More...
 
EExitStatus fExitStatus
 status of query in progress More...
 
Long_t fFeedbackPeriod
 timer for sending intermediate results More...
 
TTimerfFeedbackTimer
 class of the latest selector More...
 
TListfInput
 
Int_t fMaxDrawQueries
 
THashListfOutput
 
TFilefOutputFile
 
TString fOutputFilePath
 
TQueryResultfPreviousQuery
 
Long64_t fProcessedRun
 Read calls in this run. More...
 
TStopwatchfProcTime
 
TTimerfProcTimeTimer
 
TProofProgressStatusfProgressStatus
 
TQueryResultfQuery
 
TListfQueryResults
 Events processed in this run. More...
 
Long64_t fReadBytesRun
 
Long64_t fReadCallsRun
 Bytes read in this run. More...
 
Long_t fSaveMemThreshold
 
Bool_t fSavePartialResults
 
Bool_t fSaveResultsPerPacket
 
TSelectorfSelector
 
TClassfSelectorClass
 kTRUE when fSelector has been created locally More...
 
TStatusfSelStatus
 iterator on events or objects More...
 
TTimerfStopTimer
 
std::mutex fStopTimerMtx
 
Long64_t fTotalEvents
 
- Protected Attributes inherited from TQObject
TListfListOfConnections
 list of signals from this object More...
 
TListfListOfSignals
 
Bool_t fSignalsBlocked
 list of connections to this object More...
 

Static Protected Attributes

static THashListfgDrawInputPars = 0
 
- Static Protected Attributes inherited from TQObject
static Bool_t fgAllSignalsBlocked = kFALSE
 flag used for suppression of signals More...
 

Private Attributes

TListfAutoBins
 

Additional Inherited Members

- Static Public Member Functions inherited from TVirtualProofPlayer
static TVirtualProofPlayerCreate (const char *player, TProof *p, TSocket *s=0)
 Create a PROOF player. More...
 
- 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...
 
- Static Public Member Functions inherited from TQObject
static Bool_t AreAllSignalsBlocked ()
 Returns true if all signals are blocked. More...
 
static Bool_t BlockAllSignals (Bool_t b)
 Block or unblock all signals. Returns the previous block status. More...
 
static Bool_t Connect (TQObject *sender, const char *signal, const char *receiver_class, void *receiver, const char *slot)
 Create connection between sender and receiver. More...
 
static Bool_t Connect (const char *sender_class, const char *signal, const char *receiver_class, void *receiver, const char *slot)
 This method allows to make a connection from any object of the same class to a single slot. More...
 
static Bool_t Disconnect (TQObject *sender, const char *signal=0, void *receiver=0, const char *slot=0)
 Disconnects signal in object sender from slot_method in object receiver. More...
 
static Bool_t Disconnect (const char *class_name, const char *signal, void *receiver=0, const char *slot=0)
 Disconnects "class signal". More...
 
- Static Protected Member Functions inherited from TQObject
static Int_t CheckConnectArgs (TQObject *sender, TClass *sender_class, const char *signal, TClass *receiver_class, const char *slot)
 Checking of consitency of sender/receiver methods/arguments. More...
 
static TString CompressName (const char *method_name)
 Removes "const" words and blanks from full (with prototype) method name and resolve any typedefs in the method signature. More...
 
static Bool_t ConnectToClass (TQObject *sender, const char *signal, TClass *receiver_class, void *receiver, const char *slot)
 Create connection between sender and receiver. More...
 
static Bool_t ConnectToClass (const char *sender_class, const char *signal, TClass *receiver_class, void *receiver, const char *slot)
 This method allows to make connection from any object of the same class to the receiver object. More...
 

#include <TProofPlayer.h>

Inheritance diagram for TProofPlayer:
[legend]

Member Enumeration Documentation

◆ EStatusBits

Enumerator
kDispatchOneEvent 
kIsProcessing 
kMaxProcTimeReached 
kMaxProcTimeExtended 

Definition at line 131 of file TProofPlayer.h.

Constructor & Destructor Documentation

◆ TProofPlayer()

TProofPlayer::TProofPlayer ( TProof proof = 0)

Default ctor.

Definition at line 227 of file TProofPlayer.cxx.

◆ ~TProofPlayer()

TProofPlayer::~TProofPlayer ( )
virtual

Destructor.

Definition at line 257 of file TProofPlayer.cxx.

Member Function Documentation

◆ AddEventsProcessed()

void TProofPlayer::AddEventsProcessed ( Long64_t  ev)
inlinevirtual

Implements TVirtualProofPlayer.

Definition at line 207 of file TProofPlayer.h.

◆ AddInput()

void TProofPlayer::AddInput ( TObject inp)
virtual

Add object to input list.

Implements TVirtualProofPlayer.

Definition at line 461 of file TProofPlayer.cxx.

◆ AddOutput()

void TProofPlayer::AddOutput ( TList out)
virtual

Incorporate output list (may not be used in this class).

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerRemote.

Definition at line 674 of file TProofPlayer.cxx.

◆ AddOutputObject()

Int_t TProofPlayer::AddOutputObject ( TObject obj)
virtual

Incorporate output object (may not be used in this class).

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerRemote.

Definition at line 665 of file TProofPlayer.cxx.

◆ AddQueryResult()

void TProofPlayer::AddQueryResult ( TQueryResult q)
virtual

Add query result to the list, making sure that there are no duplicates.

Implements TVirtualProofPlayer.

Definition at line 348 of file TProofPlayer.cxx.

◆ AssertSelector()

Int_t TProofPlayer::AssertSelector ( const char *  selector_file)
protected

Make sure that a valid selector object Return -1 in case of problems, 0 otherwise.

Definition at line 967 of file TProofPlayer.cxx.

◆ CheckMemUsage()

Bool_t TProofPlayer::CheckMemUsage ( Long64_t mfreq,
Bool_t w80r,
Bool_t w80v,
TString wmsg 
)
protected

Check the memory usage, if requested.

Return kTRUE if OK, kFALSE if above 95% of at least one between virtual or resident limits are depassed.

Definition at line 1513 of file TProofPlayer.cxx.

◆ ClearInput()

void TProofPlayer::ClearInput ( )
virtual

Clear input list.

Implements TVirtualProofPlayer.

Definition at line 469 of file TProofPlayer.cxx.

◆ CreateDrawFeedback()

TDrawFeedback * TProofPlayer::CreateDrawFeedback ( TProof p)
virtual

Draw feedback creation proxy.

When accessed via TProof avoids link dependency on libProofPlayer.

Implements TVirtualProofPlayer.

Definition at line 734 of file TProofPlayer.cxx.

◆ DeleteDrawFeedback()

void TProofPlayer::DeleteDrawFeedback ( TDrawFeedback f)
virtual

Delete draw feedback object.

Implements TVirtualProofPlayer.

Definition at line 751 of file TProofPlayer.cxx.

◆ DrawCanvas()

Int_t TProofPlayer::DrawCanvas ( TObject obj)
protectedvirtual

Draw the object if it is a canvas.

Return 0 in case of success, 1 if it is not a canvas or libProofDraw is not available.

Definition at line 1697 of file TProofPlayer.cxx.

◆ DrawSelect()

Long64_t TProofPlayer::DrawSelect ( TDSet set,
const char *  varexp,
const char *  selection,
Option_t option = "",
Long64_t  nentries = -1,
Long64_t  firstentry = 0 
)
virtual

Draw (may not be used in this class).

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerRemote.

Definition at line 1659 of file TProofPlayer.cxx.

◆ Feedback()

void TProofPlayer::Feedback ( TList objs)
virtual

Set feedback list (may not be used in this class).

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerRemote.

Definition at line 725 of file TProofPlayer.cxx.

◆ FeedBackCanvas()

void TProofPlayer::FeedBackCanvas ( const char *  name,
Bool_t  create 
)

Create/destroy a named canvas for feedback.

Definition at line 1766 of file TProofPlayer.cxx.

◆ Finalize() [1/2]

Long64_t TProofPlayer::Finalize ( Bool_t  force = kFALSE,
Bool_t  sync = kFALSE 
)
virtual

Finalize query (may not be used in this class).

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerRemote, and TProofPlayerLite.

Definition at line 1572 of file TProofPlayer.cxx.

◆ Finalize() [2/2]

Long64_t TProofPlayer::Finalize ( TQueryResult qr)
virtual

Finalize query (may not be used in this class).

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerRemote, and TProofPlayerLite.

Definition at line 1581 of file TProofPlayer.cxx.

◆ GetCacheSize()

Long64_t TProofPlayer::GetCacheSize ( )
virtual

Return the size in bytes of the cache.

Implements TVirtualProofPlayer.

Definition at line 1797 of file TProofPlayer.cxx.

◆ GetCurrentQuery()

TQueryResult* TProofPlayer::GetCurrentQuery ( ) const
inlinevirtual

Implements TVirtualProofPlayer.

Definition at line 164 of file TProofPlayer.h.

◆ GetDrawArgs()

Int_t TProofPlayer::GetDrawArgs ( const char *  var,
const char *  sel,
Option_t opt,
TString selector,
TString objname 
)
virtual

Parse the arguments from var, sel and opt and fill the selector and object name accordingly.

Return 0 in case of success, 1 if libProofDraw is not available.

Implements TVirtualProofPlayer.

Definition at line 1731 of file TProofPlayer.cxx.

◆ GetEventsProcessed()

Long64_t TProofPlayer::GetEventsProcessed ( ) const
inlinevirtual

Implements TVirtualProofPlayer.

Definition at line 206 of file TProofPlayer.h.

◆ GetExitStatus()

EExitStatus TProofPlayer::GetExitStatus ( ) const
inlinevirtual

Implements TVirtualProofPlayer.

Definition at line 205 of file TProofPlayer.h.

◆ GetInputList()

TList* TProofPlayer::GetInputList ( ) const
inlinevirtual

Implements TVirtualProofPlayer.

Definition at line 161 of file TProofPlayer.h.

◆ GetLearnEntries()

Int_t TProofPlayer::GetLearnEntries ( )
virtual

Return the number of entries in the learning phase.

Implements TVirtualProofPlayer.

Definition at line 1806 of file TProofPlayer.cxx.

◆ GetListOfResults()

TList* TProofPlayer::GetListOfResults ( ) const
inlinevirtual

Implements TVirtualProofPlayer.

Definition at line 162 of file TProofPlayer.h.

◆ GetNextPacket()

TDSetElement * TProofPlayer::GetNextPacket ( TSlave slave,
TMessage r 
)
virtual

Get next packet (may not be used in this class).

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerRemote.

Definition at line 1634 of file TProofPlayer.cxx.

◆ GetOutput()

TObject * TProofPlayer::GetOutput ( const char *  name) const
virtual

Get output object by name.

Implements TVirtualProofPlayer.

Definition at line 477 of file TProofPlayer.cxx.

◆ GetOutputList()

TList * TProofPlayer::GetOutputList ( ) const
virtual

Get output list.

Implements TVirtualProofPlayer.

Definition at line 487 of file TProofPlayer.cxx.

◆ GetPacketizer()

TVirtualPacketizer* TProofPlayer::GetPacketizer ( ) const
inlinevirtual

Reimplemented from TVirtualProofPlayer.

Reimplemented in TProofPlayerRemote.

Definition at line 144 of file TProofPlayer.h.

◆ GetProgressStatus()

TProofProgressStatus* TProofPlayer::GetProgressStatus ( ) const
inlinevirtual

Implements TVirtualProofPlayer.

Definition at line 224 of file TProofPlayer.h.

◆ GetQueryResult()

TQueryResult * TProofPlayer::GetQueryResult ( const char *  ref)
virtual

Get query result instances referenced 'ref' from the list of results.

Implements TVirtualProofPlayer.

Definition at line 429 of file TProofPlayer.cxx.

◆ GetSender()

void* TProofPlayer::GetSender ( )
inlineprotectedvirtual

Reimplemented from TQObject.

Definition at line 105 of file TProofPlayer.h.

◆ HandleGetTreeHeader()

void TProofPlayer::HandleGetTreeHeader ( TMessage mess)
virtual

Handle tree header request.

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerSlave.

Definition at line 1670 of file TProofPlayer.cxx.

◆ HandleRecvHisto()

void TProofPlayer::HandleRecvHisto ( TMessage mess)
virtual

Receive histo from slave.

Implements TVirtualProofPlayer.

Definition at line 1678 of file TProofPlayer.cxx.

◆ IsClient()

Bool_t TProofPlayer::IsClient ( ) const
inlinevirtual

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerRemote, and TProofPlayerLocal.

Definition at line 202 of file TProofPlayer.h.

◆ JoinProcess()

Bool_t TProofPlayer::JoinProcess ( TList workers)
virtual

Not implemented: meaningful only in the remote player. Returns kFALSE.

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerRemote.

Definition at line 1503 of file TProofPlayer.cxx.

◆ MapOutputListToDataMembers()

void TProofPlayer::MapOutputListToDataMembers ( ) const
protected

Definition at line 1597 of file TProofPlayer.cxx.

◆ MergeOutput()

void TProofPlayer::MergeOutput ( Bool_t  savememvalues = kFALSE)
protectedvirtual

Merge output (may not be used in this class).

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerRemote.

Definition at line 1589 of file TProofPlayer.cxx.

◆ Process() [1/2]

Long64_t TProofPlayer::Process ( TDSet dset,
const char *  selector_file,
Option_t option = "",
Long64_t  nentries = -1,
Long64_t  first = 0 
)
virtual

Process specified TDSet on PROOF worker.

The return value is -1 in case of error and TSelector::GetStatus() in case of success.

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerSuperMaster, TProofPlayerRemote, TProofPlayerLocal, and TProofPlayerLite.

Definition at line 1024 of file TProofPlayer.cxx.

◆ Process() [2/2]

Long64_t TProofPlayer::Process ( TDSet dset,
TSelector selector,
Option_t option = "",
Long64_t  nentries = -1,
Long64_t  first = 0 
)
virtual

Process specified TDSet on PROOF worker with TSelector object The return value is -1 in case of error and TSelector::GetStatus() in case of success.

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerSuperMaster, TProofPlayerRemote, TProofPlayerLocal, and TProofPlayerLite.

Definition at line 1485 of file TProofPlayer.cxx.

◆ Progress() [1/6]

void TProofPlayer::Progress ( Long64_t  total,
Long64_t  processed 
)
virtual

Report progress (may not be used in this class).

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerSuperMaster, and TProofPlayerRemote.

Definition at line 698 of file TProofPlayer.cxx.

◆ Progress() [2/6]

void TProofPlayer::Progress ( TSlave ,
Long64_t  total,
Long64_t  processed 
)
inlinevirtual

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerSuperMaster, and TProofPlayerRemote.

Definition at line 175 of file TProofPlayer.h.

◆ Progress() [3/6]

void TProofPlayer::Progress ( Long64_t  total,
Long64_t  processed,
Long64_t  bytesread,
Float_t  initTime,
Float_t  procTime,
Float_t  evtrti,
Float_t  mbrti 
)
virtual

Report progress (may not be used in this class).

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerSuperMaster, and TProofPlayerRemote.

Definition at line 706 of file TProofPlayer.cxx.

◆ Progress() [4/6]

void TProofPlayer::Progress ( TSlave ,
Long64_t  total,
Long64_t  processed,
Long64_t  bytesread,
Float_t  initTime,
Float_t  procTime,
Float_t  evtrti,
Float_t  mbrti 
)
inlinevirtual

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerSuperMaster, and TProofPlayerRemote.

Definition at line 180 of file TProofPlayer.h.

◆ Progress() [5/6]

void TProofPlayer::Progress ( TProofProgressInfo pi)
virtual

Report progress (may not be used in this class).

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerSuperMaster, and TProofPlayerRemote.

Definition at line 717 of file TProofPlayer.cxx.

◆ Progress() [6/6]

void TProofPlayer::Progress ( TSlave ,
TProofProgressInfo pi 
)
inlinevirtual

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerSuperMaster, and TProofPlayerRemote.

Definition at line 186 of file TProofPlayer.h.

◆ ReinitSelector()

Int_t TProofPlayer::ReinitSelector ( TQueryResult qr)
virtual

Reinitialize fSelector using the selector files in the query result.

Needed when Finalize is called after a Process execution for the same selector name.

Implements TVirtualProofPlayer.

Definition at line 500 of file TProofPlayer.cxx.

◆ RemoveQueryResult()

void TProofPlayer::RemoveQueryResult ( const char *  ref)
virtual

Remove all query result instances referenced 'ref' from the list of results.

Implements TVirtualProofPlayer.

Definition at line 411 of file TProofPlayer.cxx.

◆ RestorePreviousQuery()

void TProofPlayer::RestorePreviousQuery ( )
inlinevirtual

Implements TVirtualProofPlayer.

Definition at line 169 of file TProofPlayer.h.

◆ SavePartialResults()

Int_t TProofPlayer::SavePartialResults ( Bool_t  queryend = kFALSE,
Bool_t  force = kFALSE 
)
virtual

Save the partial results of this query to a dedicated file under the user data directory.

The file name has the form <session_tag>.q<query_seq_num>.root The file pat and the file are created if not existing already. Only objects in the outputlist not being TProofOutputFile are saved. The packets list 'packets' is saved if given. Trees not attached to any file are attached to the open file. If 'queryend' is kTRUE evrything is written out (TTrees included). The actual saving action is controlled by 'force' and by fSavePartialResults / fSaveResultsPerPacket:

fSavePartialResults = kFALSE/kTRUE no-saving/saving fSaveResultsPerPacket = kFALSE/kTRUE save-per-query/save-per-packet

The function CheckMemUsage sets fSavePartialResults = 1 if fSaveMemThreshold > 0 and ProcInfo_t::fMemResident >= fSaveMemThreshold: from that point on partial results are always saved and expensive calls to TSystem::GetProcInfo saved. The switch fSaveResultsPerPacket is instead controlled by the user or admin who can also force saving in all cases; parameter PROOF_SavePartialResults or RC env ProofPlayer.SavePartialResults . However, if 'force' is kTRUE, fSavePartialResults and fSaveResultsPerPacket are ignored. Return -1 in case of problems, 0 otherwise.

Implements TVirtualProofPlayer.

Definition at line 781 of file TProofPlayer.cxx.

◆ SetCurrentQuery()

void TProofPlayer::SetCurrentQuery ( TQueryResult q)
virtual

Set current query and save previous value.

Implements TVirtualProofPlayer.

Definition at line 452 of file TProofPlayer.cxx.

◆ SetDispatchTimer()

void TProofPlayer::SetDispatchTimer ( Bool_t  on = kTRUE)
virtual

Enable/disable the timer to dispatch pening events while processing.

Implements TVirtualProofPlayer.

Definition at line 310 of file TProofPlayer.cxx.

◆ SetDrawFeedbackOption()

void TProofPlayer::SetDrawFeedbackOption ( TDrawFeedback f,
Option_t opt 
)
virtual

Set draw feedback option.

Implements TVirtualProofPlayer.

Definition at line 742 of file TProofPlayer.cxx.

◆ SetExitStatus()

void TProofPlayer::SetExitStatus ( EExitStatus  st)
inlinevirtual

Implements TVirtualProofPlayer.

Definition at line 204 of file TProofPlayer.h.

◆ SetInitTime()

virtual void TProofPlayer::SetInitTime ( )
inlinevirtual

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerRemote.

Definition at line 213 of file TProofPlayer.h.

◆ SetMaxDrawQueries()

void TProofPlayer::SetMaxDrawQueries ( Int_t  max)
inlinevirtual

Implements TVirtualProofPlayer.

Definition at line 168 of file TProofPlayer.h.

◆ SetMerging()

virtual void TProofPlayer::SetMerging ( Bool_t  = kTRUE)
inlinevirtual

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerRemote.

Definition at line 215 of file TProofPlayer.h.

◆ SetOutputFilePath()

void TProofPlayer::SetOutputFilePath ( const char *  fp)
inlinevirtual

Implements TVirtualProofPlayer.

Definition at line 220 of file TProofPlayer.h.

◆ SetProcessing()

void TProofPlayer::SetProcessing ( Bool_t  on = kTRUE)

Set processing bit according to 'on'.

Definition at line 275 of file TProofPlayer.cxx.

◆ SetStopTimer()

void TProofPlayer::SetStopTimer ( Bool_t  on = kTRUE,
Bool_t  abort = kFALSE,
Int_t  timeout = 0 
)
virtual

Enable/disable the timer to stop/abort processing.

The 'timeout' is in seconds.

Implements TVirtualProofPlayer.

Definition at line 324 of file TProofPlayer.cxx.

◆ SetupFeedback()

void TProofPlayer::SetupFeedback ( )
protectedvirtual

Set up feedback (may not be used in this class).

Reimplemented in TProofPlayerSuperMaster, TProofPlayerSlave, TProofPlayerRemote, TProofPlayerLocal, and TProofPlayerLite.

Definition at line 1643 of file TProofPlayer.cxx.

◆ StopFeedback()

void TProofPlayer::StopFeedback ( )
virtual

Stop feedback (may not be used in this class).

Reimplemented in TProofPlayerSlave, TProofPlayerRemote, and TProofPlayerLocal.

Definition at line 1651 of file TProofPlayer.cxx.

◆ StopProcess()

void TProofPlayer::StopProcess ( Bool_t  abort,
Int_t  timeout = -1 
)
virtual

Stop the process after this event.

If timeout is positive, start a timer firing after timeout seconds to hard-stop time-expensive events.

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerRemote.

Definition at line 288 of file TProofPlayer.cxx.

◆ StoreFeedback()

void TProofPlayer::StoreFeedback ( TObject slave,
TList out 
)
virtual

Store feedback list (may not be used in this class).

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerRemote, and TProofPlayerLite.

Definition at line 690 of file TProofPlayer.cxx.

◆ StoreOutput()

void TProofPlayer::StoreOutput ( TList out)
virtual

Store output list (may not be used in this class).

Implements TVirtualProofPlayer.

Reimplemented in TProofPlayerRemote.

Definition at line 682 of file TProofPlayer.cxx.

◆ UpdateAutoBin()

void TProofPlayer::UpdateAutoBin ( const char *  name,
Double_t xmin,
Double_t xmax,
Double_t ymin,
Double_t ymax,
Double_t zmin,
Double_t zmax 
)
virtual

Update automatic binning parameters for given object "name".

Implements TVirtualProofPlayer.

Definition at line 1606 of file TProofPlayer.cxx.

◆ UpdateProgressInfo()

void TProofPlayer::UpdateProgressInfo ( )
virtual

Update fProgressStatus.

Implements TVirtualProofPlayer.

Definition at line 1005 of file TProofPlayer.cxx.

Member Data Documentation

◆ fAutoBins

TList* TProofPlayer::fAutoBins
private

Definition at line 63 of file TProofPlayer.h.

◆ fCreateSelObj

Bool_t TProofPlayer::fCreateSelObj
protected

the latest selector

Definition at line 69 of file TProofPlayer.h.

◆ fDispatchTimer

TTimer* TProofPlayer::fDispatchTimer
protected

Definition at line 92 of file TProofPlayer.h.

◆ fDrawQueries

Int_t TProofPlayer::fDrawQueries
protected

Definition at line 86 of file TProofPlayer.h.

◆ fEvIter

TEventIter* TProofPlayer::fEvIter
protected

period (ms) for sending intermediate results

Definition at line 73 of file TProofPlayer.h.

◆ fExitStatus

EExitStatus TProofPlayer::fExitStatus
protected

status of query in progress

Definition at line 75 of file TProofPlayer.h.

◆ fFeedbackPeriod

Long_t TProofPlayer::fFeedbackPeriod
protected

timer for sending intermediate results

Definition at line 72 of file TProofPlayer.h.

◆ fFeedbackTimer

TTimer* TProofPlayer::fFeedbackTimer
protected

class of the latest selector

Definition at line 71 of file TProofPlayer.h.

◆ fgDrawInputPars

THashList * TProofPlayer::fgDrawInputPars = 0
staticprotected

Definition at line 103 of file TProofPlayer.h.

◆ fInput

TList* TProofPlayer::fInput
protected

Definition at line 66 of file TProofPlayer.h.

◆ fMaxDrawQueries

Int_t TProofPlayer::fMaxDrawQueries
protected

Definition at line 87 of file TProofPlayer.h.

◆ fOutput

THashList* TProofPlayer::fOutput
protected

Definition at line 67 of file TProofPlayer.h.

◆ fOutputFile

TFile* TProofPlayer::fOutputFile
protected

Definition at line 98 of file TProofPlayer.h.

◆ fOutputFilePath

TString TProofPlayer::fOutputFilePath
protected

Definition at line 97 of file TProofPlayer.h.

◆ fPreviousQuery

TQueryResult* TProofPlayer::fPreviousQuery
protected

Definition at line 85 of file TProofPlayer.h.

◆ fProcessedRun

Long64_t TProofPlayer::fProcessedRun
protected

Read calls in this run.

Definition at line 81 of file TProofPlayer.h.

◆ fProcTime

TStopwatch* TProofPlayer::fProcTime
protected

Definition at line 95 of file TProofPlayer.h.

◆ fProcTimeTimer

TTimer* TProofPlayer::fProcTimeTimer
protected

Definition at line 94 of file TProofPlayer.h.

◆ fProgressStatus

TProofProgressStatus* TProofPlayer::fProgressStatus
protected

Definition at line 77 of file TProofPlayer.h.

◆ fQuery

TQueryResult* TProofPlayer::fQuery
protected

Definition at line 84 of file TProofPlayer.h.

◆ fQueryResults

TList* TProofPlayer::fQueryResults
protected

Events processed in this run.

Definition at line 83 of file TProofPlayer.h.

◆ fReadBytesRun

Long64_t TProofPlayer::fReadBytesRun
protected

Definition at line 79 of file TProofPlayer.h.

◆ fReadCallsRun

Long64_t TProofPlayer::fReadCallsRun
protected

Bytes read in this run.

Definition at line 80 of file TProofPlayer.h.

◆ fSaveMemThreshold

Long_t TProofPlayer::fSaveMemThreshold
protected

Definition at line 99 of file TProofPlayer.h.

◆ fSavePartialResults

Bool_t TProofPlayer::fSavePartialResults
protected

Definition at line 100 of file TProofPlayer.h.

◆ fSaveResultsPerPacket

Bool_t TProofPlayer::fSaveResultsPerPacket
protected

Definition at line 101 of file TProofPlayer.h.

◆ fSelector

TSelector* TProofPlayer::fSelector
protected

Definition at line 68 of file TProofPlayer.h.

◆ fSelectorClass

TClass* TProofPlayer::fSelectorClass
protected

kTRUE when fSelector has been created locally

Definition at line 70 of file TProofPlayer.h.

◆ fSelStatus

TStatus* TProofPlayer::fSelStatus
protected

iterator on events or objects

Definition at line 74 of file TProofPlayer.h.

◆ fStopTimer

TTimer* TProofPlayer::fStopTimer
protected

Definition at line 89 of file TProofPlayer.h.

◆ fStopTimerMtx

std::mutex TProofPlayer::fStopTimerMtx
protected

Definition at line 90 of file TProofPlayer.h.

◆ fTotalEvents

Long64_t TProofPlayer::fTotalEvents
protected

Definition at line 76 of file TProofPlayer.h.

Libraries for TProofPlayer:
[legend]

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