MoveIt Pro Behavior Interface  5.0.1
Library for developing custom behaviors for use in MoveIt Pro
moveit_studio::behaviors::SaveToYaml< T > Class Template Referencefinal

Save the contents of a ROS 2 message type to a YAML file in a specified namespace. Note: This Behavior template saves the pose into the ~/.config/moveit_pro/robot_config/objectives folder. More...

#include <save_to_yaml.hpp>

Inheritance diagram for moveit_studio::behaviors::SaveToYaml< T >:
Collaboration diagram for moveit_studio::behaviors::SaveToYaml< T >:

Public Member Functions

 SaveToYaml (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources)
 
BT::NodeStatus tick () override
 
BT::PortsList providedPorts ()
 
BT::KeyValueVector metadata ()
 
BT::PortsList providedPorts ()
 
BT::KeyValueVector metadata ()
 
BT::PortsList providedPorts ()
 
BT::KeyValueVector metadata ()
 
- Public Member Functions inherited from moveit_studio::behaviors::SharedResourcesNode< BT::SyncActionNode >
 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 ()
 

Static Public Attributes

static const char kPortIDYamlFilename [] = "yaml_filename"
 
static const char kPortIDNamespace [] = "namespace"
 
static const char kPortIDMessage [] = "message"
 

Additional Inherited Members

- Protected Attributes inherited from moveit_studio::behaviors::SharedResourcesNode< BT::SyncActionNode >
std::shared_ptr< BehaviorContextshared_resources_
 

Detailed Description

template<typename T>
class moveit_studio::behaviors::SaveToYaml< T >

Save the contents of a ROS 2 message type to a YAML file in a specified namespace. Note: This Behavior template saves the pose into the ~/.config/moveit_pro/robot_config/objectives folder.

Template Parameters
TDetermines the type of object to save to the YAML file.
Data Port Name Port Type Object Type
yaml_filename input std::string
namespace input std::string
message input T

Constructor & Destructor Documentation

◆ SaveToYaml()

template<typename T >
moveit_studio::behaviors::SaveToYaml< T >::SaveToYaml ( const std::string &  name,
const BT::NodeConfiguration &  config,
const std::shared_ptr< BehaviorContext > &  shared_resources 
)

Member Function Documentation

◆ metadata() [1/4]

BT::KeyValueVector moveit_studio::behaviors::SaveToYaml< geometry_msgs::msg::Pose >::metadata ( )

◆ metadata() [2/4]

BT::KeyValueVector moveit_studio::behaviors::SaveToYaml< geometry_msgs::msg::PoseStamped >::metadata ( )

◆ metadata() [3/4]

BT::KeyValueVector moveit_studio::behaviors::SaveToYaml< trajectory_msgs::msg::JointTrajectory >::metadata ( )

◆ metadata() [4/4]

template<typename T >
BT::KeyValueVector moveit_studio::behaviors::SaveToYaml< T >::metadata
static

◆ providedPorts() [1/4]

BT::PortsList moveit_studio::behaviors::SaveToYaml< geometry_msgs::msg::Pose >::providedPorts ( )

◆ providedPorts() [2/4]

BT::PortsList moveit_studio::behaviors::SaveToYaml< geometry_msgs::msg::PoseStamped >::providedPorts ( )

◆ providedPorts() [3/4]

BT::PortsList moveit_studio::behaviors::SaveToYaml< trajectory_msgs::msg::JointTrajectory >::providedPorts ( )

◆ providedPorts() [4/4]

template<typename T >
BT::PortsList moveit_studio::behaviors::SaveToYaml< T >::providedPorts
static

◆ tick()

template<typename T >
BT::NodeStatus moveit_studio::behaviors::SaveToYaml< T >::tick
override

Member Data Documentation

◆ kPortIDMessage

template<typename T >
const char moveit_studio::behaviors::SaveToYaml< T >::kPortIDMessage = "message"
static

◆ kPortIDNamespace

template<typename T >
const char moveit_studio::behaviors::SaveToYaml< T >::kPortIDNamespace = "namespace"
static

◆ kPortIDYamlFilename

template<typename T >
const char moveit_studio::behaviors::SaveToYaml< T >::kPortIDYamlFilename = "yaml_filename"
static

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