kernel_config.h

Go to the documentation of this file.

// === kernel_config.h =================================================================================================
//                                               Sen Infrastructure
//                   Released under the Apache License v2.0 (SPDX-License-Identifier Apache-2.0).
//                                    See the LICENSE.txt file for more information.
//                   © Airbus SAS, Airbus Helicopters, and Airbus Defence and Space SAU/GmbH/SAS.
// =====================================================================================================================
 
#ifndef SEN_KERNEL_KERNEL_CONFIG_H
#define SEN_KERNEL_KERNEL_CONFIG_H
 
// sen
#include "sen/kernel/detail/kernel_fwd.h"
 
// generated code
#include "stl/sen/kernel/basic_types.stl.h"
 
// std
#include <filesystem>
 
namespace sen::kernel
{

struct ComponentContext
{
  Component* instance = nullptr;
  ComponentConfig config {};
  ComponentInfo info {};
};

class KernelConfig final
{
public:
  struct ComponentPluginToLoad
  {
    const std::string path;  
    ComponentConfig config;  
    VarMap params;           
  };

  struct ComponentToLoad
  {
    ComponentContext component;  
    ComponentConfig config;      
    VarMap params;               
  };

  struct ObjectConfig
  {
    std::string name;       
    std::string className;  
    BusAddress bus;         
    VarMap params;          
  };

  struct PipelineToLoad
  {
    std::string name;                   
    ComponentConfig config;             
    StringList imports;                 
    std::vector<ObjectConfig> objects;  
    Duration period;                    
    VarMap params;                      
  };
 
public:  // special members
  KernelConfig() = default;
  ~KernelConfig() noexcept = default;
  SEN_COPY_ASSIGN(KernelConfig) = default;
  SEN_MOVE_ASSIGN(KernelConfig) = default;
  SEN_COPY_CONSTRUCT(KernelConfig) = default;
  SEN_MOVE_CONSTRUCT(KernelConfig) = default;
 
public:  // execution management
  void setParams(KernelParams params) noexcept;

  [[nodiscard]] const KernelParams& getParams() const noexcept;
 
public:  // main configuration settings
  void addToLoad(ComponentPluginToLoad plugin);

  void addToLoad(ComponentToLoad component);

  void addToLoad(PipelineToLoad pipeline);
 
public:
  [[nodiscard]] const std::vector<ComponentPluginToLoad>& getPluginsToLoad() const noexcept;

  [[nodiscard]] const std::vector<ComponentToLoad>& getComponentsToLoad() const noexcept;

  [[nodiscard]] const std::vector<PipelineToLoad>& getPipelinesToLoad() const noexcept;
 
public:
  void setConfigFilePath(const std::filesystem::path& path) noexcept { path_ = path; }

  [[nodiscard]] std::filesystem::path getConfigFilePath() const noexcept { return path_; }
 
private:
  std::vector<ComponentPluginToLoad> pluginsToLoad_;
  std::vector<ComponentToLoad> componentsToLoad_;
  std::vector<PipelineToLoad> pipelinesToLoad_;
  KernelParams params_ {};
  std::filesystem::path path_ {};
};
 
}  // namespace sen::kernel
 
#endif  // SEN_KERNEL_KERNEL_CONFIG_H