Method plist/getDescriptionForParam


  GETDESCRIPTIONFORPARAM Returns the description for the specified parameter key.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: GETDESCRIPTIONFORPARAM Returns the description for the
               specified parameter key.
 
  CALL:        obj = obj.getDescriptionForParam('key');
               obj = obj.getDescriptionForParam(plist('key'));
               obj = getDescriptionForParam(obj, 'key');
 
  INPUTS:      obj - can be a vector, matrix, list, or a mix of them.
               key - Parameter key
 
  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 get the description of.

Example

plist('KEY', '')

back to top back to top

Some information of the method plist/getDescriptionForParam are listed below:
Class name plist
Method name getDescriptionForParam
Category Internal
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