Skip to main content

AddOverageToPath Class

Adds overage waypoints to both ends of a path by extending along a specified local axis. More...

Declaration

class moveit_pro::behaviors::AddOverageToPath { ... }

Included Headers

#include <add_overage_to_path.hpp>

Base class

classBT::SyncActionNode

Public Constructors Index

AddOverageToPath (const std::string &name, const BT::NodeConfiguration &config)

Constructor. More...

Public Member Functions Index

BT::NodeStatustick () override

Execute the behavior: extend the path with overage waypoints at both ends. More...

Public Static Functions Index

static BT::PortsListprovidedPorts ()

Declare input and output ports. More...

static BT::KeyValueVectormetadata ()

Provide metadata for the MoveIt Studio Developer Tool UI. More...

Description

Adds overage waypoints to both ends of a path by extending along a specified local axis.

This behavior takes a vector of waypoints and extends the path by adding additional waypoints at both the start and end. The new waypoints maintain the same orientation as their respective end waypoints and are spaced evenly along the specified axis (default: Z-axis) over the specified overage distance. The extension direction is chosen to move away from the adjacent waypoint.

Data Port NamePort TypeObject Type
waypointsinputstd::vector<geometry_msgs::msg::PoseStamped>
overage_distanceinputdouble
num_waypointsinputint
axisinputstd::string
output_waypointsoutputstd::vector<geometry_msgs::msg::PoseStamped>

Definition at line 33 of file add_overage_to_path.hpp.

Public Constructors

AddOverageToPath()

moveit_pro::behaviors::AddOverageToPath::AddOverageToPath (const std::string & name, const BT::NodeConfiguration & config)

Constructor.

Parameters
name

The name of a particular instance of this Behavior.

config

Runtime configuration for this Behavior, including port mappings.

Declaration at line 41 of file add_overage_to_path.hpp, definition at line 37 of file add_overage_to_path.cpp.

Public Member Functions

tick()

BT::NodeStatus moveit_pro::behaviors::AddOverageToPath::tick ()

Execute the behavior: extend the path with overage waypoints at both ends.

Returns

SUCCESS if overage waypoints were added, FAILURE otherwise.

Declaration at line 59 of file add_overage_to_path.hpp, definition at line 59 of file add_overage_to_path.cpp.

Public Static Functions

metadata()

BT::KeyValueVector moveit_pro::behaviors::AddOverageToPath::metadata ()
static

Provide metadata for the MoveIt Studio Developer Tool UI.

Returns

A BT::KeyValueVector containing the Behavior metadata.

Declaration at line 53 of file add_overage_to_path.hpp, definition at line 54 of file add_overage_to_path.cpp.

providedPorts()

BT::PortsList moveit_pro::behaviors::AddOverageToPath::providedPorts ()
static

Declare input and output ports.

Returns

The list of ports for this behavior.

Declaration at line 47 of file add_overage_to_path.hpp, definition at line 42 of file add_overage_to_path.cpp.


The documentation for this class was generated from the following files:


Generated via doxygen2docusaurus 2.2.2 by Doxygen 1.9.8.