Scilab Home page | Wiki | Bug tracker | Forge | Mailing list archives | ATOMS | File exchange
Please login or create an account
Change language to: English - Português - 日本語 - Русский

Please note that the recommended version of Scilab is 6.0.0. This page might be outdated.
See the recommended documentation of this function

Aide de Scilab >> Parameters > is_param

is_param

Check if a parameter is present in a parameter list

Calling Sequence

[res,err] = is_param(list_name,param_name)

Arguments

list_name

the list of parameters. This list must have been initialize by a call to init_param.

param_name

a string. The name of the parameter to be add in the list of parameters.

res

the result: %T is the parameter is present, %F otherwise.

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 checks if a parameter is present 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(is_param(mylist,'minbound'));
disp(is_param(mylist,'maxbound'));

See Also

  • init_param — Initialize the structure which will handles the parameters list
  • set_param — Set the value of a parameter in a parameter list
  • get_param — Get the value of a parameter in a parameter list
  • remove_param — Remove a parameter and its associated value from a list of parameters
  • add_param — Add a parameter to a list of parameters
Scilab Enterprises
Copyright (c) 2011-2017 (Scilab Enterprises)
Copyright (c) 1989-2012 (INRIA)
Copyright (c) 1989-2007 (ENPC)
with contributors
Last updated:
Thu Oct 02 13:54:34 CEST 2014