Skip to content

Commit 119260a

Browse files
committed
replace create_parameter with declare_parameter
Signed-off-by: William Woodall <william@osrfoundation.org>
1 parent 4aab3fe commit 119260a

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

rclcpp/include/rclcpp/node.hpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -281,18 +281,18 @@ class Node : public std::enable_shared_from_this<Node>
281281
*/
282282
RCLCPP_PUBLIC
283283
void
284-
create_parameter(
284+
declare_parameter(
285285
const std::string & name,
286286
const rclcpp::ParameterValue & default_value = rclcpp::ParameterValue(),
287287
bool read_only = false);
288288

289289
/// Declare and initialize a parameter with a type.
290290
/**
291-
* See the non-templated create_parameter() on this class for details.
291+
* See the non-templated declare_parameter() on this class for details.
292292
*/
293293
template<typename ParameterT>
294294
void
295-
create_parameter(
295+
declare_parameter(
296296
const std::string & name,
297297
const ParameterT & default_value,
298298
bool read_only = false);

rclcpp/include/rclcpp/node_interfaces/node_parameters.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ namespace node_interfaces
4343
// Internal struct for holding useful info about parameters
4444
struct ParameterInfo
4545
{
46-
/// True if a user called create_parameter()
46+
/// True if a user called declare_parameter()
4747
bool is_declared = false;
4848

4949
/// Current value of the parameter.
@@ -76,7 +76,7 @@ class NodeParameters : public NodeParametersInterface
7676

7777
RCLCPP_PUBLIC
7878
void
79-
create_parameter(
79+
declare_parameter(
8080
const std::string & name,
8181
const rclcpp::ParameterValue & default_value,
8282
bool read_only) override;

rclcpp/include/rclcpp/node_interfaces/node_parameters_interface.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ class NodeParametersInterface
5252
RCLCPP_PUBLIC
5353
virtual
5454
void
55-
create_parameter(
55+
declare_parameter(
5656
const std::string & name,
5757
const rclcpp::ParameterValue & default_value = rclcpp::ParameterValue(),
5858
bool read_only = false) = 0;

rclcpp/src/rclcpp/node.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,12 +135,12 @@ Node::group_in_node(rclcpp::callback_group::CallbackGroup::SharedPtr group)
135135
}
136136

137137
void
138-
Node::create_parameter(
138+
Node::declare_parameter(
139139
const std::string & name,
140140
const rclcpp::ParameterValue & default_value,
141141
bool read_only)
142142
{
143-
return this->node_parameters_->create_parameter(name, default_value, read_only);
143+
return this->node_parameters_->declare_parameter(name, default_value, read_only);
144144
}
145145

146146
std::vector<rcl_interfaces::msg::SetParametersResult>

rclcpp/src/rclcpp/node_interfaces/node_parameters.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ NodeParameters::~NodeParameters()
162162
{}
163163

164164
void
165-
NodeParameters::create_parameter(
165+
NodeParameters::declare_parameter(
166166
const std::string & name,
167167
const rclcpp::ParameterValue & default_value,
168168
bool read_only)

rclcpp/test/test_node_initial_parameters.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ TEST_F(TestNodeWithInitialValues, multiple_declared_initial_values) {
7878
auto node = rclcpp::Node::make_shared(
7979
"node_name", "", context, arguments, initial_values, use_global_arguments, use_intra_process);
8080

81-
node->create_parameter("foo");
82-
node->create_parameter("bar");
83-
node->create_parameter("baz");
81+
node->declare_parameter("foo");
82+
node->declare_parameter("bar");
83+
node->declare_parameter("baz");
8484

8585
auto list_params_result = node->list_parameters({}, 0);
8686
EXPECT_TRUE(node->get_parameter("foo").get_value<bool>());

0 commit comments

Comments
 (0)