LoadFromYaml Class Template
Loads a type from a YAML file, and returns it in an output port. More...
Declaration
class moveit_pro::behaviors::LoadFromYaml<T> { ... }
Included Headers
Base class
| class | SharedResourcesNode<BehaviorTreeNodeT> |
|
The SharedResourcesNode class provides a BehaviorContext object when constructing a BehaviorTree.Cpp node. More... | |
Public Constructors Index
template <typename T> | |
| LoadFromYaml (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources) | |
Public Member Functions Index
template <typename T> | |
| BT::NodeStatus | tick () override |
template <typename T> | |
| BT::PortsList | providedPorts () |
template <typename T> | |
| BT::KeyValueVector | metadata () |
template <typename T> | |
| BT::PortsList | providedPorts () |
template <typename T> | |
| BT::KeyValueVector | metadata () |
template <typename T> | |
| BT::PortsList | providedPorts () |
template <typename T> | |
| BT::KeyValueVector | metadata () |
template <typename T> | |
| BT::PortsList | providedPorts () |
template <typename T> | |
| BT::KeyValueVector | metadata () |
template <typename T> | |
| BT::PortsList | providedPorts () |
template <typename T> | |
| BT::KeyValueVector | metadata () |
template <typename T> | |
| BT::PortsList | providedPorts () |
template <typename T> | |
| BT::KeyValueVector | metadata () |
template <typename T> | |
| BT::PortsList | providedPorts () |
template <typename T> | |
| BT::KeyValueVector | metadata () |
template <typename T> | |
| BT::PortsList | providedPorts () |
template <typename T> | |
| BT::KeyValueVector | metadata () |
template <typename T> | |
| BT::PortsList | providedPorts () |
template <typename T> | |
| BT::KeyValueVector | metadata () |
template <typename T> | |
| BT::PortsList | providedPorts () |
template <typename T> | |
| BT::KeyValueVector | metadata () |
template <typename T> | |
| BT::PortsList | providedPorts () |
template <typename T> | |
| BT::KeyValueVector | metadata () |
Public Static Functions Index
template <typename T> | |
| static BT::PortsList | providedPorts () |
template <typename T> | |
| static BT::KeyValueVector | metadata () |
Public Static Attributes Index
template <typename T> | |
| static const char | kPortIDInput[] = "file_path" |
template <typename T> | |
| static const char | kPortIDOutput[] = "output" |
Description
Loads a type from a YAML file, and returns it 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 must contain a single instance of the type. To load multiple instances as a vector, use LoadMultipleFromYaml above.
As an example, for a type with 'x' and 'y' fields, this YAML contents should be:
x: 0.1 y: 0.1
- Template Parameters
-
T Determines the type of object to load from the YAML file.
If the optional package_name port is set, the YAML file is resolved relative to that ROS package's share directory. When package_name is empty (the default), relative file paths fall back to the active config's objectives source directory.
| Data Port Name | Port Type | Object Type |
|---|---|---|
| file_path | input | std::string |
| package_name | input | std::string (optional, defaults to "") |
| output | output | T |
Definition at line 119 of file load_from_yaml.hpp.
Public Constructors
LoadFromYaml()
|
Declaration at line 125 of file load_from_yaml.hpp, definition at line 248 of file load_from_yaml_impl.hpp.
Public Member Functions
metadata()
|
Definition at line 316 of file load_from_yaml_impl.hpp.
metadata()
|
Definition at line 350 of file load_from_yaml_impl.hpp.
metadata()
|
Definition at line 385 of file load_from_yaml_impl.hpp.
metadata()
|
Definition at line 421 of file load_from_yaml_impl.hpp.
metadata()
|
Definition at line 456 of file load_from_yaml_impl.hpp.
metadata()
|
Definition at line 481 of file load_from_yaml_impl.hpp.
metadata()
|
Definition at line 500 of file load_from_yaml_impl.hpp.
metadata()
|
Definition at line 519 of file load_from_yaml_impl.hpp.
metadata()
|
Definition at line 538 of file load_from_yaml_impl.hpp.
metadata()
|
Definition at line 556 of file load_from_yaml_impl.hpp.
metadata()
|
Definition at line 575 of file load_from_yaml_impl.hpp.
providedPorts()
|
Definition at line 295 of file load_from_yaml_impl.hpp.
providedPorts()
|
Definition at line 329 of file load_from_yaml_impl.hpp.
providedPorts()
|
Definition at line 363 of file load_from_yaml_impl.hpp.
providedPorts()
|
Definition at line 399 of file load_from_yaml_impl.hpp.
providedPorts()
|
Definition at line 435 of file load_from_yaml_impl.hpp.
providedPorts()
|
Definition at line 470 of file load_from_yaml_impl.hpp.
providedPorts()
|
Definition at line 489 of file load_from_yaml_impl.hpp.
providedPorts()
|
Definition at line 508 of file load_from_yaml_impl.hpp.
providedPorts()
|
Definition at line 527 of file load_from_yaml_impl.hpp.
providedPorts()
|
Definition at line 545 of file load_from_yaml_impl.hpp.
providedPorts()
|
Definition at line 564 of file load_from_yaml_impl.hpp.
tick()
|
Declaration at line 132 of file load_from_yaml.hpp, definition at line 583 of file load_from_yaml_impl.hpp.
Public Static Functions
metadata()
| static |
Declaration at line 130 of file load_from_yaml.hpp, definition at line 283 of file load_from_yaml_impl.hpp.
providedPorts()
| static |
Declaration at line 128 of file load_from_yaml.hpp, definition at line 262 of file load_from_yaml_impl.hpp.
Public Static Attributes
kPortIDInput
| static |
Definition at line 122 of file load_from_yaml.hpp.
kPortIDOutput
| static |
Definition at line 123 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.