ANALYSIS/AliAnalysisDataSlot.cxx

   1 /**************************************************************************
   2  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   3  *                                                                        *
   4  * Author: The ALICE Off-line Project.                                    *
   5  * Contributors are mentioned in the code where appropriate.              *
   6  *                                                                        *
   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  **************************************************************************/
  15
  16 /* $Id$ */
  17 // Author: Andrei Gheata, 31/05/2006
  18
  19 //==============================================================================
  20 //   AliAnalysysDataSlot - Class representing a data slot of an analysis task.
  21 //      An analysis slot enforces a certain data type required by the Exec()
  22 //      method of the analysis task. The slot must be connected to a data
  23 //      container with data of the same type.
  24 //
  25 // The class should not be directly created by users - it is created by
  26 // each AliAnalysisTask when defining its input/output slots using:
  27 //
  28 //    AliAnalysisTask::SetInput(Int_t index, TClass *type);
  29 //    AliAnalysisTask::SetOutput(TClass *type);
  30 //
  31 // An existing data contaner (AliAnalysisDataContainer) can be connected to the
  32 // input/output slots of an analysis task using:
  33 //
  34 //   AliAnalysisModule::ConnectInput(AliAnalysisTask *task, Int_t islot,
  35 //                                   AliAnalysisDataContainer *cont)
  36 //   AliAnalysisModule::ConnectOutput(AliAnalysisTask *task,
  37 //                                    AliAnalysisDataContainer *cont)
  38 // To connect a slot to a data container, the data types declared by both must
  39 // match.
  40 //==============================================================================
  41
  42 #include "TClass.h"
  43 #include "TTree.h"
  44 #include "AliLog.h"
  45
  46 #include "AliAnalysisDataSlot.h"
  47 #include "AliAnalysisTask.h"
  48 #include "AliAnalysisDataContainer.h"
  49
  50 ClassImp(AliAnalysisDataSlot)
  51
  52 //______________________________________________________________________________
  53 AliAnalysisDataSlot& AliAnalysisDataSlot::operator=(const AliAnalysisDataSlot &slot)
  54 {
  55 // Assignment
  56    if (&slot == this) return *this;
  57    TObject::operator=(slot);
  58    fType = slot.fType;
  59    fParent = slot.fParent;
  60    fContainer = slot.fContainer;
  61    return *this;
  62 }
  63
  64 //______________________________________________________________________________
  65 Bool_t AliAnalysisDataSlot::ConnectContainer(AliAnalysisDataContainer *cont)
  66 {
  67 // Connect the data slot with a given container. The operation will succeed only
  68 // if the type defined by the slot inherits from the type enforced by the container.
  69 // The error message in case of failure is posted by the caller.
  70    if (!cont || !fType) return kFALSE;
  71    if (!fType->InheritsFrom(cont->GetType())) {
  72       AliError(Form("Data slot of type %s of task %s cannot be connected to data container %s of type %s",
  73                     fType->GetName(), fParent->GetName(), cont->GetName(), cont->GetType()->GetName()));
  74       return kFALSE;
  75    }
  76    fContainer = cont;
  77    return kTRUE;
  78 }
  79
  80 //______________________________________________________________________________
  81 void *AliAnalysisDataSlot::GetBranchAddress(const char *branchname) const
  82 {
  83 // Retrieve the address for a given branch. One should always test this before
  84 // using SetBranchAddress because the address gets set by the first caller.
  85 // Call this in MyTask::Init()
  86    if (!fType->InheritsFrom(TTree::Class())) {
  87       AliFatal(Form("Cannot call GetBranchAddress() for data slot of task %s not pointing to tree-type data", fParent->GetName()));
  88       return NULL;
  89    }
  90    if (!IsDataReady()) {
  91       AliFatal(Form("Cannot call GetBranchAddress() for data slot of task %s while data is not ready", fParent->GetName()));
  92       return NULL;
  93    }
  94    TTree *tree = (TTree*)GetData();
  95    TBranch *br = tree->GetBranch(branchname);
  96    if (!br) {
  97       AliFatal(Form("Branch %s not found in tree %s as input of task %s...",
  98                branchname, tree->GetName(), fParent->GetName()));
  99       return NULL;
 100    }
 101    return br->GetAddress();
 102 }
 103
 104 //______________________________________________________________________________
 105 Bool_t AliAnalysisDataSlot::SetBranchAddress(const char *branchname, void *address)
 106 {
 107 // Set a branch address for input tree. To be called during MyTask::Init()
 108 // only if GetBranchAddress() returns a NULL pointer for a tree-type slot.
 109    if (GetBranchAddress(branchname)) {
 110       AliError(Form("Branch address for %s already set by other task. Call first GetBranchAddress() in %s::Init()",
 111                branchname, fParent->GetName()));
 112       return kFALSE;
 113    }
 114    TTree *tree = (TTree*)GetData();
 115    tree->SetBranchAddress(branchname, address);
 116    return kTRUE;
 117 }
 118
 119 //______________________________________________________________________________
 120 TObject *AliAnalysisDataSlot::GetData() const
 121 {
 122 // Retreives the data from the container if it is ready.
 123    if (!fContainer) {
 124       AliError(Form("Data slot of type %s of task %s has no connected data container",
 125                fType->GetName(), fParent->GetName()));
 126       return NULL;
 127    }
 128    if (!fContainer->IsDataReady()) return NULL;
 129    return fContainer->GetData();
 130 }
 131
 132 //______________________________________________________________________________
 133 Bool_t  AliAnalysisDataSlot::IsDataReady() const
 134 {
 135 // Check if data for this slot is ready in its container.
 136    if (!fContainer) {
 137       AliError(Form("Data slot of type %s of task %s has no connected data container",
 138                fType->GetName(), fParent->GetName()));
 139       return kFALSE;
 140    }
 141    return fContainer->IsDataReady();
 142 }
 143