Repository navigation
Expand file tree
/
Copy pathtest_node.h
More file actions
130 lines (105 loc) · 5.02 KB
/
Copy pathtest_node.h
File metadata and controls
130 lines (105 loc) · 5.02 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/* Copyright (C) 2022-2025 Davide Faconti - All Rights Reserved
*
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#pragma once
#include "behaviortree_cpp/action_node.h"
// Not used by this header anymore, but included since 4.x: kept so that
// consumers relying on them transitively do not break.
#include "behaviortree_cpp/scripting/script_parser.hpp" // IWYU pragma: keep
#include "behaviortree_cpp/utils/timer_queue.h" // IWYU pragma: keep
#include <chrono>
#include <functional>
#include <memory>
#include <string>
namespace BT
{
struct TestNodeConfig
{
/// Status to return when the action is completed.
/// If return_status_script is also set, the script takes precedence.
NodeStatus return_status = NodeStatus::SUCCESS;
/// script to execute when complete_func() returns SUCCESS
std::string success_script;
/// script to execute when complete_func() returns FAILURE
std::string failure_script;
/// script to execute when actions is completed
std::string post_script;
/// if async_delay > 0, this action become asynchronous and wait this amount of time
std::chrono::milliseconds async_delay = std::chrono::milliseconds(0);
/// Function invoked when the action is completed.
/// If not specified, the node will use return_status_script when present,
/// otherwise it will return [return_status].
std::function<NodeStatus(void)> complete_func;
/// Optional script to compute the completion status dynamically.
///
/// This script is evaluated when the TestNode completes, after any
/// async_delay has elapsed, using the current blackboard state.
/// The result must resolve to the same set of statuses supported by
/// return_status, except IDLE which is always rejected.
/// When set, this takes precedence over return_status.
///
/// NOTE: kept last to preserve the byte offsets of the fields above.
std::string return_status_script;
};
/**
* @brief The TestNode is a Node that can be configure to:
*
* 1. Return a specific status (SUCCESS / FAILURE)
* 1.b Compute the returned status from a script evaluated at completion time
* 2. Execute a post condition script (unless halted)
* 3. Either complete immediately (synchronous action), or after a
* given period of time (asynchronous action)
*
* This behavior is changed by the parameters passed with TestNodeConfig.
*
* This particular node is created by the factory when TestNodeConfig is
* added as a substitution rule:
*
* auto test_config = std::make_shared<TestNodeConfig>();
* // change fields of test_config
* factory.addSubstitutionRule(pattern, test_config);
*
* See tutorial 15 for more details.
*/
class TestNode : public BT::StatefulActionNode
{
public:
// This constructor is deprecated, because it may cause problems if TestNodeConfig::complete_func is capturing
// a reference to the TestNode, i.e. [this]. Use the constructor with std::shared_ptr<TestNodeConfig> instead.
// For more details, see https://github.com/BehaviorTree/BehaviorTree.CPP/pull/967
[[deprecated("prefer the constructor with std::shared_ptr<TestNodeConfig>")]] TestNode(
const std::string& name, const NodeConfig& config, TestNodeConfig test_config);
TestNode(const std::string& name, const NodeConfig& config,
std::shared_ptr<TestNodeConfig> test_config);
~TestNode() override;
TestNode(const TestNode& other) = delete;
TestNode& operator=(const TestNode& other) = delete;
TestNode(TestNode&& other) = delete;
TestNode& operator=(TestNode&& other) = delete;
static PortsList providedPorts()
{
return {};
}
protected:
NodeStatus onStart() override;
NodeStatus onRunning() override;
void onHalted() override;
NodeStatus onCompleted();
// Kept as a direct member (first, at the same offset as in 4.9) for
// compatibility with subclasses that access it. Everything else lives behind
// the PImpl, so that adding or changing state does not alter the layout that
// consumers compile against.
std::shared_ptr<TestNodeConfig> _config;
struct PImpl;
std::unique_ptr<PImpl> _p;
};
} // namespace BT