carmen_param_t Struct Reference
[The ParamDaemon Module (param_daemon)]

#include <param_interface.h>

Data Fields
char *	module
char *	variable
carmen_param_type_t	type
void *	user_variable
int	subscribe
carmen_param_change_handler_t	handler

---

Detailed Description

This data structure is used by carmen_param_install_params and carmen_param_usage to load and report the usage of a large number of parameters.

Definition at line 68 of file param_interface.h.

---

Field Documentation

carmen_param_change_handler_t carmen_param_t::handler

Declare a handler if the param_daemon publishes a change to this variable's value. Definition at line 81 of file param_interface.h.

char* carmen_param_t::module

The module name of this parameter. Definition at line 69 of file param_interface.h.

int carmen_param_t::subscribe

If the param_daemon publishes a change to this variable value (because someone has changed the variable value, should the local value be updated? 1 for yes, 0 for no. Definition at line 76 of file param_interface.h.

carmen_param_type_t carmen_param_t::type

Type should match user_variable: e.g., CARMEN_PARAM_INT if the local variable storage is an integer. Definition at line 71 of file param_interface.h.

void* carmen_param_t::user_variable

A pointer to the local variable storage. Definition at line 74 of file param_interface.h.

char* carmen_param_t::variable

The variable name to be loaded. Definition at line 70 of file param_interface.h.

---

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

• param_daemon/param_interface.h

---