PyStoreArray.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
#include <framework/datastore/DataStore.h>
#include <framework/datastore/StoreAccessorBase.h>
 
#include <TCollection.h> //for TIter
 
class TClonesArray;
class TClass;
class TObject;
 
#include <string>
 
namespace Belle2 {
  class PyStoreArray {
  public:
    static std::vector<std::string> list(DataStore::EDurability durability = DataStore::EDurability::c_Event);
 
    static void printList(DataStore::EDurability durability = DataStore::EDurability::c_Event);
 
    explicit PyStoreArray(const std::string& name,
                          DataStore::EDurability durability =  DataStore::EDurability::c_Event);
 
    explicit PyStoreArray(TClass* objClass,
                          DataStore::EDurability durability =  DataStore::EDurability::c_Event);
 
    explicit PyStoreArray(TClass* objClass,
                          const std::string& name,
                          DataStore::EDurability durability =  DataStore::EDurability::c_Event);
 
    bool registerInDataStore(DataStore::EStoreFlags storeFlags);
 
    bool registerInDataStore(const std::string& name = "",
                             DataStore::EStoreFlags storeFlags = DataStore::EStoreFlags::c_WriteOut);
 
    bool isRequired(const std::string& name = "");
 
    bool isOptional(const std::string& name = "");
 
    bool registerRelationTo(const PyStoreArray& toArray,
                            DataStore::EDurability durability = DataStore::EDurability::c_Event,
                            DataStore::EStoreFlags storeFlags = DataStore::EStoreFlags::c_WriteOut,
                            std::string const& namedRelation = "") const;
 
    bool requireRelationTo(const PyStoreArray& toArray,
                           DataStore::EDurability durability = DataStore::c_Event,
                           std::string const& namedRelation = "") const;
 
    bool optionalRelationTo(const PyStoreArray& toArray,
                            DataStore::EDurability durability = DataStore::c_Event,
                            std::string const& namedRelation = "") const;
 
    bool hasRelationTo(const PyStoreArray& toArray,
                       DataStore::EDurability durability = DataStore::c_Event,
                       const std::string& namedRelation = "") const;
 
    bool hasRelationFrom(const PyStoreArray& fromArray,
                         DataStore::EDurability durability = DataStore::c_Event,
                         const std::string& namedRelation = "") const;
 
    std::string getName() const { return m_storeAccessor.getName(); }
 
    bool hasValidClass() const;
 
    bool isValid() const;
 
    operator bool() const { return isValid(); }
 
    //------------------------------ Accessing content of the array ----------------------------------
    TObject* operator [](int i) const;
 
    int getEntries() const;
 
    int __len__() const { return getEntries(); }
 
    TIter __iter__() const;
 
    TObject* appendNew();
 
    TClonesArray* getPtr();
 
  private:
    void ensureCreated();
 
    bool create(bool replace = false);
 
    void ensureAttached() const;
 
    void attach() const;
 
  private:
    StoreAccessorBase m_storeAccessor;
 
    mutable StoreEntry* m_storeEntry = nullptr;
  };
}