Method smodel/setXvar


  SETXVAR sets the 'xvar' property of the smodel object.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: SETXVAR sets the 'xvar' property of the smodel object.
 
  CALL:        objs.setXvar(val);
               objs.setXvar(val1, val2);
               objs.setXvar(plist('xvar', val));
               objs = objs.setXvar(val);
 
  INPUTS:      objs: Can be a vector, matrix, list, or a mix of them.
               val:  Can be any of the following types:
                      - string e.g. 'x1'
                      - plist with the key 'xvar' e.g. plist('xvar', {'x1', 'x2'})
                      - cell-array with the types above
 
  REMARK:      The x-variable defines later the type of the data object.
               't':       AO with time-series data
               'f':       AO with frequency-series data
               'w':       AO with frequency-series data
               all other: AO with xy data
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class smodel
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
setXvar
XVAR {} [0x0] none Specify the X-dependent variable in the model.

Example

plist('XVAR', cell(0,0))

back to top back to top

Some information of the method smodel/setXvar are listed below:
Class name smodel
Method name setXvar
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