Method pest/setYunitsForParameter
SETYUNITSFORPARAMETER Sets the according y-unit for the specified parameter.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
DESCRIPTION: SETYUNITSFORPARAMETER Sets the according y-unit for the
specified parameter.
CALL: obj = obj.setYunitsForParameter('a', 'Hz');
obj = obj.setYunitsForParameter('a', unit('s'), 'b', 'Hz');
obj = obj.setYunitsForParameter(plist('units', [unit('s') unit('Hz')],
'params' {'a', 'b'}))
INPUTS: obj - one pest object.
pl - parameter list
Parameters Description
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details |
|
Access |
public |
Defining Class |
pest |
Sealed |
0 |
Static |
0 |
Parameter Description
Sets for this method … |
Default |
Default |
no description |
Key |
Default Value |
Options |
Description |
setYunitsForParameter |
PARAMS |
'{}' |
none |
A cell-array of parameter names. |
UNITS |
'{}' |
none |
A cell-array of units, one for each parameter to set. |
Example |
plist('PARAMS', '{}', 'UNITS', '{}') |
back to top
Some information of the method pest/setYunitsForParameter are listed below: |
Class name |
pest |
Method name |
setYunitsForParameter |
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: pest/setYunits |
|
Method: pest/simplifyYunits |
 |
©LTP Team