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#ifdef R__LESS_INCLUDES
26class TList;
27class TMap;
28#else
29#include "TList.h"
30#include "TMap.h"
31#endif
32
33class TFile;
34
36
37private:
38
41
42 Double_t fValue; // double monitor value
43
44protected:
45 TList *fTmpOpenPhases; // To store open phases when there is not yet an object
46
47public:
50 : TNamed(name, ""), fValue(value), fTmpOpenPhases(0) { }
51
53
54 // TFile related info. In general they are gathered and sent only sometimes as summaries
55 virtual Bool_t SendFileCloseEvent(TFile * /*file*/)
56 { MayNotUse("SendFileCloseEvent"); return kFALSE; }
57 virtual Bool_t SendFileReadProgress(TFile * /*file*/)
58 { MayNotUse("SendFileReadProgress"); return kFALSE; }
60 { MayNotUse("SendFileWriteProgress"); return kFALSE; }
61
62 virtual Bool_t SendParameters(TList * /*valuelist*/, const char * /*identifier*/ = 0)
63 { MayNotUse("SendParameters"); return kFALSE; }
64 virtual Bool_t SendInfoTime() { MayNotUse("SendInfoTime"); return kFALSE; }
65 virtual Bool_t SendInfoUser(const char * /*user*/ = 0) { MayNotUse("SendInfoUser"); return kFALSE; }
66 virtual Bool_t SendInfoDescription(const char * /*jobtag*/) { MayNotUse("SendInfoDescription"); return kFALSE; }
67 virtual Bool_t SendInfoStatus(const char * /*status*/) { MayNotUse("SendInfoStatus"); return kFALSE; }
68
69 // An Open might have several phases, and the timings might be interesting
70 // to report
71 // The info is only gathered into openphasestime, and sent when forcesend=kTRUE
72 virtual Bool_t SendFileOpenProgress(TFile * /*file*/, TList * /*openphases*/,
73 const char * /*openphasename*/,
74 Bool_t /*forcesend*/ = kFALSE )
75 { MayNotUse("SendFileOpenProgress"); return kFALSE; }
76
77 virtual Bool_t SendProcessingStatus(const char * /*status*/, Bool_t /*restarttimer*/ = kFALSE)
78 { MayNotUse("SendProcessingStatus"); return kFALSE; }
79 virtual Bool_t SendProcessingProgress(Double_t /*nevent*/, Double_t /*nbytes*/, Bool_t /*force*/ = kFALSE)
80 { MayNotUse("SendProcessingProgress"); return kFALSE; }
81 virtual void SetLogLevel(const char * /*loglevel*/ = "WARNING")
82 { MayNotUse("SetLogLevel"); };
83 virtual void Verbose(Bool_t /*onoff*/) { MayNotUse("Verbose"); }
84
85 ClassDef(TVirtualMonitoringWriter,0) // ABC for Sending Monitoring Information
86};
87
88
90
91public:
92 TVirtualMonitoringReader( const char * /*serviceurl*/ ="") { }
94
95 virtual void DumpResult() { MayNotUse("DumpResult"); }
96 virtual void GetValues(const char * /*farmName*/, const char * /*clusterName*/,
97 const char * /*nodeName*/, const char * /*paramName*/,
98 Long_t /*min*/, Long_t /*max*/, Bool_t /*debug*/ = kFALSE)
99 { MayNotUse("GetValues"); }
100 virtual void GetLastValues(const char * /*farmName*/, const char * /*clusterName*/,
101 const char * /*nodeName*/, const char * /*paramName*/,
102 Bool_t /*debug*/ =kFALSE)
103 { MayNotUse("GetLastValues"); }
104 virtual void ProxyValues(const char * /*farmName*/, const char * /*clusterName*/,
105 const char * /*nodeName*/, const char * /*paramName*/,
106 Long_t /*min*/, Long_t /*max*/, Long_t /*lifetime*/)
107 { MayNotUse("ProxyValues"); }
108
109 virtual TMap *GetMap() { MayNotUse("GetMap"); return 0; }
110 virtual void DeleteMap(TMap * /*map*/) { MayNotUse("DeleteMap"); }
111
112 ClassDef(TVirtualMonitoringReader, 1) // ABC for Reading Monitoring Information
113};
114
115
118
119
120#endif
#define R__EXTERN
Definition: DllImport.h:27
const Bool_t kFALSE
Definition: RtypesCore.h:101
long Long_t
Definition: RtypesCore.h:54
bool Bool_t
Definition: RtypesCore.h:63
double Double_t
Definition: RtypesCore.h:59
#define ClassDef(name, id)
Definition: Rtypes.h:325
char name[80]
Definition: TGX11.cxx:110
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:54
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:946
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)
TVirtualMonitoringWriter(const TVirtualMonitoringWriter &)=delete
virtual Bool_t SendFileOpenProgress(TFile *, TList *, const char *, Bool_t=kFALSE)
TVirtualMonitoringWriter & operator=(const TVirtualMonitoringWriter &)=delete
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)
virtual Bool_t SendFileWriteProgress(TFile *)
virtual Bool_t SendInfoStatus(const char *)
virtual Bool_t SendInfoDescription(const char *)
virtual ~TVirtualMonitoringWriter()
destructor
TVirtualMonitoringWriter(const char *name, Double_t value)
virtual Bool_t SendProcessingStatus(const char *, Bool_t=kFALSE)
virtual void Verbose(Bool_t)