StoreAccessorBase.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 <string>
#include <utility>
 
class TClass;
 
namespace Belle2 {
  typedef std::pair<std::string, DataStore::EDurability>
  AccessorParams; 
  class StoreAccessorBase {
  public:
 
    StoreAccessorBase(const std::string& name, DataStore::EDurability durability, TClass* objClass, bool isArray):
      m_name(name), m_durability(durability), m_class(objClass), m_isArray(isArray) {}
 
    virtual ~StoreAccessorBase() {}
 
    bool registerInDataStore(DataStore::EStoreFlags storeFlags = DataStore::c_WriteOut)
    {
      return DataStore::Instance().registerEntry(m_name, m_durability, getClass(), isArray(), storeFlags);
    }
 
    bool registerInDataStore(const std::string& name, DataStore::EStoreFlags storeFlags = DataStore::c_WriteOut)
    {
      if (!name.empty())
        m_name = name;
      return DataStore::Instance().registerEntry(m_name, m_durability, getClass(), isArray(), storeFlags);
    }
 
    bool isRequired(const std::string& name = "")
    {
      if (!name.empty())
        m_name = name;
      return DataStore::Instance().requireInput(*this);
    }
 
    bool isOptional(const std::string& name = "")
    {
      if (!name.empty())
        m_name = name;
      return DataStore::Instance().optionalInput(*this);
    }
 
    bool create(bool replace = false)
    {
      return DataStore::Instance().createObject(0, replace, *this);
    }
 
    bool assign(TObject* object, bool replace = false);
 
    virtual void clear()
    {
      create(true);
    }
 
 
    const std::string& getName() const { return m_name; }
 
    DataStore::EDurability getDurability() const { return m_durability; }
 
    AccessorParams getAccessorParams() const { return make_pair(m_name, m_durability);}
 
    virtual bool operator==(const StoreAccessorBase& other) const
    {
      return getAccessorParams() == other.getAccessorParams();
    }
 
    virtual bool operator!=(const StoreAccessorBase& other) const
    {
      return !(*this == other);
    }
 
    TClass* getClass() const { return m_class; }
 
    bool isArray() const { return m_isArray; }
 
    bool notWrittenOut() const;
 
 
    std::string readableName() const;
 
  protected:
    std::string m_name;
 
    DataStore::EDurability m_durability;
 
    TClass* m_class;
 
    bool m_isArray;
 
  };
}