Session.hpp

Go to the documentation of this file.

// *** this file is generated by oksdalgen, do not modify it ***
 
#ifndef _Session_0_dunedaq__confmodel_0_confmodel_H_
#define _Session_0_dunedaq__confmodel_0_confmodel_H_
 
#include <stdint.h>   // to define 64 bits types
#include <iostream>
#include <sstream>
#include <string>
#include <map>
#include <vector>
 
#include "conffwk/Configuration.hpp"
#include "conffwk/DalObject.hpp"
 
 
  // forward declaration for classes used in relationships and algorithms
 
namespace dunedaq {
  namespace confmodel {
    class Application;
    class Component;
    class ConnectivityService;
    class DetectorConfig;
    class OpMonURI;
    class ResourceBase;
    class Segment;
    class VariableBase;
  }
}
 
 
  // prologue of method Session::set_disabled()
 
#include "confmodel/disabled-components.hpp"
 
namespace dunedaq {
  namespace confmodel {
 
    class Session : public virtual dunedaq::conffwk::DalObject {
 
      friend class conffwk::Configuration;
      friend class conffwk::DalObject;
      friend class conffwk::DalFactory;
      friend class conffwk::DalRegistry;
 
      protected:
 
        Session(conffwk::DalRegistry& db, const conffwk::ConfigObject& obj) noexcept;
        virtual ~Session() noexcept;
        virtual void init(bool init_children);
 
      public:
 
        static const std::string& s_class_name;
 
 
        virtual void print(unsigned int offset, bool print_header, std::ostream& s) const;
 
 
        virtual std::vector<const dunedaq::conffwk::DalObject *> get(const std::string& name, bool upcast_unregistered = true) const;
 
 
      protected:
 
        bool get(const std::string& name, std::vector<const dunedaq::conffwk::DalObject *>& vec, bool upcast_unregistered, bool first_call) const;
 
 
      private:
 
        std::string m_description;
        uint32_t m_data_request_timeout_ms;
        uint32_t m_data_rate_slowdown_factor;
        std::string m_rte_script;
        std::string m_controller_log_level;
        std::string m_log_path;
        const dunedaq::confmodel::ConnectivityService* m_connectivity_service;
        std::vector<const dunedaq::confmodel::VariableBase*> m_environment;
        std::vector<const dunedaq::confmodel::ResourceBase*> m_disabled;
        const dunedaq::confmodel::Segment* m_segment;
        std::vector<const dunedaq::confmodel::Application*> m_infrastructure_applications;
        const dunedaq::confmodel::DetectorConfig* m_detector_configuration;
        const dunedaq::confmodel::OpMonURI* m_opmon_uri;
 
          // extension of method Session::set_disabled()
        friend class DisabledComponents;
        friend class Component;
        mutable dunedaq::confmodel::DisabledComponents m_disabled_components; 
 
 
      public:
 
          // attribute names
 
        inline static const std::string s_description = "description";
        inline static const std::string s_data_request_timeout_ms = "data_request_timeout_ms";
        inline static const std::string s_data_rate_slowdown_factor = "data_rate_slowdown_factor";
        inline static const std::string s_rte_script = "rte_script";
        inline static const std::string s_controller_log_level = "controller_log_level";
        inline static const std::string s_log_path = "log_path";
 
        static const std::string& __get_description_str() noexcept { return s_description; }
        static const std::string& __get_data_request_timeout_ms_str() noexcept { return s_data_request_timeout_ms; }
        static const std::string& __get_data_rate_slowdown_factor_str() noexcept { return s_data_rate_slowdown_factor; }
        static const std::string& __get_rte_script_str() noexcept { return s_rte_script; }
        static const std::string& __get_controller_log_level_str() noexcept { return s_controller_log_level; }
        static const std::string& __get_log_path_str() noexcept { return s_log_path; }
 
 
        const std::string&
        get_description() const
          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_description;
          }
 
        void
        set_description(const std::string& value)
          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_ref(s_description, value);
          }
 
 
        uint32_t
        get_data_request_timeout_ms() const
          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_data_request_timeout_ms;
          }
 
        void
        set_data_request_timeout_ms(uint32_t value)
          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_val(s_data_request_timeout_ms, value);
          }
 
 
        uint32_t
        get_data_rate_slowdown_factor() const
          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_data_rate_slowdown_factor;
          }
 
        void
        set_data_rate_slowdown_factor(uint32_t value)
          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_val(s_data_rate_slowdown_factor, value);
          }
 
 
        const std::string&
        get_rte_script() const
          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_rte_script;
          }
 
        void
        set_rte_script(const std::string& value)
          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_ref(s_rte_script, value);
          }
 
 
        struct Controller_log_level {
          inline static const std::string CRITICAL = "CRITICAL";
          inline static const std::string ERROR = "ERROR";
          inline static const std::string WARNING = "WARNING";
          inline static const std::string INFO = "INFO";
          inline static const std::string DEBUG = "DEBUG";
        };
 
        const std::string&
        get_controller_log_level() const
          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_controller_log_level;
          }
 
        void
        set_controller_log_level(const std::string& value)
          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_enum(s_controller_log_level, value);
          }
 
 
        const std::string&
        get_log_path() const
          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_log_path;
          }
 
        void
        set_log_path(const std::string& value)
          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_ref(s_log_path, value);
          }
 
 
          // relationship names
 
        inline static const std::string s_connectivity_service = "connectivity_service";
        inline static const std::string s_environment = "environment";
        inline static const std::string s_disabled = "disabled";
        inline static const std::string s_segment = "segment";
        inline static const std::string s_infrastructure_applications = "infrastructure_applications";
        inline static const std::string s_detector_configuration = "detector_configuration";
        inline static const std::string s_opmon_uri = "opmon_uri";
 
        static const std::string& __get_connectivity_service_str() noexcept { return s_connectivity_service; }
        static const std::string& __get_environment_str() noexcept { return s_environment; }
        static const std::string& __get_disabled_str() noexcept { return s_disabled; }
        static const std::string& __get_segment_str() noexcept { return s_segment; }
        static const std::string& __get_infrastructure_applications_str() noexcept { return s_infrastructure_applications; }
        static const std::string& __get_detector_configuration_str() noexcept { return s_detector_configuration; }
        static const std::string& __get_opmon_uri_str() noexcept { return s_opmon_uri; }
 
 
        const dunedaq::confmodel::ConnectivityService *
        get_connectivity_service() const
        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          return m_connectivity_service;
        }
 
 
        void
        set_connectivity_service(const dunedaq::confmodel::ConnectivityService * value);
 
        const std::vector<const dunedaq::confmodel::VariableBase*>&
        get_environment() const
        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          return m_environment;
        }
 
 
        void
        set_environment(const std::vector<const dunedaq::confmodel::VariableBase*>& value);
 
        const std::vector<const dunedaq::confmodel::ResourceBase*>&
        get_disabled() const
        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          return m_disabled;
        }
 
 
        void
        set_disabled(const std::vector<const dunedaq::confmodel::ResourceBase*>& value);
 
        const dunedaq::confmodel::Segment *
        get_segment() const
        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          if (!m_segment)
            {
              std::ostringstream text;
              text << "relationship \"" << s_segment << "\" of object " << this << " is not set";
              throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
            }
          return m_segment;
        }
 
 
        void
        set_segment(const dunedaq::confmodel::Segment * value);
 
        const std::vector<const dunedaq::confmodel::Application*>&
        get_infrastructure_applications() const
        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          return m_infrastructure_applications;
        }
 
 
        void
        set_infrastructure_applications(const std::vector<const dunedaq::confmodel::Application*>& value);
 
        const dunedaq::confmodel::DetectorConfig *
        get_detector_configuration() const
        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          if (!m_detector_configuration)
            {
              std::ostringstream text;
              text << "relationship \"" << s_detector_configuration << "\" of object " << this << " is not set";
              throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
            }
          return m_detector_configuration;
        }
 
 
        void
        set_detector_configuration(const dunedaq::confmodel::DetectorConfig * value);
 
        const dunedaq::confmodel::OpMonURI *
        get_opmon_uri() const
        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          if (!m_opmon_uri)
            {
              std::ostringstream text;
              text << "relationship \"" << s_opmon_uri << "\" of object " << this << " is not set";
              throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
            }
          return m_opmon_uri;
        }
 
 
        void
        set_opmon_uri(const dunedaq::confmodel::OpMonURI * value);
 
 
      public:
 
          // user-defined algorithms
 
        std::vector<const dunedaq::confmodel::Application *> get_all_applications() const;
 
 
        std::vector<const dunedaq::confmodel::Application *> get_enabled_applications() const;
 
 
        void set_disabled(const std::set<const dunedaq::confmodel::Component *>& objs) const;
 
 
        void set_enabled(const std::set<const dunedaq::confmodel::Component *>& objs) const;
    };
 
      // out stream operator
 
    inline std::ostream& operator<<(std::ostream& s, const Session& obj)
      {
        return obj.print_object(s);
      }
 
    typedef std::vector<const Session*>::const_iterator SessionIterator;
 
  }
}
 
#endif