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.

virtual	~TQueryResultManager ()
	Cleanup.

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.

Int_t	CleanupQueriesDir ()
	Remove all queries results referring to previous sessions.

Int_t	CleanupSession (const char *sessiontag)
	Cleanup query dir qdir.

Int_t	DrawQueries () const

Bool_t	FinalizeQuery (TProofQueryResult pq, TProof proof, TVirtualProofPlayer *player)
	Final steps after Process() to complete the TQueryResult instance.

Float_t	GetCpuTime ()

Float_t	GetRealTime ()

void	IncrementDrawQueries ()

void	IncrementSeqNum ()

Int_t	KeptQueries () const

TProofQueryResult *	LocateQuery (TString queryref, Int_t &qry, TString &qdir)
	Locate query referenced by queryref.

Int_t	LockSession (const char sessiontag, TProofLockPath *lck)
	Try locking query area of session tagged sessiontag.

TList *	PreviousQueries () const

TList *	Queries () 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)

void	RemoveQuery (TQueryResult *qr, Bool_t soft=kFALSE)
	Remove everything about query qr.

void	ResetTime ()

void	SaveQuery (TProofQueryResult qr, const char fout=0)
	Save current status of query 'qr' to file name fout.

void	SaveQuery (TProofQueryResult *qr, Int_t mxq)
	Save current query honouring the max number of queries allowed.

void	ScanPreviousQueries (const char *dir)
	Scan the queries directory for the results of previous queries.

Int_t	SeqNum () const

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

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

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

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

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

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

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

virtual void	Clear (Option_t *="")

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

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

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

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

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

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

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

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

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=0)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	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.

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.

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=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

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

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

Private Attributes
TStopwatch	fCompute

Int_t	fDrawQueries

Int_t	fKeptQueries

TProofLockPath *	fLock

FILE *	fLogFile

TList *	fPreviousQueries

TList *	fQueries

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

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

void	MakeZombie ()

#include <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:

proof/proof/inc/TQueryResultManager.h
proof/proof/src/TQueryResultManager.cxx

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TQueryResultManager()

◆ ~TQueryResultManager()

Member Function Documentation

◆ AddLogFile()

◆ ApplyMaxQueries()

◆ CleanupQueriesDir()

◆ CleanupSession()

◆ DrawQueries()

◆ FinalizeQuery()

◆ GetCpuTime()

◆ GetRealTime()

◆ IncrementDrawQueries()

◆ IncrementSeqNum()

◆ KeptQueries()

◆ LocateQuery()

◆ LockSession()

◆ PreviousQueries()

◆ Queries()

◆ QueryDir()

◆ RemoveQuery() [1/2]

◆ RemoveQuery() [2/2]

◆ ResetTime()

◆ SaveQuery() [1/2]

◆ SaveQuery() [2/2]

◆ ScanPreviousQueries()

◆ SeqNum()

Member Data Documentation

◆ fCompute

◆ fDrawQueries

◆ fKeptQueries

◆ fLock

◆ fLogFile

◆ fPreviousQueries

◆ fQueries

◆ fQueryDir

◆ fSeqNum

◆ fSessionDir

◆ fSessionTag