Run type field added in SHUTTLE framework. Run type is read from "run type" logbook...
[u/mrichter/AliRoot.git] / SHUTTLE / AliShuttle.h
1 #ifndef ALI_SHUTTLE_H
2 #define ALI_SHUTTLE_H
3
4 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
5  * See cxx source for full Copyright notice                               */
6
7 /* $Id$ */
8
9
10 //
11 // This class is the main manager for 
12 // AliShuttle. It organizes the data retrieval
13 // from DCS and call the interface methods of
14 // AliPreprocessor.
15 //
16
17 #include <TMap.h>
18 #include <TString.h>
19 #include <TList.h>
20
21 #include "AliShuttleInterface.h"
22 #include "AliShuttleStatus.h"
23
24 class TObject;
25 class AliShuttleConfig;
26 class AliShuttleLogbookEntry;
27 class AliPreprocessor;
28 class TSQLServer;
29 class TMutex;
30 class TMonaLisaWriter;
31
32 class AliShuttle: public AliShuttleInterface {
33 public:
34         enum DCSType {kAlias=0, kDP};
35
36         AliShuttle(const AliShuttleConfig* config, UInt_t timeout = 5000, Int_t retries = 5);
37         virtual ~AliShuttle();
38
39         virtual void RegisterPreprocessor(AliPreprocessor* preprocessor);
40
41         Bool_t Collect(Int_t run = -1);
42
43         Bool_t Process(AliShuttleLogbookEntry* entry);
44
45         // monitoring functions
46         ULong_t GetTimeOfLastAction() const;
47         const TString GetLastAction() const;
48
49         Int_t GetCurrentRun() const;
50         UInt_t GetCurrentStartTime() const;
51         UInt_t GetCurrentEndTime() const;
52
53         virtual UInt_t Store(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData,
54                         Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
55         virtual UInt_t StoreReferenceData(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData);
56         virtual const char* GetFile(Int_t system, const char* detector,
57                 const char* id, const char* source);
58         virtual TList* GetFileSources(Int_t system, const char* detector, const char* id);
59         virtual const char* GetRunParameter(const char* lbEntry);
60         virtual AliCDBEntry* GetFromOCDB(const AliCDBPath& path);
61         virtual const char* GetRunType(const char* detCode);
62         virtual void Log(const char* detector, const char* message);
63
64         //TODO Test only, remove later !
65         void SetProcessDCS(Bool_t process) {fgkProcessDCS = process;}
66         void SetLogbookEntry(AliShuttleLogbookEntry* entry) {fLogbookEntry=entry;}
67
68         Bool_t Connect(Int_t system);
69
70         static void SetMainCDB (TString mainCDB) {fgkMainCDB = mainCDB;}
71         static void SetLocalCDB (TString localCDB) {fgkLocalCDB = localCDB;}
72
73         static void SetMainRefStorage (TString mainRefStorage) {fgkMainRefStorage = mainRefStorage;}
74         static void SetLocalRefStorage (TString localRefStorage) {fgkLocalRefStorage = localRefStorage;}
75
76         static void SetShuttleTempDir (const char* tmpDir);
77         static void SetShuttleLogDir (const char* logDir);
78
79 private:
80         AliShuttle(const AliShuttle& other);
81         AliShuttle& operator= (const AliShuttle& other);
82
83         UInt_t ProcessCurrentDetector();
84
85         AliShuttleLogbookEntry* QueryRunParameters(Int_t run);
86         Bool_t QueryShuttleLogbook(const char* whereClause, TObjArray& entries);
87         Bool_t RetrieveConditionsData(const TObjArray& shuttleLogbookEntries);
88
89         Bool_t GetValueSet(const char* host, Int_t port, const char* alias,
90                                 TObjArray* result, DCSType type);
91
92         Bool_t RetrieveFile(UInt_t system, const char* daqFileName, const char* localFileName);
93
94         Bool_t UpdateTable();
95
96         UInt_t WriteToCDB(const char* mainUri, const char* localUri,
97                                 const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData,
98                                 Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
99
100         Bool_t TryToStoreAgain();
101         Bool_t TryToStoreAgain(TString& storageType);
102
103         AliShuttleStatus* ReadShuttleStatus();
104         Bool_t WriteShuttleStatus(AliShuttleStatus* status);
105         Bool_t ContinueProcessing();
106         void UpdateShuttleStatus(AliShuttleStatus::Status newStatus, Bool_t increaseCount = kFALSE);
107         Bool_t UpdateShuttleLogbook(const char* detector, const char* status=0);
108         Bool_t SendMail();
109
110         void SetLastAction(const char* action);
111         
112         void SendMLInfo();
113
114         void SetRunType();
115
116         const AliShuttleConfig* fConfig;        // pointer to configuration object
117
118         UInt_t fTimeout;        // DCS server connection timeout parameter
119         Int_t fRetries;         // Number of DCS server connection retries
120
121         TMap fPreprocessorMap;  // list of detector Preprocessors ("DET", "Preprocessor")
122
123         AliShuttleLogbookEntry* fLogbookEntry;   //! current Shuttle logbook entry
124         TString fCurrentDetector; // current detector
125
126         TSQLServer *fServer[4];         // pointer to the three FXS + Run & Shuttle logbook servers
127         Bool_t fFXSCalled[3];           // FXS call status
128         TList  fFXSlist[3];             // List of files retrieved from each FXS
129
130         AliCDBEntry* fStatusEntry; // last CDB entry containing a AliShuttleStatus retrieved
131         Bool_t fGridError;         // Grid storage error flag
132
133         TMutex* fMonitoringMutex;   // mutex to lock the monitoring class members
134         UInt_t fLastActionTime;    // time of last action for monitoring
135         TString fLastAction;       // string description for last action
136
137         Bool_t fFirstUnprocessed[AliShuttleInterface::kNDetectors];       // array of flags for first unprocessed dets
138
139         TMonaLisaWriter* fMonaLisa;  // ML instance that sends the processing information
140
141         //TODO Test only, remove later !
142         static Bool_t fgkProcessDCS; // flag to enable DCS archive data processing
143
144         ClassDef(AliShuttle, 0);
145 };
146
147 #endif