allow merging of non-std objects which are not a collection
[u/mrichter/AliRoot.git] / HLT / rec / AliHLTEsdManagerImplementation.h
CommitLineData
c5123824 1//-*- Mode: C++ -*-
2// $Id$
3
f1207f29 4#ifndef ALIHLTESDMANAGERIMPLEMENTATION_H
5#define ALIHLTESDMANAGERIMPLEMENTATION_H
c5123824 6//* This file is property of and copyright by the ALICE HLT Project *
7//* ALICE Experiment at CERN, All rights reserved. *
8//* See cxx source for full Copyright notice *
9
f1207f29 10/** @file AliHLTEsdManagerImplementation.h
c5123824 11 @author Matthias Richter
12 @date
f1207f29 13 @brief Implementation of the AliHLTEsdManager
c5123824 14*/
15
f1207f29 16#include "AliHLTEsdManager.h"
f5ea7ce2 17#include "AliESDEvent.h"
90c37647 18#include "TString.h"
c5123824 19#include <vector>
20
c5123824 21class TTree;
22class TFile;
23
24/**
f1207f29 25 * @class AliHLTEsdManagerImplementation
26 * Implementation of the AliHLTEsdManager.
83cb7e1d 27 *
f1207f29 28 * For the sake of library (in)dependencies, the concrete implementation of
29 * the AliHLTEsdManager is separated from the libHLTbase class as this would
30 * introduce dependencies to AliRoot libraries. See AliHLTEsdManager for
31 * usage.
83cb7e1d 32 *
9d4cf2ab 33 * @ingroup alihlt_aliroot_reconstruction
c5123824 34 */
f1207f29 35class AliHLTEsdManagerImplementation : public AliHLTEsdManager {
c5123824 36 public:
37 /** constructor */
f1207f29 38 AliHLTEsdManagerImplementation();
c5123824 39 /** destructor */
f1207f29 40 virtual ~AliHLTEsdManagerImplementation();
c5123824 41
794de106 42 /**
43 * Inherited from base class, see AliHLTEsdManager::SetOption() for
44 * documentation.
45 */
46 virtual int SetOption(const char* option);
47
c5123824 48 /**
49 * Convert data buffer to ESD.
50 * The buffer is supposed to describe a streamed AliESDEvent object.
51 * If no target object is specified, the ESD is written to a file AliHLTdetESDs.root,
52 * where 'det' is derived from the data type origin. Each time the function is invoked
53 * a new event is created. Dummy events are added if the previous events did not contain
54 *
55 * @param pBuffer [in] the data buffer
56 * @param size [in] data buffer size
57 * @param dt [in] data type of the block
58 * @param tgtesd [out] optional target
59 * @param eventno [in] optional event no
60 */
61 int WriteESD(const AliHLTUInt8_t* pBuffer, AliHLTUInt32_t size, AliHLTComponentDataType dt,
62 AliESDEvent* tgtesd=NULL, int eventno=-1);
63
57584811 64 /**
65 * Merge content of source ESD into the target ESD.
66 * Merging is done on the level of objects in the ESD and for the
67 * moment it's only implemented for the TClonesArrays. In that case it's
68 * easy to detect whether the object is empty or not.
69 *
70 * \b Note: The function can not match entries of the same type, like e.g.
71 * tracks from the 'Tracks' member.
72 */
73 int Merge(AliESDEvent* pTgt, AliESDEvent* pSrc) const;
74
90c37647 75 /**
76 * Align all ESD to the same number of events.
77 * The function adds empty events to all ESD files if their event number
78 * does not match the specified one.
79 * @param eventno the desired event no
80 * @return neg. error code if failed
81 */
82 int PadESDs(int eventno);
83
84 /**
85 * Set the target directory for the ESD files.
86 */
87 void SetDirectory(const char* directory);
88
89 /**
90 * Get the list of the internally created files.
91 * Returns a blank separated list of the file names.
92 */
93 TString GetFileNames(AliHLTComponentDataType dt=kAliHLTAnyDataType) const;
94
95 /**
96 * Embed an ESD into a TTree object.
97 * The tree object needs to be deleted by the caller.
98 */
99 static TTree* EmbedIntoTree(AliESDEvent* pESD, const char* name="esdTree", const char* title="Tree with HLT ESD objects");
100
f5ea7ce2 101 class AliHLTESDEventHelper : public AliESDEvent {
102 public:
103 static bool IsStdContent(const char* key);
104 };
105
c5123824 106 protected:
107
108 private:
109 /** copy constructor prohibited */
f1207f29 110 AliHLTEsdManagerImplementation(const AliHLTEsdManagerImplementation&);
c5123824 111 /** assignment operator prohibited */
f1207f29 112 AliHLTEsdManagerImplementation& operator=(const AliHLTEsdManagerImplementation&);
c5123824 113
114 class AliHLTEsdListEntry : public AliHLTLogging {
115 public:
116 /** constructor */
117 AliHLTEsdListEntry(AliHLTComponentDataType dt);
c5123824 118 /** destructor */
119 ~AliHLTEsdListEntry();
120
121 /**
122 * Write the ESD to the corresponding file.
123 * The tree is first synchronized with the eventno and additional empty
124 * events might be inserted if there was a gap. Since we are writing
125 * several files in parallel, we have to make sure that those files contain
126 * the same number of events.
127 * @param pESD ESD to write
128 * @param eventno optional event no for tree synchronization
129 */
130 int WriteESD(AliESDEvent* pESD, int eventno=-1);
131
90c37647 132 /**
133 * Set the target directory for the ESD file.
134 */
135 void SetDirectory(const char* directory);
136
137 /**
138 * Delete the ESD file.
139 */
140 void Delete();
141
142 /**
143 * Get name of the ESD file.
144 */
145 const char* GetFileName() const;
146
f527516f 147 /**
148 * Get the object name prefix generated from the data origin
149 * The prefix is added to the names of the ESD objects when copied to the
150 * master ESD.
151 */
152 const char* GetPrefix();
153
c5123824 154 bool operator==(AliHLTComponentDataType dt) const;
155
156 private:
62ff1e23 157 /** copy constructor prohibited */
158 AliHLTEsdListEntry(const AliHLTEsdListEntry& src);
159 /** assignment operator prohibited */
160 AliHLTEsdListEntry& operator=(const AliHLTEsdListEntry& src);
c5123824 161
90c37647 162 /**
163 * Write ESD to temporary file.
164 * The ESD is embedded into a tree and saved to a temporary file.
165 * The file name is retrieved by TSystem::GetTempFileName and returned
166 * on success.
167 * @return file name, empty on failure
168 */
169 TString WriteTempFile(AliESDEvent* pESD) const;
170
c5123824 171 /** root file name */
172 TString fName; //!transient
90c37647 173 /** target directory */
174 TString fDirectory; //!transient
c5123824 175 /** data type of the corresponding block */
176 AliHLTComponentDataType fDt; //!transient
83cb7e1d 177 /** the root file for this esd */
178 TFile* fpFile; //!transient
179 /** the tree for this esd */
180 TTree* fpTree; //!transient
181 /** the esd to fill into the tree */
182 AliESDEvent* fpEsd; //!transient
f527516f 183 /** Prefix for generated ESD objects in the master ESD */
184 TString fPrefix; //!transient
c5123824 185 };
186
62ff1e23 187 typedef vector<AliHLTEsdListEntry*> AliHLTEsdPList;
c5123824 188
189 /**
190 * Find list entry for given data type
191 */
192 AliHLTEsdListEntry* Find(AliHLTComponentDataType dt) const;
193
194 /** the list of the ESDs */
62ff1e23 195 AliHLTEsdPList fESDs; //!transient
c5123824 196
90c37647 197 /** target directory */
198 TString fDirectory; //!transient
794de106 199 /** write local files */
200 bool fWriteLocal; //!transient
90c37647 201
794de106 202 ClassDef(AliHLTEsdManagerImplementation, 2)
c5123824 203};
90c37647 204
c5123824 205#endif