Skip to content

Commit

Permalink
Readd lost docstrings
Browse files Browse the repository at this point in the history
Signed-off-by: Christopher Strøm <[email protected]>
  • Loading branch information
chrstrom committed Aug 8, 2024
1 parent a7b6cdd commit ae04a05
Showing 1 changed file with 13 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
/**
* @file allocator_ros.hpp
* @brief ThrusterAllocator class, which
* allocates thrust to the ASV's thrusters based on the desired body frame
* forces.
*/

#ifndef VORTEX_ALLOCATOR_ALLOCATOR_ROS_HPP
#define VORTEX_ALLOCATOR_ALLOCATOR_ROS_HPP

Expand Down Expand Up @@ -30,6 +37,12 @@ class ThrusterAllocator : public rclcpp_lifecycle::LifecycleNode {
on_shutdown(const rclcpp_lifecycle::State &);

private:
/**
* @brief Calculates the allocated
* thrust based on the body frame forces. It then saturates the output vector
* between min and max values and publishes the thruster forces to the topic
* "thrust/thruster_forces".
*/
void calculate_thrust_timer_cb();
void wrench_callback(const geometry_msgs::msg::Wrench &msg);

Expand Down

0 comments on commit ae04a05

Please sign in to comment.