base_subsystem_controller.hpp

Go to the documentation of this file.

#pragma once
 
/*
 * Copyright (C) 2021 LEIDOS.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
 
 
 
#include <memory>
 
#include "carma_msgs/msg/system_alert.hpp"
#include "ros2_lifecycle_manager/ros2_lifecycle_manager.hpp"
#include "rclcpp/rclcpp.hpp"
#include "carma_ros2_utils/carma_lifecycle_node.hpp"
#include "subsystem_controllers/base_subsystem_controller/base_subsystem_controller_config.hpp"
 
namespace subsystem_controllers
{
  class BaseSubsystemController : public carma_ros2_utils::CarmaLifecycleNode
  {
  public:
    
    BaseSubsystemController() = delete;
 
    explicit BaseSubsystemController(const rclcpp::NodeOptions &options);
 
    ~BaseSubsystemController() = default;
 
    void set_config(BaseSubSystemControllerConfig config);
 
    virtual void on_system_alert(const carma_msgs::msg::SystemAlert::UniquePtr msg);
 
    // Overrides
    virtual carma_ros2_utils::CallbackReturn handle_on_configure(const rclcpp_lifecycle::State &prev_state);
    virtual carma_ros2_utils::CallbackReturn handle_on_activate(const rclcpp_lifecycle::State &prev_state);
    virtual carma_ros2_utils::CallbackReturn handle_on_deactivate(const rclcpp_lifecycle::State &prev_state);
    virtual carma_ros2_utils::CallbackReturn handle_on_cleanup(const rclcpp_lifecycle::State &prev_state);
    virtual carma_ros2_utils::CallbackReturn handle_on_error(const rclcpp_lifecycle::State &prev_state, const std::string &exception_string);
    virtual carma_ros2_utils::CallbackReturn handle_on_shutdown(const rclcpp_lifecycle::State &prev_state);
 
  protected:
 
    std::vector<std::string> get_nodes_in_namespace(const std::string& node_namespace) const;
 
    std::vector<std::string> get_non_intersecting_set(const std::vector<std::string>& set_a, const std::vector<std::string>& set_b) const;
 
    ros2_lifecycle_manager::Ros2LifecycleManager lifecycle_mgr_;
 
    rclcpp::Subscription<carma_msgs::msg::SystemAlert>::SharedPtr system_alert_sub_;
 
    BaseSubSystemControllerConfig base_config_;
 
    //  when ever the respective handle_on_<event> methods (ie. handle_on_configure) are called. 
    //  by setting these flags to false an extending class chooses to implement that call itself. 
    //  flags for on_shutdown and on_error are explicitly not provided since either should always result in subsystem shutdown.
    //  Overriding the respective methods without calling the base version will achieve the same external behavior but will also result in some internal variables not being populated.
    //  For correct behavior these flags should be set in the constructor 
    bool trigger_managed_nodes_configure_from_base_class_ = true;
    bool trigger_managed_nodes_activate_from_base_class_ = true;
    bool trigger_managed_nodes_deactivate_from_base_class_ = true;
    bool trigger_managed_nodes_cleanup_from_base_class_ = true;
  };
 
} // namespace subsystem_controllers