Skip to content

RelativeHeading

Path following using RelativeHeading's algorithm for path following*. More...

#include <RelativeHeading.h>

Inherits from PathFollowing

Public Functions

Name
RelativeHeading(double kx, double ky, double kz, const Eigen::Vector2d & p_sat, double yaw_offset, ros::Publisher surge_pub, ros::Publisher sway_pub, ros::Publisher yaw_pub, ros::Publisher rabbit_pub)
Constructor method for the Path Following class.
virtual bool setPFGains(std::vector< double > gains) override
Method to update the gains, given a vector of doubles.
virtual void callPFController(double dt) override
Method that implements the path following control law.
virtual void publish_private() override
Method to publish_private the data from the path following.
virtual void start() override
Method used in the first run to do initial setup.
virtual bool stop() override
Method used to check whether we reached the end of the algorithm or not.
virtual bool reset() override
Method used to reset the algorithm control parameters when running the algorithm more than once.
virtual bool resetVirtualTarget(float value) override
Method to reset the virtual target of the vehicle (gamma) to a pre-specified value. Not all controllers need this (example: Samson, Fossen which use the closest point)

Additional inherited members

Public Functions inherited from PathFollowing

Name
virtual ~PathFollowing()
Virtual destructor for the abstract pathfollowing class.
void publish()
Method to publish the data given by the algorithm.
void UpdateVehicleState(const VehicleState & vehicle_state)
Method to update the vehicle state used by the controller.
void UpdatePathState(const PathState & path_state)
Method to update the path state used by the controller.
void setPFollowingDebugPublisher(const ros::Publisher & pfollowing_debug_pub)
Method to set common publishers.

Protected Functions inherited from PathFollowing

Name
double algConvert(double alg_new, double alg_old, double alg_out_old)
Auxiliar method to smooth out the angle to be used by path following algorithms.

Protected Attributes inherited from PathFollowing

Name
VehicleState vehicle_state_
Variable to store the state of the vehicle.
PathState path_state_
Variable to store the state of the path.
PFollowingDebug pfollowing_debug_
Variable to store the state of the path.
ros::Publisher pfollowing_debug_pub_

Detailed Description

class RelativeHeading;

Path following using RelativeHeading's algorithm for path following*.

Author:

  • Francisco Rego
  • Andre Potes
  • Marcelo Jacinto

Version: 1.0a

Date: 2021

Copyright: MIT

This algorithm support: Controls:

  • yaw
  • surge
  • sway Supports Cooperative Path Following - True Contains Currents Observers - False

Public Functions Documentation

function RelativeHeading

RelativeHeading(
    double kx,
    double ky,
    double kz,
    const Eigen::Vector2d & p_sat,
    double yaw_offset,
    ros::Publisher surge_pub,
    ros::Publisher sway_pub,
    ros::Publisher yaw_pub,
    ros::Publisher rabbit_pub
)

Constructor method for the Path Following class.

Parameters:

  • surge_pub The ROS surge publisher
  • sway_pub The ROS sway publisher
  • yaw_pub The ROS yaw publisher
  • rabbit_pub The ROS rabbit publisher

function setPFGains

virtual bool setPFGains(
    std::vector< double > gains
) override

Method to update the gains, given a vector of doubles.

Parameters:

  • gains A vector of gains to update in the controller The default order is: TODO

Return: a boolean which represents the success of the operation

Reimplements: PathFollowing::setPFGains

function callPFController

virtual void callPFController(
    double dt
) override

Method that implements the path following control law.

Parameters:

  • dt The time step between last call and current call (in seconds)

Reimplements: PathFollowing::callPFController

function publish_private

virtual void publish_private() override

Method to publish_private the data from the path following.

Reimplements: PathFollowing::publish_private

function start

virtual void start() override

Method used in the first run to do initial setup.

Reimplements: PathFollowing::start

function stop

virtual bool stop() override

Method used to check whether we reached the end of the algorithm or not.

Return: The success of the operation

Reimplements: PathFollowing::stop

Check if the gamma is greater then the gamma max of the path If so, we have reached the end

function reset

virtual bool reset() override

Method used to reset the algorithm control parameters when running the algorithm more than once.

Return: Whether the reset was made successfully or not

Reimplements: PathFollowing::reset

function resetVirtualTarget

virtual bool resetVirtualTarget(
    float value
) override

Method to reset the virtual target of the vehicle (gamma) to a pre-specified value. Not all controllers need this (example: Samson, Fossen which use the closest point)

Return: Whether the reset was made successfully or not

Reimplements: PathFollowing::resetVirtualTarget

Updated on 2022-09-15 at 17:51:33 +0000

Last update: September 15, 2022
Back to top