MoveIt Pro Behavior
Core Behaviors for MoveIt Pro
moveit_studio::behaviors::GetMasks2DAction Class Referencefinal

Calls an action server that uses moveit_studio_vision_msgs::action::GetMasks2D interface and outputs the results on the masks2d port. More...

#include <get_masks2d_action.hpp>

Inheritance diagram for moveit_studio::behaviors::GetMasks2DAction:
Collaboration diagram for moveit_studio::behaviors::GetMasks2DAction:

Public Member Functions

 GetMasks2DAction (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)
 
tl::expected< std::string, std::string > getActionName () override
 Gets the name of the action to use when initializing the action client. More...
 
- Public Member Functions inherited from moveit_studio::behaviors::ActionClientBehaviorBase< GetMasks2D >
 ActionClientBehaviorBase (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)
 Constructs ActionClientBehaviorBase using the RclcppClientInterface. More...
 
 ActionClientBehaviorBase (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources, std::unique_ptr< ClientInterfaceBase > client_interface)
 Constructs ActionClientBehaviorBase using a user-provided implementation of ClientInterfaceBase. More...
 
virtual ~ActionClientBehaviorBase ()=default
 
- Public Member Functions inherited from moveit_studio::behaviors::AsyncBehaviorBase
 AsyncBehaviorBase (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)
 
virtual ~AsyncBehaviorBase ()=default
 
BT::NodeStatus onStart () override
 Required implementation of BT::StatefulActionNode::onStart(). More...
 
BT::NodeStatus onRunning () override
 Required implementation of BT::StatefulActionNode::onRunning(). More...
 
void onHalted () override
 Required implementation of BT::StatefulActionNode::onHalted(). More...
 
void resetStatus ()
 Resets the internal status of this node. More...
 
- Public Member Functions inherited from moveit_studio::behaviors::SharedResourcesNode< BT::StatefulActionNode >
 SharedResourcesNode (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)
 Constructor for SharedResourcesNode. Called by BT::BehaviorTreeFactory when creating a new behavior tree containing this node. More...
 

Static Public Member Functions

static BT::PortsList providedPorts ()
 
static BT::KeyValueVector metadata ()
 

Additional Inherited Members

- Public Types inherited from moveit_studio::behaviors::ActionClientBehaviorBase< GetMasks2D >
using ClientGoalHandle = rclcpp_action::ClientGoalHandle< GetMasks2D >
 
- Protected Member Functions inherited from moveit_studio::behaviors::ActionClientBehaviorBase< GetMasks2D >
virtual tl::expected< bool, std::string > processResult (const std::shared_ptr< typename ActionT::Result >)
 Optional user-provided function to process the action result after the action has finished. More...
 
virtual void processFeedback (const std::shared_ptr< const typename ActionT::Feedback >)
 Optional user-provided function to process feedback sent by the action server. More...
 
virtual std::string getAbortedMessage (const std::shared_ptr< const typename ActionT::Result >) const
 Optional user-provided function to retrieve and surface an error message from an aborted action server result. More...
 
- Protected Member Functions inherited from moveit_studio::behaviors::AsyncBehaviorBase
void notifyCanHalt ()
 Called when runAsync() finishes to notify onHalted() that the async process has finished. More...
 
- Protected Attributes inherited from moveit_studio::behaviors::SharedResourcesNode< BT::StatefulActionNode >
std::shared_ptr< BehaviorContextshared_resources_
 

Detailed Description

Calls an action server that uses moveit_studio_vision_msgs::action::GetMasks2D interface and outputs the results on the masks2d port.

Data Port Name Port Type Object Type
image Input sensor_msgs::msg::Image
action_name Input std::string
valid_classes Input std::vector<std::string>
valid_points Input std::vector<geometry_msgs::msg::PointStamped>
max_nms_iou Input double
min_relative_area Input double
max_relative_area Input double
timeout_sec Input double
masks2d Output std::vector<moveit_studio_vision_msgs::msg::Mask2D>

Constructor & Destructor Documentation

◆ GetMasks2DAction()

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

Member Function Documentation

◆ getActionName()

tl::expected< std::string, std::string > moveit_studio::behaviors::GetMasks2DAction::getActionName ( )
overridevirtual

Gets the name of the action to use when initializing the action client.

Returns
The name of the action for the GetMasks2D action client.

Implements moveit_studio::behaviors::ActionClientBehaviorBase< GetMasks2D >.

◆ metadata()

BT::KeyValueVector moveit_studio::behaviors::GetMasks2DAction::metadata ( )
static

◆ providedPorts()

BT::PortsList moveit_studio::behaviors::GetMasks2DAction::providedPorts ( )
static

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