nros C++ API
Lightweight ROS 2 client for embedded real-time systems (C++ headers)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
nros::NodeBuilder Class Reference

#include <node.hpp>

Public Member Functions

Result build (Node &out) const
 Materialize the Node.
 
NodeBuilderdomain_id (uint32_t id)
 
NodeBuilderlocator (const char *loc)
 
NodeBuildernamespace_ (const char *ns)
 
 NodeBuilder (void *executor_handle, const char *name)
 
NodeBuilderrmw (const char *name)
 
NodeBuildersched (uint8_t sc_id)
 

Constructor & Destructor Documentation

◆ NodeBuilder()

nros::NodeBuilder::NodeBuilder ( void executor_handle,
const char name 
)
inline

Member Function Documentation

◆ build()

Result nros::NodeBuilder::build ( Node out) const
inline

Materialize the Node.

◆ domain_id()

NodeBuilder & nros::NodeBuilder::domain_id ( uint32_t  id)
inline

Override the Node's domain ID. Pass NROS_CPP_DOMAIN_ID_INHERIT (the default) to inherit from the executor.

◆ locator()

NodeBuilder & nros::NodeBuilder::locator ( const char loc)
inline

Override the Node's locator (tcp/..., udp/..., serial:...). Empty/nullptr inherits the executor's locator.

◆ namespace_()

NodeBuilder & nros::NodeBuilder::namespace_ ( const char ns)
inline

Set the Node's namespace (mirrors rclcpp::Node's ctor). Empty or nullptr defaults to "/" at build time.

◆ rmw()

NodeBuilder & nros::NodeBuilder::rmw ( const char name)
inline

Bind this Node to the named RMW backend. The name must match a backend registered with nros_rmw_cffi_register_named (or its auto-ctor equivalent). Empty/nullptr selects the first- registered backend — the single-backend convenience path.

◆ sched()

NodeBuilder & nros::NodeBuilder::sched ( uint8_t  sc_id)
inline

Bind every handle created via this Node to sc_id as its default SchedContext. 0 = executor default Fifo.


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