hardware_component.hpp

// Copyright 2020 - 2021 ros2_control Development Team
//
// 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.
 
#ifndef HARDWARE_INTERFACE__HARDWARE_COMPONENT_HPP_
#define HARDWARE_INTERFACE__HARDWARE_COMPONENT_HPP_
 
#include <cstdint>
#include <memory>
#include <mutex>
#include <string>
#include <vector>
 
#include "hardware_interface/handle.hpp"
#include "hardware_interface/hardware_component_interface.hpp"
#include "hardware_interface/hardware_info.hpp"
#include "hardware_interface/types/hardware_component_params.hpp"
#include "hardware_interface/types/hardware_interface_return_values.hpp"
#include "hardware_interface/types/statistics_types.hpp"
#include "rclcpp/duration.hpp"
#include "rclcpp/logger.hpp"
#include "rclcpp/node_interfaces/node_clock_interface.hpp"
#include "rclcpp/time.hpp"
#include "rclcpp_lifecycle/state.hpp"
 
namespace hardware_interface
{
class HardwareComponentInterface;
 
class HardwareComponent final
{
public:
  HardwareComponent() = default;
 
  explicit HardwareComponent(std::unique_ptr<HardwareComponentInterface> impl);
 
  explicit HardwareComponent(HardwareComponent && other) noexcept;
 
  ~HardwareComponent();
 
  HardwareComponent(const HardwareComponent & other) = delete;
 
  HardwareComponent & operator=(const HardwareComponent & other) = delete;
 
  HardwareComponent & operator=(HardwareComponent && other) = delete;
 
  [[deprecated(
    "Replaced by const rclcpp_lifecycle::State & initialize(const "
    "hardware_interface::HardwareComponentParams & params).")]]
  const rclcpp_lifecycle::State & initialize(
    const HardwareInfo & component_info, rclcpp::Logger logger,
    rclcpp::node_interfaces::NodeClockInterface::SharedPtr clock_interface);
 
  [[deprecated(
    "Replaced by const rclcpp_lifecycle::State & initialize(const "
    "hardware_interface::HardwareComponentParams & params).")]]
  const rclcpp_lifecycle::State & initialize(
    const HardwareInfo & component_info, rclcpp::Logger logger, rclcpp::Clock::SharedPtr clock);
 
  const rclcpp_lifecycle::State & initialize(
    const hardware_interface::HardwareComponentParams & params);
 
  const rclcpp_lifecycle::State & configure();
 
  const rclcpp_lifecycle::State & cleanup();
 
  const rclcpp_lifecycle::State & shutdown();
 
  const rclcpp_lifecycle::State & activate();
 
  const rclcpp_lifecycle::State & deactivate();
 
  const rclcpp_lifecycle::State & error();
 
  std::vector<StateInterface::ConstSharedPtr> export_state_interfaces();
 
  std::vector<CommandInterface::SharedPtr> export_command_interfaces();
 
  return_type prepare_command_mode_switch(
    const std::vector<std::string> & start_interfaces,
    const std::vector<std::string> & stop_interfaces);
 
  return_type perform_command_mode_switch(
    const std::vector<std::string> & start_interfaces,
    const std::vector<std::string> & stop_interfaces);
 
  const std::string & get_name() const;
 
  const std::string & get_group_name() const;
 
  const rclcpp_lifecycle::State & get_lifecycle_state() const;
 
  uint8_t get_lifecycle_id() const;
 
  const rclcpp::Time & get_last_read_time() const;
 
  const rclcpp::Time & get_last_write_time() const;
 
  const HardwareComponentStatisticsCollector & get_read_statistics() const;
 
  const HardwareComponentStatisticsCollector & get_write_statistics() const;
 
  return_type read(const rclcpp::Time & time, const rclcpp::Duration & period);
 
  return_type write(const rclcpp::Time & time, const rclcpp::Duration & period);
 
  std::recursive_mutex & get_mutex();
 
private:
  std::unique_ptr<HardwareComponentInterface> impl_;
  mutable std::recursive_mutex component_mutex_;
  // Last read cycle time
  rclcpp::Time last_read_cycle_time_;
  // Last write cycle time
  rclcpp::Time last_write_cycle_time_;
  // Component statistics
  HardwareComponentStatisticsCollector read_statistics_;
  HardwareComponentStatisticsCollector write_statistics_;
};
 
}  // namespace hardware_interface
#endif  // HARDWARE_INTERFACE__HARDWARE_COMPONENT_HPP_