Method plist/setSelectionForParam


  SETSELECTIONFORPARAM Sets the selection mode of the param object in dependencies of the 'key'
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: Sets the selection mode of the param object in dependencies
               of the 'key'
 
  CALL:        obj = obj.setSelectionForParam('key', selection);
               obj = obj.setSelectionForParam(plist('KEY', 'key', 'SELECTION', selection));
               obj = setSelectionForParam(obj, 'key', selection);
 
  INPUTS:      obj       - can be a vector, matrix, list, or a mix of them.
               key       - The key which should be changed
               selection - Selection mode of the parameter
               pl        - to set the default value of a key with a plist,
                           please specify only one plist with the key-words
                           'key' and 'selection'
 
  POSSIBLE VALUES FOR 'selection'
 
               selection:  1 == paramValue.OPTIONAL
                           2 == paramValue.SINGLE
                           3 == paramValue.MULTI
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class plist
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
utils.generic_getInfo
KEY '' none The key of the parameter to set the selection mode for.
SELECTION 1
  • 1
  • 2
  • 3
The selection mode to set.

Example

plist('KEY', '', 'SELECTION', [1])

back to top back to top

Some information of the method plist/setSelectionForParam are listed below:
Class name plist
Method name setSelectionForParam
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'}




©LTP Team