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

Default

no description
Key Default Value Options Description
KEY '' none The key of the parameter to set the default index for.
OPTIONS -1 none The index to set.
back to top 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 8ab8cbbc4bccf7543491a24448f4aae0b1be1c43
Min input args 1
Max input args -1
Min output args 1
Max output args -1




©LTP Team