Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions rclcpp/include/rclcpp/node_traits.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
// Copyright 2026 Open Source Robotics Foundation, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef RCLCPP__NODE_TRAITS_HPP_
#define RCLCPP__NODE_TRAITS_HPP_

#include <type_traits>

/** \file
* Compile-time checks for node class inheritance.
*
* Both traits ignore const, volatile, and references. Raw and smart pointers
* are checked as their own types. Private, protected, and ambiguous bases count.
* A non-union class argument must be complete unless it is the trait's base class.
*/

namespace rclcpp_lifecycle
{
class LifecycleNode;
} // namespace rclcpp_lifecycle

namespace rclcpp
{
class Node;

/// True for rclcpp::Node and classes derived from it.
template<typename T>
struct is_node : std::is_base_of<Node, std::remove_cvref_t<T>>
{};

/// Convenience variable for is_node<T>::value.
template<typename T>
inline constexpr bool is_node_v = is_node<T>::value;

/// True for rclcpp_lifecycle::LifecycleNode and classes derived from it.
template<typename T>
struct is_lifecycle_node : std::is_base_of<rclcpp_lifecycle::LifecycleNode, std::remove_cvref_t<T>>
{};

/// Convenience variable for is_lifecycle_node<T>::value.
template<typename T>
inline constexpr bool is_lifecycle_node_v = is_lifecycle_node<T>::value;

} // namespace rclcpp

#endif // RCLCPP__NODE_TRAITS_HPP_
21 changes: 21 additions & 0 deletions rclcpp/test/rclcpp/test_interface_traits.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
#include <memory>
#include <utility>

#include "rclcpp/node_traits.hpp"

#include "rclcpp/contexts/default_context.hpp"
#include "rclcpp/node_interfaces/node_base_interface_traits.hpp"
#include "rclcpp/node_interfaces/node_base.hpp"
Expand Down Expand Up @@ -46,6 +48,25 @@ class WrongNode
}
};

namespace
{
class DerivedNode : public rclcpp::Node
{};
} // namespace

TEST(TestNodeTraits, is_node) {
static_assert(rclcpp::is_node<rclcpp::Node>::value);
static_assert(rclcpp::is_node_v<DerivedNode>);
static_assert(rclcpp::is_node_v<const volatile DerivedNode &>);
static_assert(!rclcpp::is_node_v<rclcpp::Node *>);
static_assert(!rclcpp::is_node_v<rclcpp::Node::SharedPtr>);
static_assert(!rclcpp::is_node_v<int>);
static_assert(!rclcpp::is_node_v<MyNode>);

// LifecycleNode remains forward-declared in this package.
static_assert(!rclcpp::is_lifecycle_node<rclcpp::Node>::value);
}

template<class T, typename std::enable_if<
rclcpp::node_interfaces::has_node_base_interface<T>::value
>::type * = nullptr>
Expand Down
11 changes: 11 additions & 0 deletions rclcpp_lifecycle/test/test_lifecycle_node.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
#include "rclcpp/exceptions.hpp"
#include "rclcpp/node.hpp"
#include "rclcpp/node_options.hpp"
#include "rclcpp/node_traits.hpp"
#include "rclcpp/parameter.hpp"
#include "rclcpp/parameter_value.hpp"
#include "rclcpp/utilities.hpp"
Expand Down Expand Up @@ -152,6 +153,16 @@ class EmptyLifecycleNode : public rclcpp_lifecycle::LifecycleNode
{}
};

TEST(TestNodeTraits, is_lifecycle_node) {
static_assert(rclcpp::is_lifecycle_node<rclcpp_lifecycle::LifecycleNode>::value);
static_assert(rclcpp::is_lifecycle_node_v<EmptyLifecycleNode>);
static_assert(rclcpp::is_lifecycle_node_v<const volatile EmptyLifecycleNode &&>);
static_assert(!rclcpp::is_lifecycle_node_v<rclcpp_lifecycle::LifecycleNode *>);
static_assert(!rclcpp::is_lifecycle_node_v<std::unique_ptr<EmptyLifecycleNode>>);
static_assert(!rclcpp::is_lifecycle_node_v<void>);
static_assert(!rclcpp::is_node_v<rclcpp_lifecycle::LifecycleNode>);
}

struct GoodMood
{
using CallbackReturnT =
Expand Down