Updating the AliAnalysisFemtoTask to work with
[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;
675f64cd 53 UInt_t GetCurrentYear() const;
54
55 const char* GetLHCPeriod() const;
73abe331 56
3301427a 57 virtual Bool_t Store(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData,
84090f85 58 Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
3301427a 59 virtual Bool_t StoreReferenceData(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData);
9827400b 60 virtual Bool_t StoreReferenceFile(const char* detector, const char* localFile, const char* gridFileName);
c88ad5db 61 virtual Bool_t StoreRunMetadataFile(const char* localFile, const char* gridFileName);
b948db8d 62 virtual const char* GetFile(Int_t system, const char* detector,
63 const char* id, const char* source);
4a33bdd9 64 virtual TList* GetFileSources(Int_t system, const char* detector, const char* id = 0);
65 virtual TList* GetFileIDs(Int_t system, const char* detector, const char* source);
eba76848 66 virtual const char* GetRunParameter(const char* lbEntry);
9827400b 67 virtual AliCDBEntry* GetFromOCDB(const char* detector, const AliCDBPath& path);
68 virtual const char* GetRunType();
4859271b 69 virtual Bool_t GetHLTStatus();
b948db8d 70 virtual void Log(const char* detector, const char* message);
71
eba76848 72 void SetLogbookEntry(AliShuttleLogbookEntry* entry) {fLogbookEntry=entry;}
9827400b 73
74 void SetTestMode(TestMode testMode) { fTestMode = testMode; }
75 void SetReadTestModeFromLog(Bool_t flag) { fReadTestMode = flag; }
57f50b3c 76
57f50b3c 77 Bool_t Connect(Int_t system);
78
d386d623 79 static void SetMainCDB (TString mainCDB) {fgkMainCDB = mainCDB;}
80 static void SetLocalCDB (TString localCDB) {fgkLocalCDB = localCDB;}
81
82 static void SetMainRefStorage (TString mainRefStorage) {fgkMainRefStorage = mainRefStorage;}
83 static void SetLocalRefStorage (TString localRefStorage) {fgkLocalRefStorage = localRefStorage;}
84
85 static void SetShuttleTempDir (const char* tmpDir);
86 static void SetShuttleLogDir (const char* logDir);
87
73abe331 88private:
57f50b3c 89 AliShuttle(const AliShuttle& other);
90 AliShuttle& operator= (const AliShuttle& other);
91
9827400b 92 Bool_t ProcessCurrentDetector();
2bb7b766 93
eba76848 94 AliShuttleLogbookEntry* QueryRunParameters(Int_t run);
2bb7b766 95 Bool_t QueryShuttleLogbook(const char* whereClause, TObjArray& entries);
fbc112e3 96 void CountOpenRuns();
2bb7b766 97 Bool_t RetrieveConditionsData(const TObjArray& shuttleLogbookEntries);
98
a038aa70 99 TMap* GetValueSet(const char* host, Int_t port, const TSeqCollection* entries,
542b6cc8 100 DCSType type, Int_t valueSet);
57f50b3c 101
9d733021 102 Bool_t RetrieveFile(UInt_t system, const char* daqFileName, const char* localFileName);
103
104 Bool_t UpdateTable();
3301427a 105 Bool_t UpdateTableFailCase();
57f50b3c 106
3301427a 107 Bool_t StoreLocally(const TString& localUri, const AliCDBPath& path, TObject* object,
108 AliCDBMetaData* metaData, Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
85a80aa9 109
3301427a 110 Bool_t StoreOCDB();
111 Bool_t StoreOCDB(const TString& uri);
d524ade6 112 Bool_t CopyFileLocally(const char* localFile, const TString& target);
c88ad5db 113 Bool_t CopyFilesToGrid(const char* type);
3301427a 114 void CleanLocalStorage(const TString& uri);
546242fb 115 Bool_t CleanReferenceStorage(const char* detector);
3301427a 116 void RemoveFile(const char* filename);
2d9019b4 117 const char* GetRefFilePrefix(const char* base, const char* detector);
2bb7b766 118
e7f62f16 119 AliShuttleStatus* ReadShuttleStatus();
120 Bool_t WriteShuttleStatus(AliShuttleStatus* status);
121 Bool_t ContinueProcessing();
122 void UpdateShuttleStatus(AliShuttleStatus::Status newStatus, Bool_t increaseCount = kFALSE);
123 Bool_t UpdateShuttleLogbook(const char* detector, const char* status=0);
57c1a579 124 Bool_t SendMail();
675f64cd 125 Bool_t SendMailToDCS();
ffa29e93 126
127 TString GetLogFileName(const char* detector) const;
57c1a579 128
e7f62f16 129 void SetLastAction(const char* action);
130
ee6f7523 131 void SendAlive();
e7f62f16 132 void SendMLInfo();
b948db8d 133
2bb7b766 134 const AliShuttleConfig* fConfig; // pointer to configuration object
73abe331 135
2bb7b766 136 UInt_t fTimeout; // DCS server connection timeout parameter
137 Int_t fRetries; // Number of DCS server connection retries
5164a766 138
2bb7b766 139 TMap fPreprocessorMap; // list of detector Preprocessors ("DET", "Preprocessor")
57f50b3c 140
2bb7b766 141 AliShuttleLogbookEntry* fLogbookEntry; //! current Shuttle logbook entry
142 TString fCurrentDetector; // current detector
57f50b3c 143
2c15234c 144 TSQLServer *fServer[4]; // pointer to the three FXS + Run & Shuttle logbook servers
145 Bool_t fFXSCalled[3]; // FXS call status
146 TList fFXSlist[3]; // List of files retrieved from each FXS
85a80aa9 147
2bb7b766 148 AliCDBEntry* fStatusEntry; // last CDB entry containing a AliShuttleStatus retrieved
be48e3ea 149
cb343cfd 150 TMutex* fMonitoringMutex; // mutex to lock the monitoring class members
151 UInt_t fLastActionTime; // time of last action for monitoring
152 TString fLastAction; // string description for last action
4f0ab988 153
be48e3ea 154 Bool_t fFirstUnprocessed[AliShuttleInterface::kNDetectors]; // array of flags for first unprocessed dets
155
e7f62f16 156 TMonaLisaWriter* fMonaLisa; // ML instance that sends the processing information
157
9827400b 158 TestMode fTestMode; // sets test mode flags, that e.g. simulate a dcs error etc.
159 Bool_t fReadTestMode; // Reads the test mode from the log entry of the given run (only for test)
ffa29e93 160
161 Bool_t fOutputRedirected; // is the output redirected to a file
b948db8d 162
73abe331 163 ClassDef(AliShuttle, 0);
164};
165
166#endif