ConfigObjectImpl.hpp

Go to the documentation of this file.

//
// DUNE DAQ modification notice:
// This file has been modified from the original ATLAS config source for the DUNE DAQ project.
// Fork baseline commit: 67a24e731 (2022-10-27).
// Renamed since fork: yes (from config/ConfigObjectImpl.h to include/conffwk/ConfigObjectImpl.hpp).
//

 
#ifndef CONFFWK_CONFIGOBJECTIMPL_H_
#define CONFFWK_CONFIGOBJECTIMPL_H_
 
#include <iostream>
#include <stdint.h>
#include <string>
#include <vector>
 
#include "conffwk/Errors.hpp"
 
namespace dunedaq {
namespace conffwk {
 
class ConfigObject;
class Configuration;
class ConfigurationImpl;
class DalObject;
class DalObject;
class DalRegistry;

enum ObjectState
{
  Valid,   
  Deleted, 
  Unknown  
};

 
class ConfigObjectImpl
{
 
  friend class ConfigObject;
  friend class Configuration;
  friend class ConfigurationImpl;
  friend class DalObject;
  friend class DalObject;
  friend class DalRegistry;
 
public:
  ConfigObjectImpl(ConfigurationImpl* impl,
                   const std::string& id,
                   dunedaq::conffwk::ObjectState state = dunedaq::conffwk::Valid) noexcept;

  virtual ~ConfigObjectImpl() noexcept;
 
private:
  ConfigObjectImpl() = delete; // do not allow default constructor
 
public:
  static ConfigObjectImpl* default_impl() noexcept;
 
public:
  const std::string& UID() const noexcept
  {
    std::lock_guard<std::mutex> scoped_lock(m_mutex); // be sure no one renames the object
    return m_id;
  }

  const std::string& class_name() const noexcept { return *m_class_name; }

  virtual const std::string contained_in() const = 0;
 
public:
  virtual void get(const std::string& attribute, bool& value) = 0;

  virtual void get(const std::string& attribute, uint8_t& value) = 0;

  virtual void get(const std::string& attribute, int8_t& value) = 0;

  virtual void get(const std::string& attribute, uint16_t& value) = 0;

  virtual void get(const std::string& attribute, int16_t& value) = 0;

  virtual void get(const std::string& attribute, uint32_t& value) = 0;

  virtual void get(const std::string& attribute, int32_t& value) = 0;

  virtual void get(const std::string& attribute, uint64_t& value) = 0;

  virtual void get(const std::string& attribute, int64_t& value) = 0;

  virtual void get(const std::string& attribute, float& value) = 0;

  virtual void get(const std::string& attribute, double& value) = 0;

  virtual void get(const std::string& attribute, std::string& value) = 0;

  virtual void get(const std::string& association, ConfigObject& value) = 0;
 
public:
  virtual void get(const std::string& attribute, std::vector<bool>& value) = 0;

  virtual void get(const std::string& attribute, std::vector<uint8_t>& value) = 0;

  virtual void get(const std::string& attribute, std::vector<int8_t>& value) = 0;

  virtual void get(const std::string& attribute, std::vector<uint16_t>& value) = 0;

  virtual void get(const std::string& attribute, std::vector<int16_t>& value) = 0;

  virtual void get(const std::string& attribute, std::vector<uint32_t>& value) = 0;

  virtual void get(const std::string& attribute, std::vector<int32_t>& value) = 0;

  virtual void get(const std::string& attribute, std::vector<uint64_t>& value) = 0;

  virtual void get(const std::string& attribute, std::vector<int64_t>& value) = 0;

  virtual void get(const std::string& attribute, std::vector<float>& value) = 0;

  virtual void get(const std::string& attribute, std::vector<double>& value) = 0;

  virtual void get(const std::string& attribute, std::vector<std::string>& value) = 0;

  virtual void get(const std::string& association, std::vector<ConfigObject>& value) = 0;
 
public:
  virtual bool rel(const std::string& name, std::vector<ConfigObject>& value) = 0;

  virtual void referenced_by(std::vector<ConfigObject>& value,
                             const std::string& association,
                             bool check_composite_only,
                             unsigned long rlevel,
                             const std::vector<std::string>* rclasses) const = 0;
 
public:
  virtual void set(const std::string& attribute, bool value) = 0;

  virtual void set(const std::string& attribute, uint8_t value) = 0;

  virtual void set(const std::string& attribute, int8_t value) = 0;

  virtual void set(const std::string& attribute, uint16_t value) = 0;

  virtual void set(const std::string& attribute, int16_t value) = 0;

  virtual void set(const std::string& attribute, uint32_t value) = 0;

  virtual void set(const std::string& attribute, int32_t value) = 0;

  virtual void set(const std::string& attribute, uint64_t value) = 0;

  virtual void set(const std::string& attribute, int64_t value) = 0;

  virtual void set(const std::string& attribute, float value) = 0;

  virtual void set(const std::string& attribute, double value) = 0;

  virtual void set(const std::string& attribute, const std::string& value) = 0;

  virtual void set_enum(const std::string& attribute, const std::string& value) = 0;

  virtual void set_class(const std::string& attribute, const std::string& value) = 0;

  virtual void set_date(const std::string& attribute, const std::string& value) = 0;

  virtual void set_time(const std::string& attribute, const std::string& value) = 0;
 
public:
  virtual void set(const std::string& attribute, const std::vector<bool>& value) = 0;

  virtual void set(const std::string& attribute, const std::vector<uint8_t>& value) = 0;

  virtual void set(const std::string& attribute, const std::vector<int8_t>& value) = 0;

  virtual void set(const std::string& attribute, const std::vector<uint16_t>& value) = 0;

  virtual void set(const std::string& attribute, const std::vector<int16_t>& value) = 0;

  virtual void set(const std::string& attribute, const std::vector<uint32_t>& value) = 0;

  virtual void set(const std::string& attribute, const std::vector<int32_t>& value) = 0;

  virtual void set(const std::string& attribute, const std::vector<uint64_t>& value) = 0;

  virtual void set(const std::string& attribute, const std::vector<int64_t>& value) = 0;

  virtual void set(const std::string& attribute, const std::vector<float>& value) = 0;

  virtual void set(const std::string& attribute, const std::vector<double>& value) = 0;

  virtual void set(const std::string& attribute, const std::vector<std::string>& value) = 0;

  virtual void set_enum(const std::string& attribute, const std::vector<std::string>& value) = 0;

  virtual void set_class(const std::string& attribute, const std::vector<std::string>& value) = 0;

  virtual void set_date(const std::string& attribute, const std::vector<std::string>& value) = 0;

  virtual void set_time(const std::string& attribute, const std::vector<std::string>& value) = 0;

  virtual void set(const std::string& association, const ConfigObject* value, bool skip_non_null_check) = 0;

  virtual void set(const std::string& association,
                   const std::vector<const ConfigObject*>& value,
                   bool skip_non_null_check) = 0;

  virtual void move(const std::string& at) = 0;

  virtual void rename(const std::string& new_id) = 0;

  virtual void clear() noexcept { ; } // by default nothing to do

  virtual void reset() = 0;

  bool is_deleted() const
  {
    if (m_state == dunedaq::conffwk::Unknown) {
      const_cast<ConfigObjectImpl*>(this)->reset();
    }
 
    return (m_state == dunedaq::conffwk::Deleted);
  }
 
protected:
  ConfigurationImpl* m_impl;             
  dunedaq::conffwk::ObjectState m_state; 
  std::string m_id;                      
  const std::string* m_class_name;       
  mutable std::mutex m_mutex;            
 
protected:
  void throw_if_deleted() const
  {
    if (is_deleted()) {
      throw dunedaq::conffwk::DeletedObject(ERS_HERE, m_class_name->c_str(), m_id.c_str());
    }
  }
 
private:
  // convert attribute values, if there is a configuration converter
 
  void convert(bool& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(uint8_t& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(int8_t& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(uint16_t& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(int16_t& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(uint32_t& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(int32_t& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(uint64_t& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(int64_t& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(float& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(double& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(std::string& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(ConfigObject&, const ConfigObject&, const std::string&) noexcept { ; }
 
  void convert(std::vector<bool>& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(std::vector<uint8_t>& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(std::vector<int8_t>& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(std::vector<uint16_t>& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(std::vector<int16_t>& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(std::vector<uint32_t>& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(std::vector<int32_t>& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(std::vector<uint64_t>& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(std::vector<int64_t>& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(std::vector<float>& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(std::vector<double>& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(std::vector<std::string>& value, const ConfigObject& obj, const std::string& attr_name) noexcept;
  void convert(std::vector<ConfigObject>&, const ConfigObject&, const std::string&) noexcept { ; }
};
 
} // namespace conffwk
} // namespace dunedaq
 
#endif // CONFFWK_CONFIGOBJECTIMPL_H_