1 /**************************************************************************
2 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * Author: The ALICE Off-line Project. *
5 * Contributors are mentioned in the code where appropriate. *
7 * Permission to use, copy, modify and distribute this software and its *
8 * documentation strictly for non-commercial purposes is hereby granted *
9 * without fee, provided that the above copyright notice appears in all *
10 * copies and that both the copyright notice and this permission notice *
11 * appear in the supporting documentation. The authors make no claims *
12 * about the suitability of this software for any purpose. It is *
13 * provided "as is" without express or implied warranty. *
14 **************************************************************************/
17 // Author: Andrei Gheata, 31/05/2006
19 //==============================================================================
20 // AliAnalysysDataContainer - Container of data of arbitrary type deriving
21 // from TObject used for analysis. A container must be connected to the
22 // output data slot of a single analysis task (producer) , but also as
23 // input slot for possibly several other tasks (consumers). The connected
24 // slots must enforce the same data type as the container (or a derived type).
25 // A container becomes the owner of the contained data once this was produced.
27 // Containers should be defined by the analysis module using:
29 // AliAnalysisModule::AddContainer(const char *name, TClass *type);
31 // A container should be connected to a producer:
33 // AliAnalysisModule::ConnectOutput(AliAnalysisTask *task,
34 // AliAnalysisDataContainer *cont)
35 // and to its consumers:
37 // AliAnalysisModule::ConnectInput(AliAnalysisTask *task, Int_t islot,
38 // AliAnalysisDataContainer *cont)
40 // The container will create an implicit connection between the producer task
41 // and all consumers, which will become sub-tasks of the producer.
43 //==============================================================================
45 #include <Riostream.h>
46 #include <TMethodCall.h>
53 #include "AliAnalysisDataContainer.h"
54 #include "AliAnalysisDataSlot.h"
55 #include "AliAnalysisTask.h"
57 ClassImp(AliAnalysisDataContainer)
59 //______________________________________________________________________________
60 AliAnalysisDataContainer::AliAnalysisDataContainer() : TNamed(),
72 //______________________________________________________________________________
73 AliAnalysisDataContainer::AliAnalysisDataContainer(const char *name, TClass *type)
83 // Default constructor.
84 SetTitle(fType->GetName());
87 //______________________________________________________________________________
88 AliAnalysisDataContainer::AliAnalysisDataContainer(const AliAnalysisDataContainer &cont)
90 fDataReady(cont.fDataReady),
92 fFileName(cont.fFileName),
95 fProducer(cont.fProducer),
100 if (cont.fConsumers) {
101 fConsumers = new TObjArray(2);
102 Int_t ncons = cont.fConsumers->GetEntriesFast();
103 for (Int_t i=0; i<ncons; i++) fConsumers->Add(cont.fConsumers->At(i));
107 //______________________________________________________________________________
108 AliAnalysisDataContainer::~AliAnalysisDataContainer()
110 // Destructor. Deletes data ! (What happens if data is a container ???)
111 if (fData && fOwnedData) delete fData;
112 if (fConsumers) delete fConsumers;
115 //______________________________________________________________________________
116 AliAnalysisDataContainer &AliAnalysisDataContainer::operator=(const AliAnalysisDataContainer &cont)
120 TNamed::operator=(cont);
121 fDataReady = cont.fDataReady;
122 fOwnedData = kFALSE; // !!! Data owned by cont.
123 fFileName = cont.fFileName;
126 fProducer = cont.fProducer;
127 if (cont.fConsumers) {
128 fConsumers = new TObjArray(2);
129 Int_t ncons = cont.fConsumers->GetEntriesFast();
130 for (Int_t i=0; i<ncons; i++) fConsumers->Add(cont.fConsumers->At(i));
136 //______________________________________________________________________________
137 void AliAnalysisDataContainer::AddConsumer(AliAnalysisTask *consumer, Int_t islot)
139 // Add a consumer for contained data;
140 AliAnalysisDataSlot *slot = consumer->GetInputSlot(islot);
141 if (!slot || !slot->GetType()) {
142 cout<<"Consumer task "<< consumer->GetName()<<" does not have an input/type #"<<islot<<endl;
143 //AliError(Form("Consumer task %s does not have an input #%i", consumer->GetName(),islot));
146 if (!slot->GetType()->InheritsFrom(GetType())) {
147 cout<<"Data type "<<slot->GetTitle()<<" for input slot "<<islot<<" of task "<<consumer->GetName()<<" does not match container type "<<GetTitle()<<endl;
148 //AliError(Form("Data type %s for input slot %i of task %s does not match container type %s", slot->GetType()->GetName(),islot,consumer->GetName(),fType->GetName()));
152 if (!fConsumers) fConsumers = new TObjArray(2);
153 fConsumers->Add(consumer);
154 // Add the consumer task to the list of task of the producer
155 if (fProducer && !fProducer->GetListOfTasks()->FindObject(consumer))
156 fProducer->Add(consumer);
159 //______________________________________________________________________________
160 Bool_t AliAnalysisDataContainer::ClientsExecuted() const
162 // Check if all client tasks have executed.
163 TIter next(fConsumers);
164 AliAnalysisTask *task;
165 while ((task=(AliAnalysisTask*)next())) {
166 if (!task->HasExecuted()) return kFALSE;
171 //______________________________________________________________________________
172 void AliAnalysisDataContainer::DeleteData()
174 // Delete data if not needed anymore.
175 if (!fDataReady || !ClientsExecuted()) {
176 cout<<"Data not ready or not all clients of container "<<GetName()<<" executed. Data not deleted."<<endl;
177 //AliWarning(Form("Data not ready or not all clients of container %s executed. Data not deleted.", GetName()));
181 cout<<"Data not owned by container "<<GetName()<<". Not deleted."<<endl;
182 //AliWarning(Form("Data not owned by container %s. Not deleted.", GetName()));
190 //______________________________________________________________________________
191 TClass *AliAnalysisDataContainer::GetType() const
193 // Get class type for this slot.
194 AliAnalysisDataContainer *cont = (AliAnalysisDataContainer*)this;
195 if (!fType) cont->SetType(gROOT->GetClass(fTitle.Data()));
196 if (!fType) printf("AliAnalysisDataContainer: Unknown class: %s\n", GetTitle());
200 //______________________________________________________________________________
201 void AliAnalysisDataContainer::GetEntry(Long64_t ientry)
203 // If data is ready and derives from TTree or from TBranch, this will get the
204 // requested entry in memory if not already loaded.
205 if (!fDataReady || !GetType()) return;
206 Bool_t istree = fType->InheritsFrom(TTree::Class());
208 TTree *tree = (TTree*)fData;
209 if (tree->GetReadEntry() != ientry) tree->GetEntry(ientry);
212 Bool_t isbranch = fType->InheritsFrom(TBranch::Class());
214 TBranch *branch = (TBranch*)fData;
215 if (branch->GetReadEntry() != ientry) branch->GetEntry(ientry);
220 //______________________________________________________________________________
221 Long64_t AliAnalysisDataContainer::Merge(TCollection *list)
223 // Merge a list of containers with this one. Containers in the list must have
224 // data of the same type.
225 if (!list || !fData) return 0;
226 printf("Merging %d containers %s\n", list->GetSize()+1, GetName());
229 callEnv.InitWithPrototype(fData->IsA(), "Merge", "TCollection*");
230 if (!callEnv.IsValid() && !list->IsEmpty()) {
231 cout << "No merge interface for data stored by " << GetName() << ". Merging not possible !" << endl;
235 if (list->IsEmpty()) return 1;
238 AliAnalysisDataContainer *cont;
239 // Make a list where to temporary store the data to be merged.
240 TList *collectionData = new TList();
241 Int_t count = 0; // object counter
242 while ((cont=(AliAnalysisDataContainer*)next())) {
243 TObject *data = cont->GetData();
245 if (strcmp(cont->GetName(), GetName())) {
246 cout << "Not merging containers with different names !" << endl;
249 printf(" ... merging object %s\n", data->GetName());
250 collectionData->Add(data);
253 callEnv.SetParam((Long_t) collectionData);
254 callEnv.Execute(fData);
255 delete collectionData;
260 //______________________________________________________________________________
261 void AliAnalysisDataContainer::PrintContainer(Option_t *option, Int_t indent) const
263 // Print info about this container.
265 for (Int_t i=0; i<indent; i++) ind += " ";
268 Bool_t dep = (opt.Contains("dep"))?kTRUE:kFALSE;
270 printf("%sContainer: %s type: %s POST_LOOP=%i", ind.Data(), GetName(), GetTitle(), IsPostEventLoop());
272 printf("%s = Data producer: task %s",ind.Data(),fProducer->GetName());
274 printf("%s= No data producer",ind.Data());
275 printf("%s = Consumer tasks: ", ind.Data());
276 if (!fConsumers || !fConsumers->GetEntriesFast()) printf("-none-\n");
279 printf("Filename: %s\n", fFileName.Data());
280 TIter next(fConsumers);
281 AliAnalysisTask *task;
282 while ((task=(AliAnalysisTask*)next())) task->PrintTask(option, indent+3);
285 //______________________________________________________________________________
286 Bool_t AliAnalysisDataContainer::SetData(TObject *data, Option_t *)
288 // Set the data as READY only if it was published by the producer.
289 // If there is no producer declared, this is a top level container.
290 AliAnalysisTask *task;
291 Bool_t init = kFALSE;
294 if (data != fData) init = kTRUE;
298 nc = fConsumers->GetEntriesFast();
299 for (i=0; i<nc; i++) {
300 task = (AliAnalysisTask*)fConsumers->At(i);
301 task->CheckNotify(init);
306 // Check if it is the producer who published the data
307 if (fProducer->GetPublishedData()==data) {
311 nc = fConsumers->GetEntriesFast();
312 for (i=0; i<nc; i++) {
313 task = (AliAnalysisTask*)fConsumers->At(i);
319 cout<<"Data for container "<<GetName()<<" can be published only by producer task "<<fProducer->GetName()<<endl;
320 //AliWarning(Form("Data for container %s can be published only by producer task %s", GetName(), fProducer->GetName()));
325 //______________________________________________________________________________
326 void AliAnalysisDataContainer::SetProducer(AliAnalysisTask *prod, Int_t islot)
328 // Set the producer of data. The slot number is required for data type checking.
330 cout<<"Data container "<<GetName()<<" already has a producer: "<<fProducer->GetName()<<endl;
331 //AliWarning(Form("Data container %s already has a producer: %s",GetName(),fProducer->GetName()));
334 cout<<GetName()<<" container contains data - cannot change producer!"<<endl;
335 //AliError(Form("%s container contains data - cannot change producer!", GetName()));
338 AliAnalysisDataSlot *slot = prod->GetOutputSlot(islot);
340 cout<<"Producer task "<<prod->GetName()<<" does not have an output #"<<islot<<endl;
341 //AliError(Form("Producer task %s does not have an output #%i", prod->GetName(),islot));
344 if (!slot->GetType()->InheritsFrom(GetType())) {
345 cout<<"Data type "<<slot->GetTitle()<<"for output slot "<<islot<<" of task "<<prod->GetName()<<" does not match container type "<<GetTitle()<<endl;
346 //AliError(Form("Data type %s for output slot %i of task %s does not match container type %s", slot->GetType()->GetName(),islot,prod->GetName(),fType->GetName()));
351 // Add all consumers as daughter tasks
352 TIter next(fConsumers);
353 AliAnalysisTask *cons;
354 while ((cons=(AliAnalysisTask*)next())) {
355 if (!prod->GetListOfTasks()->FindObject(cons)) prod->Add(cons);
359 //______________________________________________________________________________
360 AliAnalysisDataWrapper *AliAnalysisDataContainer::ExportData() const
362 // Wraps data for sending it through the net.
363 AliAnalysisDataWrapper *pack = 0;
364 if (!fData) return pack;
365 pack = new AliAnalysisDataWrapper(fData);
366 pack->SetName(fName.Data());
370 //______________________________________________________________________________
371 void AliAnalysisDataContainer::ImportData(AliAnalysisDataWrapper *pack)
373 // Unwraps data from a data wrapper.
375 fData = pack->Data();
377 // Imported wrappers do not own data anymore (AG 13-11-07)
378 pack->SetDeleteData(kFALSE);
382 ClassImp (AliAnalysisDataWrapper)
384 //______________________________________________________________________________
385 AliAnalysisDataWrapper::AliAnalysisDataWrapper(TObject *data)
390 if (data) SetName(data->GetName());
393 //______________________________________________________________________________
394 AliAnalysisDataWrapper::~AliAnalysisDataWrapper()
397 if (fData && TObject::TestBit(kDeleteData)) delete fData;
400 //______________________________________________________________________________
401 AliAnalysisDataWrapper &AliAnalysisDataWrapper::operator=(const AliAnalysisDataWrapper &other)
404 if (&other != this) {
405 TNamed::operator=(other);
411 //______________________________________________________________________________
412 Long64_t AliAnalysisDataWrapper::Merge(TCollection *list)
414 // Merge a list of containers with this one. Containers in the list must have
415 // data of the same type.
416 if (TH1::AddDirectoryStatus()) TH1::AddDirectory(kFALSE);
417 if (!fData) return 0;
418 if (!list || list->IsEmpty()) return 1;
422 callEnv.InitWithPrototype(fData->IsA(), "Merge", "TCollection*");
423 if (!callEnv.IsValid()) {
424 cout << "No merge interface for data stored by " << GetName() << ". Merging not possible !" << endl;
429 AliAnalysisDataWrapper *cont;
430 // Make a list where to temporary store the data to be merged.
431 TList *collectionData = new TList();
432 Int_t count = 0; // object counter
433 // printf("Wrapper %s 0x%lx (data=%s) merged with:\n", GetName(), (ULong_t)this, fData->ClassName());
434 while ((cont=(AliAnalysisDataWrapper*)next1())) {
435 TObject *data = cont->Data();
437 // printf(" - %s 0x%lx (data=%s)\n", cont->GetName(), (ULong_t)cont, data->ClassName());
438 collectionData->Add(data);
441 callEnv.SetParam((Long_t) collectionData);
442 callEnv.Execute(fData);
443 delete collectionData;