Logo ROOT  
Reference Guide
TVirtualMonitoring.h
Go to the documentation of this file.
1// @(#)root/base:$Id$
2// Author: Andreas-Joachim Peters 15/05/2006
3
4/*************************************************************************
5 * Copyright (C) 1995-2006, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
11
12#ifndef ROOT_TVirtualMonitoring
13#define ROOT_TVirtualMonitoring
14
15//////////////////////////////////////////////////////////////////////////
16// //
17// TVirtualMonitoring //
18// //
19// Provides the interface for Monitoring plugins. //
20// //
21//////////////////////////////////////////////////////////////////////////
22
23#include "TNamed.h"
24
25#include "TList.h"
26#include "TMap.h"
27
28class TFile;
29
31
32private:
33
36
37 Double_t fValue; // double monitor value
38
39protected:
40 TList *fTmpOpenPhases; // To store open phases when there is not yet an object
41
42public:
45 : TNamed(name, ""), fValue(value), fTmpOpenPhases(0) { }
46
48
49 // TFile related info. In general they are gathered and sent only sometimes as summaries
50 virtual Bool_t SendFileCloseEvent(TFile * /*file*/)
51 { MayNotUse("SendFileCloseEvent"); return kFALSE; }
52 virtual Bool_t SendFileReadProgress(TFile * /*file*/)
53 { MayNotUse("SendFileReadProgress"); return kFALSE; }
55 { MayNotUse("SendFileWriteProgress"); return kFALSE; }
56
57 virtual Bool_t SendParameters(TList * /*valuelist*/, const char * /*identifier*/ = 0)
58 { MayNotUse("SendParameters"); return kFALSE; }
59 virtual Bool_t SendInfoTime() { MayNotUse("SendInfoTime"); return kFALSE; }
60 virtual Bool_t SendInfoUser(const char * /*user*/ = 0) { MayNotUse("SendInfoUser"); return kFALSE; }
61 virtual Bool_t SendInfoDescription(const char * /*jobtag*/) { MayNotUse("SendInfoDescription"); return kFALSE; }
62 virtual Bool_t SendInfoStatus(const char * /*status*/) { MayNotUse("SendInfoStatus"); return kFALSE; }
63
64 // An Open might have several phases, and the timings might be interesting
65 // to report
66 // The info is only gathered into openphasestime, and sent when forcesend=kTRUE
67 virtual Bool_t SendFileOpenProgress(TFile * /*file*/, TList * /*openphases*/,
68 const char * /*openphasename*/,
69 Bool_t /*forcesend*/ = kFALSE )
70 { MayNotUse("SendFileOpenProgress"); return kFALSE; }
71
72 virtual Bool_t SendProcessingStatus(const char * /*status*/, Bool_t /*restarttimer*/ = kFALSE)
73 { MayNotUse("SendProcessingStatus"); return kFALSE; }
74 virtual Bool_t SendProcessingProgress(Double_t /*nevent*/, Double_t /*nbytes*/, Bool_t /*force*/ = kFALSE)
75 { MayNotUse("SendProcessingProgress"); return kFALSE; }
76 virtual void SetLogLevel(const char * /*loglevel*/ = "WARNING")
77 { MayNotUse("SetLogLevel"); };
78 virtual void Verbose(Bool_t /*onoff*/) { MayNotUse("Verbose"); }
79
80 ClassDef(TVirtualMonitoringWriter,0) // ABC for Sending Monitoring Information
81};
82
83
85
86public:
87 TVirtualMonitoringReader( const char * /*serviceurl*/ ="") { }
89
90 virtual void DumpResult() { MayNotUse("DumpResult"); }
91 virtual void GetValues(const char * /*farmName*/, const char * /*clusterName*/,
92 const char * /*nodeName*/, const char * /*paramName*/,
93 Long_t /*min*/, Long_t /*max*/, Bool_t /*debug*/ = kFALSE)
94 { MayNotUse("GetValues"); }
95 virtual void GetLastValues(const char * /*farmName*/, const char * /*clusterName*/,
96 const char * /*nodeName*/, const char * /*paramName*/,
97 Bool_t /*debug*/ =kFALSE)
98 { MayNotUse("GetLastValues"); }
99 virtual void ProxyValues(const char * /*farmName*/, const char * /*clusterName*/,
100 const char * /*nodeName*/, const char * /*paramName*/,
101 Long_t /*min*/, Long_t /*max*/, Long_t /*lifetime*/)
102 { MayNotUse("ProxyValues"); }
103
104 virtual TMap *GetMap() { MayNotUse("GetMap"); return 0; }
105 virtual void DeleteMap(TMap * /*map*/) { MayNotUse("DeleteMap"); }
106
107 ClassDef(TVirtualMonitoringReader, 1) // ABC for Reading Monitoring Information
108};
109
110
113
114
115#endif
long Long_t
Definition: CPyCppyy.h:50
#define R__EXTERN
Definition: DllImport.h:27
const Bool_t kFALSE
Definition: RtypesCore.h:90
bool Bool_t
Definition: RtypesCore.h:61
double Double_t
Definition: RtypesCore.h:57
#define ClassDef(name, id)
Definition: Rtypes.h:322
char name[80]
Definition: TGX11.cxx:109
R__EXTERN TVirtualMonitoringReader * gMonitoringReader
R__EXTERN TVirtualMonitoringWriter * gMonitoringWriter
A ROOT file is a suite of consecutive data records (TKey instances) with a well defined format.
Definition: TFile.h:53
A doubly linked list.
Definition: TList.h:44
TMap implements an associative array of (key,value) pairs using a THashTable for efficient retrieval ...
Definition: TMap.h:40
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
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 clas...
Definition: TObject.cxx:944
virtual void DeleteMap(TMap *)
virtual void ProxyValues(const char *, const char *, const char *, const char *, Long_t, Long_t, Long_t)
TVirtualMonitoringReader(const char *="")
virtual void GetValues(const char *, const char *, const char *, const char *, Long_t, Long_t, Bool_t=kFALSE)
virtual void GetLastValues(const char *, const char *, const char *, const char *, Bool_t=kFALSE)
virtual Bool_t SendFileOpenProgress(TFile *, TList *, const char *, Bool_t=kFALSE)
virtual Bool_t SendInfoUser(const char *=0)
virtual Bool_t SendFileReadProgress(TFile *)
virtual void SetLogLevel(const char *="WARNING")
virtual Bool_t SendFileCloseEvent(TFile *)
virtual Bool_t SendInfoTime()
virtual Bool_t SendProcessingProgress(Double_t, Double_t, Bool_t=kFALSE)
virtual Bool_t SendParameters(TList *, const char *=0)
TVirtualMonitoringWriter & operator=(const TVirtualMonitoringWriter &)
virtual Bool_t SendFileWriteProgress(TFile *)
virtual Bool_t SendInfoStatus(const char *)
virtual Bool_t SendInfoDescription(const char *)
TVirtualMonitoringWriter(const char *name, Double_t value)
virtual Bool_t SendProcessingStatus(const char *, Bool_t=kFALSE)
virtual void Verbose(Bool_t)
TVirtualMonitoringWriter(const TVirtualMonitoringWriter &)