Method plist/setDefaultForParam
SETDEFAULTFORPARAM Sets the default value of the param object in dependencies of the 'key'
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
DESCRIPTION: Sets the default value (index to the possible options) of
the param object in dependencies of the 'key'.
CALL: obj = obj.setDefaultForParam('key', newOption);
obj = obj.setDefaultForParam(plist('KEY', 'key', 'option', newOption));
obj = setDefaultForParam(obj, 'key', newOption);
INPUTS: obj - can be a vector, matrix, list, or a mix of them.
key - The key which should be changed
newOption - new option for the selection mode
OPTIONAL: If the new option doesn't exist in
the param-options then add this
method the 'new' option.
SINGLE: Sets the 'new' option only if it is
found in the param-options.
pl - to set the default value of a key with a plist,
please specify only one plist with the key-words
'key' and 'option'
Parameters Description
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details |
|
Access |
public |
Defining Class |
plist |
Sealed |
0 |
Static |
0 |
Parameter Description
Sets for this method … |
Default |
Default |
no description |
Key |
Default Value |
Options |
Description |
utils.generic_getInfo |
KEY |
'' |
none |
The key of the parameter to set the default index for. |
OPTIONS |
-1 |
none |
The index to set. |
Example |
plist('KEY', '', 'OPTIONS', [-1]) |
back to top
Some information of the method plist/setDefaultForParam are listed below: |
Class name |
plist |
Method name |
setDefaultForParam |
Category |
Helper |
Package name |
ltpda |
VCS Version |
967b0eec0dece803a81af8ef54ad2f8c784b20b2 |
Min input args |
1 |
Max input args |
-1 |
Min output args |
1 |
Max output args |
-1 |
Can be used as modifier |
1 |
Supported numeric types |
{'double'} |
|
Method: plist/search |
|
Method: plist/setDescription |
 |
©LTP Team