Skip to main content

SetupMTCCartesianSequence Class

Given an existing MTC Task object and a sequence of target poses, appends MTC stages to plan a sequence of cartesian motions between the poses. More...

Declaration

class moveit_pro::behaviors::SetupMTCCartesianSequence { ... }

Included Headers

#include <setup_mtc_cartesian_sequence.hpp>

Base class

classSharedResourcesNode<BehaviorTreeNodeT>

The SharedResourcesNode class provides a BehaviorContext object when constructing a BehaviorTree.Cpp node. More...

Public Constructors Index

SetupMTCCartesianSequence (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)

Constructor for SetupMTCCartesianSequence behavior. More...

Public Member Functions Index

BT::NodeStatustick () override

Synchronous, blocking function that must return SUCCESS/FAILURE every time this action node is ticked by the behavior tree. More...

Public Static Functions Index

static BT::PortsListprovidedPorts ()

Custom tree nodes that have input and/or output ports must define them in this static function. More...

static BT::KeyValueVectormetadata ()

Description

Given an existing MTC Task object and a sequence of target poses, appends MTC stages to plan a sequence of cartesian motions between the poses.

Data Port NamePort TypeObject Type
taskBidirectionalstd::shared_ptr<moveit_pro::task_constructor::Task>
ik_frameInputstd::string
planning_group_nameInputstd::string
pose_stamped_vectorInputstd::vector<geometry_msgs::msg::PoseStamped>
monitored_stageInputstd::string
max_distanceInputdouble
joint_costsInputstd::vector<double>

Definition at line 34 of file setup_mtc_cartesian_sequence.hpp.

Public Constructors

SetupMTCCartesianSequence()

moveit_pro::behaviors::SetupMTCCartesianSequence::SetupMTCCartesianSequence (const std::string & name, const BT::NodeConfiguration & config, const std::shared_ptr< BehaviorContext > & shared_resources)

Constructor for SetupMTCCartesianSequence behavior.

Parameters
name

Name of the node. Must match the name used for this node in the behavior tree definition file (the .xml file).

config

Node configuration. Only used here because the BehaviorTree.CPP expects constructor signature with name and config first before custom constructor parameters.

shared_resources

Provides access to common resources such as the node handle and failure logger that are shared between all the behaviors that inherit from moveit_pro::behaviors::SharedResourcesNode.

Declaration at line 48 of file setup_mtc_cartesian_sequence.hpp, definition at line 47 of file setup_mtc_cartesian_sequence.cpp.

Public Member Functions

tick()

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

Synchronous, blocking function that must return SUCCESS/FAILURE every time this action node is ticked by the behavior tree.

Returns

Status of the node. Must be either SUCCESS/FAILURE (the node is "complete" for now). Cannot be RUNNING since this is a synchronous node.

Declaration at line 69 of file setup_mtc_cartesian_sequence.hpp, definition at line 85 of file setup_mtc_cartesian_sequence.cpp.

Public Static Functions

metadata()

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

Declaration at line 61 of file setup_mtc_cartesian_sequence.hpp, definition at line 79 of file setup_mtc_cartesian_sequence.cpp.

providedPorts()

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

Custom tree nodes that have input and/or output ports must define them in this static function.

This function must be static. It is a requirement set by the BehaviorTree.CPP library.

Returns

List of ports with the names and port info. The return value is for the internal use of the behavior tree.

Declaration at line 59 of file setup_mtc_cartesian_sequence.hpp, definition at line 53 of file setup_mtc_cartesian_sequence.cpp.


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


Generated via doxygen2docusaurus 2.2.2 by Doxygen 1.9.8.