parameter.h

Go to the documentation of this file.

 
#ifndef NROS_PARAMETER_H
#define NROS_PARAMETER_H
 
#include "nros/types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Phase 91.C1: type definitions (nros_param_server_state_t,
 * nros_parameter_type_t, nros_param_array_t, nros_parameter_value_t,
 * nros_parameter_t, nros_param_callback_t, nros_param_server_t) come
 * from <nros/nros_generated.h> via the nros/types.h include above.
 *
 * The typed parameter setters / getters (bool / integer / double /
 * *_array) are declared by hand below; the auto-generated header
 * cannot synthesise them from the runtime side, so this file keeps
 * the canonical declarations.
 */
 
/* ===================================================================
 * Functions
 * =================================================================== */
 
NROS_PUBLIC struct nros_param_server_t nros_param_server_get_zero_initialized(void);
 
NROS_PUBLIC
nros_ret_t nros_param_server_init(struct nros_param_server_t* server,
                                  struct nros_parameter_t* storage, size_t capacity);
 
NROS_PUBLIC
nros_ret_t nros_param_server_set_callback(struct nros_param_server_t* server,
                                          nros_param_callback_t callback, void* context);
 
NROS_PUBLIC
nros_ret_t nros_param_declare_bool(struct nros_param_server_t* server, const char* name,
                                   bool default_value);
 
NROS_PUBLIC
nros_ret_t nros_param_declare_integer(struct nros_param_server_t* server, const char* name,
                                      int64_t default_value);
 
NROS_PUBLIC
nros_ret_t nros_param_declare_double(struct nros_param_server_t* server, const char* name,
                                     double default_value);
 
NROS_PUBLIC
nros_ret_t nros_param_declare_string(struct nros_param_server_t* server, const char* name,
                                     const char* default_value);
 
NROS_PUBLIC
nros_ret_t nros_param_get_bool(const struct nros_param_server_t* server, const char* name,
                               bool* value);
 
NROS_PUBLIC
nros_ret_t nros_param_get_integer(const struct nros_param_server_t* server, const char* name,
                                  int64_t* value);
 
NROS_PUBLIC
nros_ret_t nros_param_get_double(const struct nros_param_server_t* server, const char* name,
                                 double* value);
 
NROS_PUBLIC
nros_ret_t nros_param_get_string(const struct nros_param_server_t* server, const char* name,
                                 char* value, size_t max_len);
 
NROS_PUBLIC
nros_ret_t nros_param_set_bool(struct nros_param_server_t* server, const char* name, bool value);
 
NROS_PUBLIC
nros_ret_t nros_param_set_integer(struct nros_param_server_t* server, const char* name,
                                  int64_t value);
 
NROS_PUBLIC
nros_ret_t nros_param_set_double(struct nros_param_server_t* server, const char* name,
                                 double value);
 
NROS_PUBLIC
nros_ret_t nros_param_set_string(struct nros_param_server_t* server, const char* name,
                                 const char* value);
 
/* -------------------------------------------------------------------
 * Array parameters
 *
 * Array parameters store a pointer + length to caller-owned data.
 * The caller MUST keep the underlying storage alive for the lifetime of
 * the parameter (until @ref nros_param_server_fini, or until the
 * parameter is overwritten with a new pointer via the matching `_set`
 * function). String arrays point to an array of `const char*` — each
 * element is itself a null-terminated, caller-owned string.
 * ------------------------------------------------------------------- */
 
NROS_PUBLIC
nros_ret_t nros_param_declare_byte_array(struct nros_param_server_t* server, const char* name,
                                         const uint8_t* data, size_t len);
NROS_PUBLIC
nros_ret_t nros_param_declare_bool_array(struct nros_param_server_t* server, const char* name,
                                         const bool* data, size_t len);
NROS_PUBLIC
nros_ret_t nros_param_declare_integer_array(struct nros_param_server_t* server, const char* name,
                                            const int64_t* data, size_t len);
NROS_PUBLIC
nros_ret_t nros_param_declare_double_array(struct nros_param_server_t* server, const char* name,
                                           const double* data, size_t len);
NROS_PUBLIC
nros_ret_t nros_param_declare_string_array(struct nros_param_server_t* server, const char* name,
                                           const char* const* data, size_t len);
 
NROS_PUBLIC
nros_ret_t nros_param_get_byte_array(const struct nros_param_server_t* server, const char* name,
                                     const uint8_t** data, size_t* len);
NROS_PUBLIC
nros_ret_t nros_param_get_bool_array(const struct nros_param_server_t* server, const char* name,
                                     const bool** data, size_t* len);
NROS_PUBLIC
nros_ret_t nros_param_get_integer_array(const struct nros_param_server_t* server, const char* name,
                                        const int64_t** data, size_t* len);
NROS_PUBLIC
nros_ret_t nros_param_get_double_array(const struct nros_param_server_t* server, const char* name,
                                       const double** data, size_t* len);
NROS_PUBLIC
nros_ret_t nros_param_get_string_array(const struct nros_param_server_t* server, const char* name,
                                       const char* const** data, size_t* len);
 
NROS_PUBLIC
nros_ret_t nros_param_set_byte_array(struct nros_param_server_t* server, const char* name,
                                     const uint8_t* data, size_t len);
NROS_PUBLIC
nros_ret_t nros_param_set_bool_array(struct nros_param_server_t* server, const char* name,
                                     const bool* data, size_t len);
NROS_PUBLIC
nros_ret_t nros_param_set_integer_array(struct nros_param_server_t* server, const char* name,
                                        const int64_t* data, size_t len);
NROS_PUBLIC
nros_ret_t nros_param_set_double_array(struct nros_param_server_t* server, const char* name,
                                       const double* data, size_t len);
NROS_PUBLIC
nros_ret_t nros_param_set_string_array(struct nros_param_server_t* server, const char* name,
                                       const char* const* data, size_t len);
 
NROS_PUBLIC bool nros_param_has(const struct nros_param_server_t* server, const char* name);
 
NROS_PUBLIC
enum nros_parameter_type_t nros_param_get_type(const struct nros_param_server_t* server,
                                               const char* name);
 
NROS_PUBLIC size_t nros_param_server_get_count(const struct nros_param_server_t* server);
 
NROS_PUBLIC nros_ret_t nros_param_server_fini(struct nros_param_server_t* server);
 
/* ===================================================================
 * Service-Backed Parameter API (requires NROS_PARAM_SERVICES feature)
 *
 * These functions operate on the nros-params::ParameterServer owned by
 * the Executor. After calling nros_executor_register_parameter_services,
 * declared parameters are visible to `ros2 param list /<node>`.
 *
 * Only available when nros-c is built with the `param-services` Cargo
 * feature (requires alloc).
 * =================================================================== */
 
struct nros_executor_t;
 
NROS_PUBLIC nros_ret_t nros_executor_register_parameter_services(struct nros_executor_t* executor);
 
NROS_PUBLIC nros_ret_t nros_executor_declare_param_bool(struct nros_executor_t* executor,
                                                        const char* name, bool value);
NROS_PUBLIC nros_ret_t nros_executor_declare_param_integer(struct nros_executor_t* executor,
                                                           const char* name, int64_t value);
NROS_PUBLIC nros_ret_t nros_executor_declare_param_double(struct nros_executor_t* executor,
                                                          const char* name, double value);
NROS_PUBLIC nros_ret_t nros_executor_declare_param_string(struct nros_executor_t* executor,
                                                          const char* name, const char* value);
 
NROS_PUBLIC nros_ret_t nros_executor_get_param_bool(struct nros_executor_t* executor,
                                                    const char* name, bool* out_value);
NROS_PUBLIC nros_ret_t nros_executor_get_param_integer(struct nros_executor_t* executor,
                                                       const char* name, int64_t* out_value);
NROS_PUBLIC nros_ret_t nros_executor_get_param_double(struct nros_executor_t* executor,
                                                      const char* name, double* out_value);
NROS_PUBLIC nros_ret_t nros_executor_get_param_string(struct nros_executor_t* executor,
                                                      const char* name, char* out_value,
                                                      size_t max_len);
 
NROS_PUBLIC nros_ret_t nros_executor_set_param_bool(struct nros_executor_t* executor,
                                                    const char* name, bool value);
NROS_PUBLIC nros_ret_t nros_executor_set_param_integer(struct nros_executor_t* executor,
                                                       const char* name, int64_t value);
NROS_PUBLIC nros_ret_t nros_executor_set_param_double(struct nros_executor_t* executor,
                                                      const char* name, double value);
NROS_PUBLIC nros_ret_t nros_executor_set_param_string(struct nros_executor_t* executor,
                                                      const char* name, const char* value);
 
NROS_PUBLIC bool nros_executor_has_param(struct nros_executor_t* executor, const char* name);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NROS_PARAMETER_H */