Descriptor for a user-defined main reactor parameter overridable from the command line. More...

#include <reactor_common.h>

Data Fields
const char *	description
	Description for the help message (e.g., "time value (default: 1 sec)").
bool *	given
	Pointer to a bool that is set to true when the arg is provided.
bool	is_width
	True if this parameter is used for multiport/bank widths (not overridable).
const char *	name
	Parameter name (e.g., "period").
lf_cli_type_t	type
	The type of the parameter value.
void *	value
	Pointer to the storage variable.

Detailed Description

Descriptor for a user-defined main reactor parameter overridable from the command line.

The code generator populates an array of these structs so that the runtime can parse user parameters in a table-driven fashion, without generating large if-else chains.

Field Documentation

◆ description

const char* lf_cli_param_t::description

Description for the help message (e.g., "time value (default: 1 sec)").

◆ given

bool* lf_cli_param_t::given

Pointer to a bool that is set to true when the arg is provided.

◆ is_width

bool lf_cli_param_t::is_width

True if this parameter is used for multiport/bank widths (not overridable).

◆ name

const char* lf_cli_param_t::name

Parameter name (e.g., "period").

◆ type

lf_cli_type_t lf_cli_param_t::type

The type of the parameter value.

◆ value

void* lf_cli_param_t::value

Pointer to the storage variable.

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

/Users/runner/work/reactor-c/reactor-c/include/core/reactor_common.h

Data Fields