Belle II Software light-2406-ragdoll
PyStoreArray.h
1/**************************************************************************
2 * basf2 (Belle II Analysis Software Framework) *
3 * Author: The Belle II Collaboration *
4 * *
5 * See git log for contributors and copyright holders. *
6 * This file is licensed under LGPL-3.0, see LICENSE.md. *
7 **************************************************************************/
8
9#pragma once
10
11#include <framework/datastore/DataStore.h>
12#include <framework/datastore/StoreAccessorBase.h>
13
14#include <TCollection.h> //for TIter
15
16class TClonesArray;
17class TClass;
18class TObject;
19
20#include <string>
21
22namespace Belle2 {
73 public:
75 static std::vector<std::string> list(DataStore::EDurability durability = DataStore::EDurability::c_Event);
76
79
84 explicit PyStoreArray(const std::string& name,
86
91 explicit PyStoreArray(TClass* objClass,
93
99 explicit PyStoreArray(TClass* objClass,
100 const std::string& name,
102
110
118 bool registerInDataStore(const std::string& name = "",
120
128 bool isRequired(const std::string& name = "");
129
138 bool isOptional(const std::string& name = "");
139
150 bool registerRelationTo(const PyStoreArray& toArray,
153 std::string const& namedRelation = "") const;
154
164 bool requireRelationTo(const PyStoreArray& toArray,
166 std::string const& namedRelation = "") const;
167
178 bool optionalRelationTo(const PyStoreArray& toArray,
180 std::string const& namedRelation = "") const;
181
188 bool hasRelationTo(const PyStoreArray& toArray,
190 const std::string& namedRelation = "") const;
191
198 bool hasRelationFrom(const PyStoreArray& fromArray,
200 const std::string& namedRelation = "") const;
201
203 std::string getName() const { return m_storeAccessor.getName(); }
204
206 bool hasValidClass() const;
207
209 bool isValid() const;
210
212 operator bool() const { return isValid(); }
213
214 //------------------------------ Accessing content of the array ----------------------------------
216 TObject* operator [](int i) const;
217
219 int getEntries() const;
220
222 int __len__() const { return getEntries(); }
223
226 TIter __iter__() const;
227
232 TObject* appendNew();
233
241 TClonesArray* getPtr();
242
243 private:
245 void ensureCreated();
246
252 bool create(bool replace = false);
253
255 void ensureAttached() const;
256
258 void attach() const;
259
260 private:
263
265 mutable StoreEntry* m_storeEntry = nullptr;
266 };
268}
EStoreFlags
Flags describing behaviours of objects etc.
Definition: DataStore.h:69
@ c_WriteOut
Object/array should be saved by output modules.
Definition: DataStore.h:70
EDurability
Durability types.
Definition: DataStore.h:58
@ c_Event
Different object in each event, all objects/arrays are invalidated after event() function has been ca...
Definition: DataStore.h:59
A (simplified) python wrapper for StoreArray.
Definition: PyStoreArray.h:72
StoreAccessorBase m_storeAccessor
Store accessor to retrieve the object.
Definition: PyStoreArray.h:262
static void printList(DataStore::EDurability durability=DataStore::EDurability::c_Event)
Print list of available arrays for given durability.
Definition: PyStoreArray.cc:34
bool hasRelationFrom(const PyStoreArray &fromArray, DataStore::EDurability durability=DataStore::c_Event, const std::string &namedRelation="") const
Check for the existence of a relation from the provided toArray (to this Pystorearray)
void ensureAttached() const
Ensure that contained TClonesArray has been attached to a memory location on the DataStore.
bool hasValidClass() const
Check whether a TClass of the objects in this PyStoreArray could be determined.
bool isValid() const
Check whether the array was registered and created.
bool isRequired(const std::string &name="")
Ensure this array has been registered previously.
Definition: PyStoreArray.cc:82
bool isOptional(const std::string &name="")
Tell the DataStore about an optional input.
Definition: PyStoreArray.cc:87
std::string getName() const
Return name under which the object is saved in the DataStore.
Definition: PyStoreArray.h:203
bool optionalRelationTo(const PyStoreArray &toArray, DataStore::EDurability durability=DataStore::c_Event, std::string const &namedRelation="") const
Tell the data store about a relation that we could make use of.
bool hasRelationTo(const PyStoreArray &toArray, DataStore::EDurability durability=DataStore::c_Event, const std::string &namedRelation="") const
Check for the existence of a relation to the provided toArray (from this Pystorearray)
TObject * operator[](int i) const
returns object at index i, or null pointer if out of range (+error)
bool registerRelationTo(const PyStoreArray &toArray, DataStore::EDurability durability=DataStore::EDurability::c_Event, DataStore::EStoreFlags storeFlags=DataStore::EStoreFlags::c_WriteOut, std::string const &namedRelation="") const
Register a relation to the given PyStoreArray.
Definition: PyStoreArray.cc:92
int __len__() const
Support for len().
Definition: PyStoreArray.h:222
bool registerInDataStore(DataStore::EStoreFlags storeFlags)
Register the array in the data store.
Definition: PyStoreArray.cc:64
TObject * appendNew()
Construct a new object of the array's type at the end of the array.
int getEntries() const
returns number of entries for current event.
void ensureCreated()
Ensure that contained TClonesArray has been created on the DataStore.
StoreEntry * m_storeEntry
Pointer to the DataStore entry - serves as an internal cache omitting repeated look up from the DataS...
Definition: PyStoreArray.h:265
TClonesArray * getPtr()
Raw access to the underlying TClonesArray.
bool requireRelationTo(const PyStoreArray &toArray, DataStore::EDurability durability=DataStore::c_Event, std::string const &namedRelation="") const
Produce error if no relation from this array to 'toArray' has been registered.
void attach() const
Lookup the store entry and cache a pointer to it.
bool create(bool replace=false)
Create constructed TClonesArray in the DataStore.
TIter __iter__() const
Allow iteration using for in Python.
static std::vector< std::string > list(DataStore::EDurability durability=DataStore::EDurability::c_Event)
Return list of available arrays for given durability.
Definition: PyStoreArray.cc:28
Base class for StoreObjPtr and StoreArray for easier common treatment.
const std::string & getName() const
Return name under which the object is saved in the DataStore.
Abstract base class for different kinds of events.
Definition: ClusterUtils.h:24
Wraps a stored array/object, stored under unique (name, durability) key.
Definition: StoreEntry.h:22