AliAnalysisGoodies temporarily removed from the compilation
[u/mrichter/AliRoot.git] / SHUTTLE / AliShuttle.h
CommitLineData
73abe331 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
a7160fe9 14// AliPreprocessor.
73abe331 15//
16
73abe331 17#include <TMap.h>
b948db8d 18#include <TString.h>
57f50b3c 19#include <TList.h>
b948db8d 20
21#include "AliShuttleInterface.h"
5164a766 22#include "AliShuttleStatus.h"
73abe331 23
58bc3020 24class TObject;
73abe331 25class AliShuttleConfig;
2bb7b766 26class AliShuttleLogbookEntry;
b948db8d 27class AliPreprocessor;
57f50b3c 28class TSQLServer;
cb343cfd 29class TMutex;
e7f62f16 30class TMonaLisaWriter;
73abe331 31
b948db8d 32class AliShuttle: public AliShuttleInterface {
73abe331 33public:
2c15234c 34 enum DCSType {kAlias=0, kDP};
9827400b 35 enum TestMode { kNone = 0, kSkipDCS = 1, kErrorDCS = 2, kErrorFXSSources = 4, kErrorFXSFiles = 8, kErrorOCDB = 16, kErrorStorage = 32, kErrorGrid = 64 };
2c15234c 36
b948db8d 37 AliShuttle(const AliShuttleConfig* config, UInt_t timeout = 5000, Int_t retries = 5);
73abe331 38 virtual ~AliShuttle();
39
b948db8d 40 virtual void RegisterPreprocessor(AliPreprocessor* preprocessor);
41
cb343cfd 42 Bool_t Collect(Int_t run = -1);
2bb7b766 43
44 Bool_t Process(AliShuttleLogbookEntry* entry);
73abe331 45
cb343cfd 46 // monitoring functions
47 ULong_t GetTimeOfLastAction() const;
48 const TString GetLastAction() const;
49
2bb7b766 50 Int_t GetCurrentRun() const;
51 UInt_t GetCurrentStartTime() const;
52 UInt_t GetCurrentEndTime() const;
73abe331 53
3301427a 54 virtual Bool_t Store(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData,
84090f85 55 Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
3301427a 56 virtual Bool_t StoreReferenceData(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData);
9827400b 57 virtual Bool_t StoreReferenceFile(const char* detector, const char* localFile, const char* gridFileName);
b948db8d 58 virtual const char* GetFile(Int_t system, const char* detector,
59 const char* id, const char* source);
60 virtual TList* GetFileSources(Int_t system, const char* detector, const char* id);
eba76848 61 virtual const char* GetRunParameter(const char* lbEntry);
9827400b 62 virtual AliCDBEntry* GetFromOCDB(const char* detector, const AliCDBPath& path);
63 virtual const char* GetRunType();
b948db8d 64 virtual void Log(const char* detector, const char* message);
65
eba76848 66 void SetLogbookEntry(AliShuttleLogbookEntry* entry) {fLogbookEntry=entry;}
9827400b 67
68 void SetTestMode(TestMode testMode) { fTestMode = testMode; }
69 void SetReadTestModeFromLog(Bool_t flag) { fReadTestMode = flag; }
57f50b3c 70
57f50b3c 71 Bool_t Connect(Int_t system);
72
d386d623 73 static void SetMainCDB (TString mainCDB) {fgkMainCDB = mainCDB;}
74 static void SetLocalCDB (TString localCDB) {fgkLocalCDB = localCDB;}
75
76 static void SetMainRefStorage (TString mainRefStorage) {fgkMainRefStorage = mainRefStorage;}
77 static void SetLocalRefStorage (TString localRefStorage) {fgkLocalRefStorage = localRefStorage;}
78
79 static void SetShuttleTempDir (const char* tmpDir);
80 static void SetShuttleLogDir (const char* logDir);
81
73abe331 82private:
57f50b3c 83 AliShuttle(const AliShuttle& other);
84 AliShuttle& operator= (const AliShuttle& other);
85
9827400b 86 Bool_t ProcessCurrentDetector();
2bb7b766 87
eba76848 88 AliShuttleLogbookEntry* QueryRunParameters(Int_t run);
2bb7b766 89 Bool_t QueryShuttleLogbook(const char* whereClause, TObjArray& entries);
90 Bool_t RetrieveConditionsData(const TObjArray& shuttleLogbookEntries);
91
2c15234c 92 Bool_t GetValueSet(const char* host, Int_t port, const char* alias,
93 TObjArray* result, DCSType type);
57f50b3c 94
9d733021 95 Bool_t RetrieveFile(UInt_t system, const char* daqFileName, const char* localFileName);
96
97 Bool_t UpdateTable();
3301427a 98 Bool_t UpdateTableFailCase();
57f50b3c 99
3301427a 100 Bool_t StoreLocally(const TString& localUri, const AliCDBPath& path, TObject* object,
101 AliCDBMetaData* metaData, Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
85a80aa9 102
3301427a 103 Bool_t StoreOCDB();
104 Bool_t StoreOCDB(const TString& uri);
9827400b 105 Bool_t StoreRefFilesToGrid();
3301427a 106 void CleanLocalStorage(const TString& uri);
107 void RemoveFile(const char* filename);
2bb7b766 108
e7f62f16 109 AliShuttleStatus* ReadShuttleStatus();
110 Bool_t WriteShuttleStatus(AliShuttleStatus* status);
111 Bool_t ContinueProcessing();
112 void UpdateShuttleStatus(AliShuttleStatus::Status newStatus, Bool_t increaseCount = kFALSE);
113 Bool_t UpdateShuttleLogbook(const char* detector, const char* status=0);
57c1a579 114 Bool_t SendMail();
ffa29e93 115
116 TString GetLogFileName(const char* detector) const;
57c1a579 117
e7f62f16 118 void SetLastAction(const char* action);
119
120 void SendMLInfo();
b948db8d 121
2bb7b766 122 const AliShuttleConfig* fConfig; // pointer to configuration object
73abe331 123
2bb7b766 124 UInt_t fTimeout; // DCS server connection timeout parameter
125 Int_t fRetries; // Number of DCS server connection retries
5164a766 126
2bb7b766 127 TMap fPreprocessorMap; // list of detector Preprocessors ("DET", "Preprocessor")
57f50b3c 128
2bb7b766 129 AliShuttleLogbookEntry* fLogbookEntry; //! current Shuttle logbook entry
130 TString fCurrentDetector; // current detector
57f50b3c 131
2c15234c 132 TSQLServer *fServer[4]; // pointer to the three FXS + Run & Shuttle logbook servers
133 Bool_t fFXSCalled[3]; // FXS call status
134 TList fFXSlist[3]; // List of files retrieved from each FXS
85a80aa9 135
2bb7b766 136 AliCDBEntry* fStatusEntry; // last CDB entry containing a AliShuttleStatus retrieved
be48e3ea 137
cb343cfd 138 TMutex* fMonitoringMutex; // mutex to lock the monitoring class members
139 UInt_t fLastActionTime; // time of last action for monitoring
140 TString fLastAction; // string description for last action
4f0ab988 141
be48e3ea 142 Bool_t fFirstUnprocessed[AliShuttleInterface::kNDetectors]; // array of flags for first unprocessed dets
143
e7f62f16 144 TMonaLisaWriter* fMonaLisa; // ML instance that sends the processing information
145
9827400b 146 TestMode fTestMode; // sets test mode flags, that e.g. simulate a dcs error etc.
147 Bool_t fReadTestMode; // Reads the test mode from the log entry of the given run (only for test)
ffa29e93 148
149 Bool_t fOutputRedirected; // is the output redirected to a file
b948db8d 150
73abe331 151 ClassDef(AliShuttle, 0);
152};
153
154#endif