Logo ROOT  
Reference Guide
TQueryResultManager Class Reference

Class managing the query-result area

Definition at line 35 of file TQueryResultManager.h.

Public Member Functions

 TQueryResultManager (const char *qdir, const char *stag, const char *sdir, TProofLockPath *lck, FILE *logfile=0)
 Constructor. More...
 
virtual ~TQueryResultManager ()
 Cleanup. More...
 
Int_t ApplyMaxQueries (Int_t mxq)
 Scan the queries directory and remove the oldest ones (and relative dirs, if empty) in such a way only 'mxq' queries are kept. More...
 
Int_t CleanupQueriesDir ()
 Remove all queries results referring to previous sessions. More...
 
Int_t CleanupSession (const char *sessiontag)
 Cleanup query dir qdir. More...
 
Int_t DrawQueries () const
 
Bool_t FinalizeQuery (TProofQueryResult *pq, TProof *proof, TVirtualProofPlayer *player)
 Final steps after Process() to complete the TQueryResult instance. More...
 
Float_t GetCpuTime ()
 
Float_t GetRealTime ()
 
void IncrementDrawQueries ()
 
void IncrementSeqNum ()
 
Int_t KeptQueries () const
 
TProofQueryResultLocateQuery (TString queryref, Int_t &qry, TString &qdir)
 Locate query referenced by queryref. More...
 
Int_t LockSession (const char *sessiontag, TProofLockPath **lck)
 Try locking query area of session tagged sessiontag. More...
 
TListPreviousQueries () const
 
TListQueries () const
 
const char * QueryDir () const
 
void RemoveQuery (const char *queryref, TList *otherlist=0)
 Remove everything about query queryref; if defined 'otherlist' will containe the list of removed pointers (already deleted) More...
 
void RemoveQuery (TQueryResult *qr, Bool_t soft=kFALSE)
 Remove everything about query qr. More...
 
void ResetTime ()
 
void SaveQuery (TProofQueryResult *qr, const char *fout=0)
 Save current status of query 'qr' to file name fout. More...
 
void SaveQuery (TProofQueryResult *qr, Int_t mxq)
 Save current query honouring the max number of queries allowed. More...
 
void ScanPreviousQueries (const char *dir)
 Scan the queries directory for the results of previous queries. More...
 
Int_t SeqNum () const
 
- 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...
 

Private Member Functions

void AddLogFile (TProofQueryResult *pq)
 Add part of log file concerning TQueryResult pq to its macro container. More...
 

Private Attributes

TStopwatch fCompute
 
Int_t fDrawQueries
 
Int_t fKeptQueries
 
TProofLockPathfLock
 
FILE * fLogFile
 
TListfPreviousQueries
 
TListfQueries
 
TString fQueryDir
 
Int_t fSeqNum
 
TString fSessionDir
 
TString fSessionTag
 

Additional Inherited Members

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

#include <TQueryResultManager.h>

Inheritance diagram for TQueryResultManager:
[legend]

Constructor & Destructor Documentation

◆ TQueryResultManager()

TQueryResultManager::TQueryResultManager ( const char *  qdir,
const char *  stag,
const char *  sdir,
TProofLockPath lck,
FILE *  logfile = 0 
)

Constructor.

Definition at line 42 of file TQueryResultManager.cxx.

◆ ~TQueryResultManager()

TQueryResultManager::~TQueryResultManager ( )
virtual

Cleanup.

Not really necessary since after this dtor there is no live anyway.

Definition at line 62 of file TQueryResultManager.cxx.

Member Function Documentation

◆ AddLogFile()

void TQueryResultManager::AddLogFile ( TProofQueryResult pq)
private

Add part of log file concerning TQueryResult pq to its macro container.

Definition at line 72 of file TQueryResultManager.cxx.

◆ ApplyMaxQueries()

Int_t TQueryResultManager::ApplyMaxQueries ( Int_t  mxq)

Scan the queries directory and remove the oldest ones (and relative dirs, if empty) in such a way only 'mxq' queries are kept.

Return 0 on success, -1 in case of problems

Definition at line 236 of file TQueryResultManager.cxx.

◆ CleanupQueriesDir()

Int_t TQueryResultManager::CleanupQueriesDir ( )

Remove all queries results referring to previous sessions.

Definition at line 107 of file TQueryResultManager.cxx.

◆ CleanupSession()

Int_t TQueryResultManager::CleanupSession ( const char *  sessiontag)

Cleanup query dir qdir.

Definition at line 407 of file TQueryResultManager.cxx.

◆ DrawQueries()

Int_t TQueryResultManager::DrawQueries ( ) const
inline

Definition at line 59 of file TQueryResultManager.h.

◆ FinalizeQuery()

Bool_t TQueryResultManager::FinalizeQuery ( TProofQueryResult pq,
TProof proof,
TVirtualProofPlayer player 
)

Final steps after Process() to complete the TQueryResult instance.

Definition at line 612 of file TQueryResultManager.cxx.

◆ GetCpuTime()

Float_t TQueryResultManager::GetCpuTime ( )
inline

Definition at line 71 of file TQueryResultManager.h.

◆ GetRealTime()

Float_t TQueryResultManager::GetRealTime ( )
inline

Definition at line 72 of file TQueryResultManager.h.

◆ IncrementDrawQueries()

void TQueryResultManager::IncrementDrawQueries ( )
inline

Definition at line 65 of file TQueryResultManager.h.

◆ IncrementSeqNum()

void TQueryResultManager::IncrementSeqNum ( )
inline

Definition at line 64 of file TQueryResultManager.h.

◆ KeptQueries()

Int_t TQueryResultManager::KeptQueries ( ) const
inline

Definition at line 60 of file TQueryResultManager.h.

◆ LocateQuery()

TProofQueryResult * TQueryResultManager::LocateQuery ( TString  queryref,
Int_t qry,
TString qdir 
)

Locate query referenced by queryref.

Return pointer to instance in memory, if any, or 0. Fills qdir with the query specific directory and qry with the query number for queries processed by this session.

Definition at line 549 of file TQueryResultManager.cxx.

◆ LockSession()

Int_t TQueryResultManager::LockSession ( const char *  sessiontag,
TProofLockPath **  lck 
)

Try locking query area of session tagged sessiontag.

The id of the locking file is returned in fid and must be unlocked via UnlockQueryFile(fid).

Definition at line 348 of file TQueryResultManager.cxx.

◆ PreviousQueries()

TList* TQueryResultManager::PreviousQueries ( ) const
inline

Definition at line 62 of file TQueryResultManager.h.

◆ Queries()

TList* TQueryResultManager::Queries ( ) const
inline

Definition at line 61 of file TQueryResultManager.h.

◆ QueryDir()

const char* TQueryResultManager::QueryDir ( ) const
inline

Definition at line 57 of file TQueryResultManager.h.

◆ RemoveQuery() [1/2]

void TQueryResultManager::RemoveQuery ( const char *  queryref,
TList otherlist = 0 
)

Remove everything about query queryref; if defined 'otherlist' will containe the list of removed pointers (already deleted)

Definition at line 479 of file TQueryResultManager.cxx.

◆ RemoveQuery() [2/2]

void TQueryResultManager::RemoveQuery ( TQueryResult qr,
Bool_t  soft = kFALSE 
)

Remove everything about query qr.

If soft = TRUE leave a track in memory with the relevant info

Definition at line 512 of file TQueryResultManager.cxx.

◆ ResetTime()

void TQueryResultManager::ResetTime ( )
inline

Definition at line 76 of file TQueryResultManager.h.

◆ SaveQuery() [1/2]

void TQueryResultManager::SaveQuery ( TProofQueryResult qr,
const char *  fout = 0 
)

Save current status of query 'qr' to file name fout.

If fout == 0 (default) use the default name.

Definition at line 450 of file TQueryResultManager.cxx.

◆ SaveQuery() [2/2]

void TQueryResultManager::SaveQuery ( TProofQueryResult qr,
Int_t  mxq 
)

Save current query honouring the max number of queries allowed.

Definition at line 683 of file TQueryResultManager.cxx.

◆ ScanPreviousQueries()

void TQueryResultManager::ScanPreviousQueries ( const char *  dir)

Scan the queries directory for the results of previous queries.

The headers of the query results found are loaded in fPreviousQueries. The full query result can be retrieved via TProof::Retrieve.

Definition at line 157 of file TQueryResultManager.cxx.

◆ SeqNum()

Int_t TQueryResultManager::SeqNum ( ) const
inline

Definition at line 58 of file TQueryResultManager.h.

Member Data Documentation

◆ fCompute

TStopwatch TQueryResultManager::fCompute
private

Definition at line 48 of file TQueryResultManager.h.

◆ fDrawQueries

Int_t TQueryResultManager::fDrawQueries
private

Definition at line 42 of file TQueryResultManager.h.

◆ fKeptQueries

Int_t TQueryResultManager::fKeptQueries
private

Definition at line 43 of file TQueryResultManager.h.

◆ fLock

TProofLockPath* TQueryResultManager::fLock
private

Definition at line 46 of file TQueryResultManager.h.

◆ fLogFile

FILE* TQueryResultManager::fLogFile
private

Definition at line 47 of file TQueryResultManager.h.

◆ fPreviousQueries

TList* TQueryResultManager::fPreviousQueries
private

Definition at line 45 of file TQueryResultManager.h.

◆ fQueries

TList* TQueryResultManager::fQueries
private

Definition at line 44 of file TQueryResultManager.h.

◆ fQueryDir

TString TQueryResultManager::fQueryDir
private

Definition at line 38 of file TQueryResultManager.h.

◆ fSeqNum

Int_t TQueryResultManager::fSeqNum
private

Definition at line 41 of file TQueryResultManager.h.

◆ fSessionDir

TString TQueryResultManager::fSessionDir
private

Definition at line 40 of file TQueryResultManager.h.

◆ fSessionTag

TString TQueryResultManager::fSessionTag
private

Definition at line 39 of file TQueryResultManager.h.

Libraries for TQueryResultManager:
[legend]

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