model_common_interface.hpp

Go to the documentation of this file.

// DUNE DAQ modification notice:
// This file has been modified from the original ATLAS dbe source for the DUNE DAQ project.
// Fork baseline commit: dbe-02-12-17 (2022-05-12).
// Renamed since fork: yes (from dbe/model_common_interface.h to include/dbe/model_common_interface.hpp).
 
/*
 * model_common_interface.h
 *
 *  Created on: Nov 16, 2015
 *      Author: lgeorgop
 */
 
#ifndef DBE_MODEL_COMMON_INTERFACE_H_
#define DBE_MODEL_COMMON_INTERFACE_H_
 
#include "conffwk/ConfigObject.hpp"
#include "dbe/confaccessor.hpp"
 
#include <QModelIndex>
#include <QString>
#include <QUuid>
 
#include <set>
#include <vector>
 
#define MODEL_COMMON_INTERFACE_UUID_DEF QUuid const uuid;
#define MODEL_COMMON_INTERFACE_UUID_DECL uuid(QUuid::createUuid())
 
#define MODEL_COMMON_TYPES_TOPLEVEL_DEFINITIONS                                                                        \
  typedef QModelIndex type_index;                                                                                      \
  typedef std::vector<type_index> type_indices;                                                                        \
  typedef dbe::tref type_object_ref;                                                                                   \
  typedef dbe::dref type_object_info;                                                                                  \
  typedef dunedaq::conffwk::class_t type_class_info;
 
namespace dbe {
//------------------------------------------------------------------------------------------
 
class model_common_slots
{
  MODEL_COMMON_TYPES_TOPLEVEL_DEFINITIONS
 
public:
  virtual ~model_common_slots() = default;
 
private:
  // These methods should be placed in slots declaration such that they can be parsed
  // appropriately to create slots at each derived class
  virtual void slot_remove_object(QString const&, dref const&) = 0;

  virtual void slot_rename_object(QString const&, dref const&) = 0;

  virtual void slot_update_object(QString const&, dref const&) = 0;

  virtual void slot_create_object(QString const&, dref const&) = 0;
};
//------------------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------------------
struct model_common_data_access_interface
{
  MODEL_COMMON_TYPES_TOPLEVEL_DEFINITIONS
public:
  virtual type_object_ref getobject(type_index const& index) const = 0;
 
  virtual type_class_info getclass(type_index const& index) const = 0;
 
  virtual QAbstractItemModel* ReturnSourceModel() const = 0;
 
  virtual ~model_common_data_access_interface() = default;
};
//------------------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------------------
class model_initiate_actions_interface
{
  MODEL_COMMON_TYPES_TOPLEVEL_DEFINITIONS
 
public:
  virtual ~model_initiate_actions_interface() = default;
  //-------------------------- FORWARD CHAIN ------------------------------------------------------------------------
  // Front end functionality permits explicit actions on the objects linked to this model
  // These methods should provoke actions onto the database itself
  virtual bool delete_objects(type_indices::iterator, type_indices::iterator) = 0;
  virtual bool update_objects(type_indices::iterator, type_indices::iterator) = 0;
  virtual bool create_objects(type_indices::iterator, type_indices::iterator) = 0;
};
//------------------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------------------
class model_common_interface
  : public model_initiate_actions_interface
  , public model_common_data_access_interface
  , private model_common_slots
{
  MODEL_COMMON_TYPES_TOPLEVEL_DEFINITIONS
 
  friend class model_common_slots;
 
public:
  virtual ~model_common_interface() = default;
 
protected:
  virtual void remove_deleted_object(type_index const& index) = 0;

  virtual void rename_contained_object(type_index const& index, type_object_info const& obj) = 0;

  virtual void update_contained_object(type_index const& index, type_object_info const& obj) = 0;
  virtual void create_contained_object(type_index const& index, type_object_info const& obj) = 0;

  virtual type_index lookup(type_object_info const&) = 0;
 
  QUuid getuuid() const;
};
//------------------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------------------
template<typename T>
class model_common_impl : public model_common_interface
{
  MODEL_COMMON_TYPES_TOPLEVEL_DEFINITIONS
 
public:
  bool delete_objects(type_indices::iterator, type_indices::iterator) override;

  bool update_objects(type_indices::iterator, type_indices::iterator) override;

  bool create_objects(type_indices::iterator, type_indices::iterator) override;
 
  //  private:
  //  FOR FUTURE USE
  //    static std::vector<type_object_info> filter_indices(type_indices::iterator,
  //                                                        type_indices::iterator);
};
//------------------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------------------
template<typename T>
class model_common_async_operations
{
public:
  MODEL_COMMON_TYPES_TOPLEVEL_DEFINITIONS
 
  model_common_async_operations();

  void model_common_connections();
 
protected:
  //-------------------------- BACK CHAIN
  //-------------------------------------------------------------------------------
  // Back end functionality that permits to implicitly act on an object  referenced  in this model
  // These methods should NOT take action onto the database but only on the referenced model

  void remove_object(type_object_info const&);
  void create_object(type_object_info const&);
  void rename_object(type_object_info const&);
  void update_object(type_object_info const&);
  void update_multiple_objects(std::vector<type_object_info> const&);
 
  MODEL_COMMON_INTERFACE_UUID_DEF
};
//------------------------------------------------------------------------------------------
 
} // namespace dbe
 
#include "dbe/model_common_interface_macros.hpp"
#include "dbe/model_common_operations.hpp"
 
#endif /* DBE_MODEL_COMMON_INTERFACE_H_ */