Program Listing for File magnetic_field_sensor.hpp

↰ Return to documentation for file (include/semantic_components/magnetic_field_sensor.hpp)

// Copyright 2025 Aarav Gupta
//
// 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 SEMANTIC_COMPONENTS__MAGNETIC_FIELD_SENSOR_HPP_
#define SEMANTIC_COMPONENTS__MAGNETIC_FIELD_SENSOR_HPP_

#include <string>

#include "semantic_components/semantic_component_interface.hpp"
#include "sensor_msgs/msg/magnetic_field.hpp"

namespace semantic_components
{
class MagneticFieldSensor : public SemanticComponentInterface<sensor_msgs::msg::MagneticField>
{
public:
  explicit MagneticFieldSensor(const std::string & name)
  : SemanticComponentInterface(
      name, {name + "/" + "magnetic_field.x", name + "/" + "magnetic_field.y",
             name + "/" + "magnetic_field.z"})
  {
  }


  bool get_values_as_message(sensor_msgs::msg::MagneticField & message)
  {
    update_data_from_interfaces();
    message.magnetic_field.x = data_[0];
    message.magnetic_field.y = data_[1];
    message.magnetic_field.z = data_[2];
    return true;
  }

private:
  void update_data_from_interfaces()
  {
    for (auto i = 0u; i < data_.size(); ++i)
    {
      const auto data = state_interfaces_[i].get().get_optional();
      if (data.has_value())
      {
        data_[i] = data.value();
      }
    }
  }

  // Array to store the data of the magnetic field sensor
  std::array<double, 3> data_{{0.0, 0.0, 0.0}};
};

}  // namespace semantic_components

#endif  // SEMANTIC_COMPONENTS__MAGNETIC_FIELD_SENSOR_HPP_