Method smodel/smodel


  SMODEL constructor for smodel class.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: SMODEL constructor for smodel class.
 
  CONSTRUCTOR:
 
        mdl = smodel()             - creates an empty smodel object
        mdl = smodel('foo.mu')     - construct from MuPAD file
        mdl = smodel('expression') - construct from a expression
                                         description
 
  Parameters Description
 
  VERSION:     $Id: smodel.m,v 1.44 2012/02/29 07:52:26 hewitson Exp $
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class smodel
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
back to top back to top

From MAT File

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
FILENAME '' none MAT filename.
back to top back to top

From XML File

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
FILENAME '' none XML filename.
back to top back to top

From Repository

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
HOSTNAME '' none Database server hostname.
DATABASE '' none Database name.
USERNAME '' none User name to use when connecting to the database. Leave blank to be prompted.
PASSWORD [] none Password to use when connecting to the database. Leave blank to be prompted.
ID [] none A vector of object IDs.
CID [] none A vector of collection IDs.
BINARY 1
  • 1
  • 0
Use binary representation (not always available).
back to top back to top

From Built-in Model

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
BUILT-IN '' none Choose one of the built-in models. (use class.getBuiltInModels to get a list for a particular user class)
back to top back to top

From Expression

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
EXPRESSION '' none Expression of the model.
PARAMS {} [0x0] none Parameters which are used in the model.
VALUES {} [0x0] none Default values for the parameters.
XVAR '' none The X-dependent variable.
XVALS {} [0x0] none Values for the x-variable.
YUNITS '' none Units of the y output.
XUNITS '' none Units of the x output.
back to top back to top

From ASCII File

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PLOTINFO [] none The plot information for the constructed object. This information is interpreted by iplot. The value should be a plist with any or all of the following keys:
  • 'linestyle' - choose a MATLAB linestyle
  • 'linewidth' - choose a the line width
  • 'color' - choose a color for the resulting trace
  • 'marker' - choose a marker for the resulting trace
  • 'legend_on' - choose a true or false to include in the legend or not
FILENAME '' none ASCII filename.
XVALS {} [0x0] none Values for the x-variable.
YUNITS '' none Units of the y output.
XUNITS '' none Units of the x output.
back to top back to top

Some information of the method smodel/smodel are listed below:
Class name smodel
Method name smodel
Category Constructor
CVS Version $Id: smodel.m,v 1.44 2012/02/29 07:52:26 hewitson Exp $
Min input args 0
Max input args -1
Min output args 1
Max output args 1




©LTP Team