From 0345245e860375a32c9a437c4a9d9cae807134e9 Mon Sep 17 00:00:00 2001 From: Shashank Date: Mon, 29 May 2017 12:40:26 +0530 Subject: CMSCOPE changed --- modules/parameters/help/en_US/add_param.xml | 101 ++++++++++++++++++++++++ modules/parameters/help/en_US/addchapter.sce | 11 +++ modules/parameters/help/en_US/get_param.xml | 104 +++++++++++++++++++++++++ modules/parameters/help/en_US/init_param.xml | 75 ++++++++++++++++++ modules/parameters/help/en_US/is_param.xml | 98 +++++++++++++++++++++++ modules/parameters/help/en_US/list_param.xml | 88 +++++++++++++++++++++ modules/parameters/help/en_US/remove_param.xml | 98 +++++++++++++++++++++++ modules/parameters/help/en_US/set_param.xml | 101 ++++++++++++++++++++++++ modules/parameters/help/fr_FR/addchapter.sce | 11 +++ modules/parameters/help/ja_JP/add_param.xml | 93 ++++++++++++++++++++++ modules/parameters/help/ja_JP/addchapter.sce | 11 +++ modules/parameters/help/ja_JP/get_param.xml | 100 ++++++++++++++++++++++++ modules/parameters/help/ja_JP/init_param.xml | 72 +++++++++++++++++ modules/parameters/help/ja_JP/is_param.xml | 95 ++++++++++++++++++++++ modules/parameters/help/ja_JP/list_param.xml | 88 +++++++++++++++++++++ modules/parameters/help/ja_JP/remove_param.xml | 96 +++++++++++++++++++++++ modules/parameters/help/ja_JP/set_param.xml | 99 +++++++++++++++++++++++ modules/parameters/help/pt_BR/addchapter.sce | 11 +++ modules/parameters/help/ru_RU/addchapter.sce | 11 +++ 19 files changed, 1363 insertions(+) create mode 100755 modules/parameters/help/en_US/add_param.xml create mode 100755 modules/parameters/help/en_US/addchapter.sce create mode 100755 modules/parameters/help/en_US/get_param.xml create mode 100755 modules/parameters/help/en_US/init_param.xml create mode 100755 modules/parameters/help/en_US/is_param.xml create mode 100755 modules/parameters/help/en_US/list_param.xml create mode 100755 modules/parameters/help/en_US/remove_param.xml create mode 100755 modules/parameters/help/en_US/set_param.xml create mode 100755 modules/parameters/help/fr_FR/addchapter.sce create mode 100755 modules/parameters/help/ja_JP/add_param.xml create mode 100755 modules/parameters/help/ja_JP/addchapter.sce create mode 100755 modules/parameters/help/ja_JP/get_param.xml create mode 100755 modules/parameters/help/ja_JP/init_param.xml create mode 100755 modules/parameters/help/ja_JP/is_param.xml create mode 100755 modules/parameters/help/ja_JP/list_param.xml create mode 100755 modules/parameters/help/ja_JP/remove_param.xml create mode 100755 modules/parameters/help/ja_JP/set_param.xml create mode 100755 modules/parameters/help/pt_BR/addchapter.sce create mode 100755 modules/parameters/help/ru_RU/addchapter.sce (limited to 'modules/parameters/help') diff --git a/modules/parameters/help/en_US/add_param.xml b/modules/parameters/help/en_US/add_param.xml new file mode 100755 index 000000000..8786660a2 --- /dev/null +++ b/modules/parameters/help/en_US/add_param.xml @@ -0,0 +1,101 @@ + + + + + add_param + Add a parameter to a list of parameters + + + Calling Sequence + param_list = add_param(list_name,param_name,param_value) + + + 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 added in the list of parameters. + + + + + param_value + + the value associated to the parameter param_name. This parameter is optional. You can set the value of this parameter via a call to set_param. + + + + + param_list + + the updated list of parameters. + + + + + + + Description + + This function creates a new parameter in a list of parameters. You can set the value of the parameter using this function or you can set it via a call to set_param. + + + + Examples + + + + See Also + + + init_param + + + set_param + + + get_param + + + remove_param + + + is_param + + + + + History + + + 5.5.0 + Second output argument (err) tagged as obsolete. + + + 5.5.1 + Second output argument removed. + + + + diff --git a/modules/parameters/help/en_US/addchapter.sce b/modules/parameters/help/en_US/addchapter.sce new file mode 100755 index 000000000..d7a522975 --- /dev/null +++ b/modules/parameters/help/en_US/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Parameters",SCI+"/modules/parameters/help/en_US",%T); + diff --git a/modules/parameters/help/en_US/get_param.xml b/modules/parameters/help/en_US/get_param.xml new file mode 100755 index 000000000..5e2c10388 --- /dev/null +++ b/modules/parameters/help/en_US/get_param.xml @@ -0,0 +1,104 @@ + + + + + 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 + + + + See Also + + + init_param + + + set_param + + + add_param + + + remove_param + + + is_param + + + + diff --git a/modules/parameters/help/en_US/init_param.xml b/modules/parameters/help/en_US/init_param.xml new file mode 100755 index 000000000..27238a1ea --- /dev/null +++ b/modules/parameters/help/en_US/init_param.xml @@ -0,0 +1,75 @@ + + + + + init_param + Initialize the structure which will handles the parameters + list + + + + Calling Sequence + param_list = init_param(['param_name1',param_value1,...]) + + + Arguments + + + param_list + + an initialized list of parameters (if no input + parameters are shipped, this list is empty and is + of type plist). + + + + + + + Description + This function initialize an empty list of parameters. You must + initialize the list of parameters before using it. + + + + Examples + + + + See Also + + + add_param + + + set_param + + + get_param + + + remove_param + + + is_param + + + + diff --git a/modules/parameters/help/en_US/is_param.xml b/modules/parameters/help/en_US/is_param.xml new file mode 100755 index 000000000..86dd444bf --- /dev/null +++ b/modules/parameters/help/en_US/is_param.xml @@ -0,0 +1,98 @@ + + + + + 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 + + + + See Also + + + init_param + + + set_param + + + get_param + + + remove_param + + + add_param + + + + diff --git a/modules/parameters/help/en_US/list_param.xml b/modules/parameters/help/en_US/list_param.xml new file mode 100755 index 000000000..f81f9137e --- /dev/null +++ b/modules/parameters/help/en_US/list_param.xml @@ -0,0 +1,88 @@ + + + + + list_param + List all the parameters name in a list of + parameters + + + + Calling Sequence + [string_list,err] = list_param(list_name) + + + Arguments + + + list_name + + the list of parameters. This list must have been initialize by + a call to init_param. + + + + + string_list + + the list of parameters name. + + + + 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 + List all the parameters name in a list of parameters. If the err + output parameter is not present, when an error occurs, a message is + printed in the console. + + + + Examples + + + + See Also + + + init_param + + + set_param + + + get_param + + + remove_param + + + is_param + + + + diff --git a/modules/parameters/help/en_US/remove_param.xml b/modules/parameters/help/en_US/remove_param.xml new file mode 100755 index 000000000..28fa54aa7 --- /dev/null +++ b/modules/parameters/help/en_US/remove_param.xml @@ -0,0 +1,98 @@ + + + + + remove_param + Remove a parameter and its associated value from a list of + parameters + + + + Calling Sequence + [param_list,err] = remove_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 removed from the + list of parameters. If the parameter does not exist, nothing + happens. + + + + + param_list + + the updated list of parameters. + + + + 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 allows to remove a parameter and its associated + value from a list of parameters. If the err output parameter is not + present, when an error occurs, a message is printed in the + console. + + + + Examples + + + + See Also + + + init_param + + + set_param + + + get_param + + + add_param + + + is_param + + + + diff --git a/modules/parameters/help/en_US/set_param.xml b/modules/parameters/help/en_US/set_param.xml new file mode 100755 index 000000000..9f54c5a83 --- /dev/null +++ b/modules/parameters/help/en_US/set_param.xml @@ -0,0 +1,101 @@ + + + + + set_param + Set the value of a parameter in a parameter list + + + Calling Sequence + [param_list,err] = set_param(list_name,param_name,param_value) + + + 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 added in the list of + parameters. + + + + + param_value + + the value to be associated to the parameter param_name. + + + + param_list + + the updated list of parameters. + + + + 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 sets the value of an already existing parameter. + If the parameter does not exist, err is set to %T. If the err output + parameter is not present, when an error occurs, a message is printed + in the console. + + + + Examples + + + + See Also + + + init_param + + + add_param + + + get_param + + + remove_param + + + is_param + + + + diff --git a/modules/parameters/help/fr_FR/addchapter.sce b/modules/parameters/help/fr_FR/addchapter.sce new file mode 100755 index 000000000..cc81df69e --- /dev/null +++ b/modules/parameters/help/fr_FR/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Parameters",SCI+"/modules/parameters/help/fr_FR",%T); + diff --git a/modules/parameters/help/ja_JP/add_param.xml b/modules/parameters/help/ja_JP/add_param.xml new file mode 100755 index 000000000..b9aa495bc --- /dev/null +++ b/modules/parameters/help/ja_JP/add_param.xml @@ -0,0 +1,93 @@ + + + + + add_param + パラメータリストにパラメータを追加 + + + 呼び出し手順 + param_list = add_param(list_name,param_name,param_value) + + + 引数 + + + list_name + + パラメータのリスト. このリストはinit_paramにより + 初期化されている必要があります. + + + + + param_name + + 文字列. パラメータのリストに追加されるパラメータの名前. + + + + + param_value + + パラメータparam_nameの値. このパラメータはオプションです. + このパラメータの値は set_param をコールすることにより + 設定可能です. + + + + + param_list + + 更新後のパラメータのリスト. + + + + + + + 説明 + + この関数は,パラメータのリストに新しいパラメータを作成します. + このパラメータの値は,この関数またはset_paramをコールすることにより + 設定できます. + + + + + + + + 参照 + + + init_param + + + set_param + + + get_param + + + remove_param + + + is_param + + + + diff --git a/modules/parameters/help/ja_JP/addchapter.sce b/modules/parameters/help/ja_JP/addchapter.sce new file mode 100755 index 000000000..5abea3431 --- /dev/null +++ b/modules/parameters/help/ja_JP/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Parameters",SCI+"/modules/parameters/help/ja_JP",%T); + diff --git a/modules/parameters/help/ja_JP/get_param.xml b/modules/parameters/help/ja_JP/get_param.xml new file mode 100755 index 000000000..91bd8c51b --- /dev/null +++ b/modules/parameters/help/ja_JP/get_param.xml @@ -0,0 +1,100 @@ + + + + + get_param + パラメータリストからパラメータの値を取得 + + + 呼び出し手順 + [res,err] = get_param(list_name,param_name,default_value) + + + 引数 + + + list_name + + パラメータのリスト. このリストはinit_paramをコールすることにより + 初期化されている必要があります. + + + + + param_name + + 文字列. パラメータのリストのパラメータの名前. + + + + default_value + + param_nameが見つからない場合に使用されるデフォルト値. + + + + res + + パラメータの値. パラメータが存在しない場合, + res = [] となります. + + + + + err + + エラーフラグで,list_nameがplist型でない + (このリストはinit_paramをコールすることにより初期化されていない) + 場合 %T に設定されます. + + + + + + + 説明 + この関数はパラメータリストのパラメータparam_nameの値を返します. + エラー発生時に出力パラメータerrが存在しない場合, + メッセージがコンソールに出力されます. + + + + + + + + 参照 + + + init_param + + + set_param + + + add_param + + + remove_param + + + is_param + + + + diff --git a/modules/parameters/help/ja_JP/init_param.xml b/modules/parameters/help/ja_JP/init_param.xml new file mode 100755 index 000000000..571ed514e --- /dev/null +++ b/modules/parameters/help/ja_JP/init_param.xml @@ -0,0 +1,72 @@ + + + + + init_param + パラメータリストを扱う構造体を初期化 + + + 呼び出し手順 + param_list = init_param(['param_name1',param_value1,...]) + + + 引数 + + + param_list + + 初期化済みのパラメータのリスト + (入力パラメータが指定されない場合, このリストは空となり, + plist 型となります). + + + + + + + 説明 + この関数はパラメータの空のリストを初期化します. + パラメータのリストは使用前に初期化する必要があります. + + + + + + + + 参照 + + + add_param + + + set_param + + + get_param + + + remove_param + + + is_param + + + + diff --git a/modules/parameters/help/ja_JP/is_param.xml b/modules/parameters/help/ja_JP/is_param.xml new file mode 100755 index 000000000..2143d328d --- /dev/null +++ b/modules/parameters/help/ja_JP/is_param.xml @@ -0,0 +1,95 @@ + + + + + is_param + パラメータがパラメータリストに存在するかどうかを確認 + + + 呼び出し手順 + [res,err] = is_param(list_name,param_name) + + + 引数 + + + list_name + + パラメータのリスト.このリストはinit_paramにより + 初期化されている必要があります. + + + + + param_name + + 文字列. + パラメータリストで調べるパラメータの名前. + + + + + res + + 結果: パラメータが存在する場合は %T, それ以外は %F. + + + + err + + エラーフラグで,list_nameがplist型でない + (このリストはinit_paramをコールすることにより初期化されていない) + 場合 %T に設定されます. + + + + + + + 説明 + この関数は,指定したパラメータがパラメータリストに + 存在するかどうかを調べます. + エラー発生時に出力パラメータerrが存在しない場合, + メッセージがコンソールに出力されます. + + + + + + + + 参照 + + + init_param + + + set_param + + + get_param + + + remove_param + + + add_param + + + + diff --git a/modules/parameters/help/ja_JP/list_param.xml b/modules/parameters/help/ja_JP/list_param.xml new file mode 100755 index 000000000..ccf7e28a2 --- /dev/null +++ b/modules/parameters/help/ja_JP/list_param.xml @@ -0,0 +1,88 @@ + + + + + list_param + パラメータリストのパラメータ名のリストを取得 + + + + 呼び出し手順 + [string_list,err] = list_param(list_name) + + + 引数 + + + list_name + + パラメータのリスト.このリストはinit_paramにより + 初期化されている必要があります. + + + + + string_list + + パラメータ名のリスト. + + + + err + + エラーフラグで,list_nameがplist型でない + (このリストはinit_paramをコールすることにより初期化されていない) + 場合 %T に設定されます. + + + + + + + 説明 + + パラメータリストのパラメータ名のリストを取得します. + エラー発生時に出力パラメータerrが存在しない場合, + メッセージがコンソールに出力されます. + + + + + + + + 参照 + + + init_param + + + set_param + + + get_param + + + remove_param + + + is_param + + + + diff --git a/modules/parameters/help/ja_JP/remove_param.xml b/modules/parameters/help/ja_JP/remove_param.xml new file mode 100755 index 000000000..5e13255e6 --- /dev/null +++ b/modules/parameters/help/ja_JP/remove_param.xml @@ -0,0 +1,96 @@ + + + + + remove_param + パラメータリストからパラメータとその値を削除する + + + + 呼び出し手順 + [param_list,err] = remove_param(list_name,param_name) + + + 引数 + + + list_name + + パラメータのリスト. このリストはinit_paramをコールすることにより + 初期化されている必要があります. + + + + + param_name + + 文字列. パラメータリストから削除するパラメータの名前. + このパラメータが存在しない場合,何も行われません. + + + + + param_list + + 更新後のパラメータリスト. + + + + err + + エラーフラグで,list_nameがplist型でない + (このリストはinit_paramをコールすることにより初期化されていない) + 場合 %T に設定されます. + + + + + + + 説明 + この関数によりパラメータリストから + パラメータおよびその値を削除することが可能です. + エラー発生時に出力パラメータerrが存在しない場合, + メッセージがコンソールに出力されます. + + + + + + + + 参照 + + + init_param + + + set_param + + + get_param + + + add_param + + + is_param + + + + diff --git a/modules/parameters/help/ja_JP/set_param.xml b/modules/parameters/help/ja_JP/set_param.xml new file mode 100755 index 000000000..a34fa2af7 --- /dev/null +++ b/modules/parameters/help/ja_JP/set_param.xml @@ -0,0 +1,99 @@ + + + + + set_param + パラメータリストのパラメータの値を設定する + + + 呼び出し手順 + [param_list,err] = set_param(list_name,param_name,param_value) + + + 引数 + + + list_name + + パラメータのリスト. このリストはinit_paramをコールすることにより + 初期化されている必要があります. + + + + + param_name + + 文字列. 値を指定するパラメータリストのパラメータ. + + + + param_value + + パラメータparam_nameの値. + + + + param_list + + 更新後のパラメータリスト. + + + + err + + エラーフラグで,list_nameがplist型でない + (このリストはinit_paramをコールすることにより初期化されていない) + 場合 %T に設定されます. + + + + + + + 説明 + この関数は,既に存在するパラメータの値を設定します. + パラメータ存在しない場合,errが%Tに設定されます. + エラー発生時に出力パラメータerrが存在しない場合, + メッセージがコンソールに出力されます. + + + + + + + + 参照 + + + init_param + + + add_param + + + get_param + + + remove_param + + + is_param + + + + diff --git a/modules/parameters/help/pt_BR/addchapter.sce b/modules/parameters/help/pt_BR/addchapter.sce new file mode 100755 index 000000000..a5c2a7329 --- /dev/null +++ b/modules/parameters/help/pt_BR/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Parâmetros",SCI+"/modules/parameters/help/pt_BR",%T); + diff --git a/modules/parameters/help/ru_RU/addchapter.sce b/modules/parameters/help/ru_RU/addchapter.sce new file mode 100755 index 000000000..39aa796cf --- /dev/null +++ b/modules/parameters/help/ru_RU/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Parameters",SCI+"/modules/parameters/help/ru_RU",%T); + -- cgit