Please note that the recommended version of Scilab is 2025.0.0. This page might be outdated.
See the recommended documentation of this function
get_param
Get the value of a parameter in a parameter list
Calling Sequence
[res,err] = get_param(list_name,param_name,default_value)
Arguments
- list_name
the list of parameters. This list must have been initialized by a call to init_param.
- param_name
a string. The name of the parameter to be add in the list of parameters.
- default_value
the default value to be stored in the parameter if param_name has not been found.
- res
the value of the parameter. If the parameter does not exist, res = [].
- err
an error flag which is set to %T if list_name is not of type plist (this list has not been initialized by a call to init_param).
Description
This function returns the value of the parameter param_name in a parameter list. If the err output parameter is not present, when an error occurs, a message is printed in the console.
Examples
mylist = init_param(); mylist = add_param(mylist,'minbound',[0 0 0]); disp(get_param(mylist,'minbound',-[1 1 1])); disp(get_param(mylist,'maxbound', [1 1 1]));
See Also
Authors
- Yann COLLETTE
| << add_param | Parameters | init_param >> |