Skip to main content

LoadMultipleFromYaml Class Template

Loads types from a YAML file, and returns them as a vector in an output port. More...

Declaration​

template <typename T>
class moveit_pro::behaviors::LoadMultipleFromYaml<T> { ... }

Included Headers​

#include <load_from_yaml.hpp>

Base class​

classSharedResourcesNode<BehaviorTreeNodeT>

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

Public Constructors Index​

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

Public Member Functions Index​

template <typename T>
BT::NodeStatustick () override
template <typename T>
BT::PortsListprovidedPorts ()
template <typename T>
BT::KeyValueVectormetadata ()
template <typename T>
BT::PortsListprovidedPorts ()
template <typename T>
BT::KeyValueVectormetadata ()
template <typename T>
BT::PortsListprovidedPorts ()
template <typename T>
BT::KeyValueVectormetadata ()
template <typename T>
BT::PortsListprovidedPorts ()
template <typename T>
BT::KeyValueVectormetadata ()
template <typename T>
BT::PortsListprovidedPorts ()
template <typename T>
BT::KeyValueVectormetadata ()

Public Static Functions Index​

template <typename T>
static BT::PortsListprovidedPorts ()
template <typename T>
static BT::KeyValueVectormetadata ()

Public Static Attributes Index​

template <typename T>
static const charkPortIDInput[] = "file_path"
template <typename T>
static const charkPortIDOutput[] = "output"

Description​

Loads types from a YAML file, and returns them as a vector in an output port.

This is a templated behavior to load any type from a YAML file, as long as a YAML conversion function has been defined for the type (see yaml_parsing_tools.hpp). The YAML file can contain one or multiple instances of the type. In any case, an std::vector<T> will be returned, even if the file contains a single element.

In case of multiple messages, the YAML file is expected to be formatted as a multi-document YAML, e.g. for a type with 'x' and 'y' fields, this YAML contents would return an std::vector with two elements:

x: 0.1

Definition at line 66 of file load_from_yaml.hpp.

Public Constructors​

LoadMultipleFromYaml()​

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

Declaration at line 72 of file load_from_yaml.hpp, definition at line 254 of file load_from_yaml_impl.hpp.

Public Member Functions​

metadata()​

template <typename T>
BT::KeyValueVector moveit_pro::behaviors::LoadMultipleFromYaml< std_msgs::msg::Header >::metadata ()

Definition at line 321 of file load_from_yaml_impl.hpp.

metadata()​

template <typename T>
BT::KeyValueVector moveit_pro::behaviors::LoadMultipleFromYaml< geometry_msgs::msg::Pose >::metadata ()

Definition at line 355 of file load_from_yaml_impl.hpp.

metadata()​

template <typename T>
BT::KeyValueVector moveit_pro::behaviors::LoadMultipleFromYaml< geometry_msgs::msg::PoseStamped >::metadata ()

Definition at line 391 of file load_from_yaml_impl.hpp.

metadata()​

template <typename T>
BT::KeyValueVector moveit_pro::behaviors::LoadMultipleFromYaml< geometry_msgs::msg::PointStamped >::metadata ()

Definition at line 427 of file load_from_yaml_impl.hpp.

metadata()​

template <typename T>
BT::KeyValueVector moveit_pro::behaviors::LoadMultipleFromYaml< moveit_studio_vision_msgs::msg::ObjectSubframe >::metadata ()

Definition at line 462 of file load_from_yaml_impl.hpp.

providedPorts()​

template <typename T>
BT::PortsList moveit_pro::behaviors::LoadMultipleFromYaml< std_msgs::msg::Header >::providedPorts ()

Definition at line 305 of file load_from_yaml_impl.hpp.

providedPorts()​

template <typename T>
BT::PortsList moveit_pro::behaviors::LoadMultipleFromYaml< geometry_msgs::msg::Pose >::providedPorts ()

Definition at line 339 of file load_from_yaml_impl.hpp.

providedPorts()​

template <typename T>
BT::PortsList moveit_pro::behaviors::LoadMultipleFromYaml< geometry_msgs::msg::PoseStamped >::providedPorts ()

Definition at line 373 of file load_from_yaml_impl.hpp.

providedPorts()​

template <typename T>
BT::PortsList moveit_pro::behaviors::LoadMultipleFromYaml< geometry_msgs::msg::PointStamped >::providedPorts ()

Definition at line 409 of file load_from_yaml_impl.hpp.

providedPorts()​

template <typename T>
BT::PortsList moveit_pro::behaviors::LoadMultipleFromYaml< moveit_studio_vision_msgs::msg::ObjectSubframe >::providedPorts ()

Definition at line 445 of file load_from_yaml_impl.hpp.

tick()​

template <typename T>
BT::NodeStatus moveit_pro::behaviors::LoadMultipleFromYaml< T >::tick ()

Declaration at line 79 of file load_from_yaml.hpp, definition at line 616 of file load_from_yaml_impl.hpp.

Public Static Functions​

metadata()​

template <typename T>
BT::KeyValueVector moveit_pro::behaviors::LoadMultipleFromYaml< T >::metadata ()
 static

Declaration at line 77 of file load_from_yaml.hpp, definition at line 288 of file load_from_yaml_impl.hpp.

providedPorts()​

template <typename T>
BT::PortsList moveit_pro::behaviors::LoadMultipleFromYaml< T >::providedPorts ()
 static

Declaration at line 75 of file load_from_yaml.hpp, definition at line 271 of file load_from_yaml_impl.hpp.

Public Static Attributes​

kPortIDInput​

template <typename T>
const char moveit_pro::behaviors::LoadMultipleFromYaml< T >::kPortIDInput = "file_path"
 static

Definition at line 69 of file load_from_yaml.hpp.

kPortIDOutput​

template <typename T>
const char moveit_pro::behaviors::LoadMultipleFromYaml< T >::kPortIDOutput = "output"
 static

Definition at line 70 of file load_from_yaml.hpp.

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

Generated via doxygen2docusaurus 2.2.2 by Doxygen 1.9.8.