smodel Class


Properties Properties of the class
Methods All Methods of the class ordered by category.
Examples Some constructor examples

Back to Class descriptions Back to Class descriptions

Properties

The LTPDA toolbox restrict access of the properties.

The get access is 'public' and thus it is possible to get the values with the dot-command (similar to structures).

For example:

val = obj.prop(2).prop;
The set access is 'protected' and thus it is only possible to assign a value to a property with a set-method.
For example:
obj2 = obj1.setName('my name') % This command creates a copy of obj1 (obj1 ~= obj2)
obj.setName('my name');        % This command applies to obj    

Properties Description Defined in class

expr

Expression of the model

smodel

params

Parameters which are used in the model

smodel

values

Default values for the parameters

smodel

trans

Transformation strings mapping xvals in terms of xvar to X in the model

smodel

aliasNames

{'v', 'H'};

smodel

aliasValues

{'a*b', [1:20]};

smodel

xvar

Cell-array with x-variable(s)

smodel

xvals

Cell-array of double-values for the different x-variable(s)

smodel

xunits

vector of units of the different x-axis

smodel

yunits

units of the y-axis

smodel

hist

history of the object (history object)

ltpda_uoh

procinfo

plist with additional information for an object.

ltpda_uoh

plotinfo

plist with the plot information

ltpda_uoh

name

name of the object

ltpda_uo

description

description of the object

ltpda_uo

mdlfile

model xml file of the LTPDAworkbench

ltpda_uo

UUID

Universally Unique Identifier of 128-bit

ltpda_uo

Back to Top Back to Top

Methods

Arithmetic Operator Arithmetic Operator
Constructor Constructor of this class
Helper Helper methods only for internal usage
Internal Internal methods only for internal usage
Operator Operator methods
Output Output methods
Relational Operator Relational operator methods

Back to Top Back to Top

Arithmetic Operator

Methods Description Defined in class

conj

CONJ gives the complex conjugate of the input smodels

smodel

minus

MINUS implements subtraction operator for smodel objects.

smodel

mrdivide

MRDIVIDE implements mrdivide operator for smodel objects.

smodel

mtimes

MTIMES implements mtimes operator for smodel objects.

smodel

plus

PLUS implements addition operator for smodel objects.

smodel

rdivide

RDIVIDE implements division operator for smodel objects.

smodel

times

TIMES implements multiplication operator for smodel objects.

smodel

Back to Top of Section Back to Top of Section

Constructor

Methods Description Defined in class

rebuild

REBUILD rebuilds the input objects using the history.

ltpda_uoh

smodel

SMODEL constructor for smodel class.

smodel

Back to Top of Section Back to Top of Section

Helper

Methods Description Defined in class

get

GET get a property of a object.

ltpda_obj

created

CREATED Returns a time object of the last modification.

ltpda_uoh

creator

CREATOR Extract the creator(s) from the history.

ltpda_uoh

csvexport

CSVEXPORT Exports the data of an object to a csv file.

ltpda_uoh

index

INDEX index into a 'ltpda_uoh' object array or matrix. This properly captures the history.

ltpda_uoh

requirements

REQUIREMENTS Returns a list of LTPDA extension requirements for a given object.

ltpda_uoh

setDescription

SETDESCRIPTION sets the 'description' property of a ltpda_uoh object.

ltpda_uoh

setMdlfile

SETMDLFILE sets the 'mdlfile' property of a ltpda_uoh object.

ltpda_uoh

setName

SETNAME Sets the property 'name' of an ltpda_uoh object.

ltpda_uoh

setPlotinfo

SETPLOTINFO sets the 'plotinfo' property of a ltpda_uoh object.

ltpda_uoh

setProcinfo

SETPROCINFO sets the 'procinfo' property of a ltpda_uoh object.

ltpda_uoh

addAliases

ADDALIASES Add the key-value pairs to the alias-names and alias-values

smodel

addParameters

ADDPARAMETERS Add some parameters to the symbolic model (smodel) object

smodel

assignalias

ASSIGNALIAS assign values to smodel alias

smodel

clearAliases

CLEARALIASES Clear the aliases.

smodel

double

DOUBLE Returns the numeric result of the model.

smodel

eval

EVAL evaluates the symbolic model and returns an AO containing the numeric data.

smodel

fitfunc

FITFUNC Returns a function handle which sets the 'values' and 'xvals' to a ltpda model.

smodel

hessian

hessian compute the hessian matrix for a symbolic model.

smodel

op

OP Add a operation around the model expression

smodel

setAliasNames

SETALIASNAMES Set the property 'aliasNames'

smodel

setAliasValues

SETALIASVALUES Set the property 'aliasValues'

smodel

setAliases

SETALIASES Set the key-value pairs to the alias-names and alias-values

smodel

setParameters

SETPARAMETERS Set some parameters to the symbolic model (smodel) object

smodel

setParams

SETPARAMS Set the property 'params' AND 'values'

smodel

setTrans

SETTRANS sets the 'trans' property of the smodel object.

smodel

setValues

SETVALUES Set the property 'values'

smodel

setXunits

SETXUNITS sets the 'xunits' property of the smodel object.

smodel

setXvals

SETXVALS sets the 'xvals' property of the smodel object.

smodel

setXvar

SETXVAR sets the 'xvar' property of the smodel object.

smodel

setYunits

SETYUNITS sets the 'yunits' property of the smodel object.

smodel

simplifyUnits

SIMPLIFYUNITS simplify the x and/or y units of the model.

smodel

subs

SUBS substitutes symbolic parameters with the given values.

smodel

Back to Top of Section Back to Top of Section

Internal

Methods Description Defined in class

isprop

ISPROP tests if the given field is one of the object properties.

ltpda_obj

bsubmit

BSUBMIT Submits the given collection of objects in binary form to an LTPDA repository

ltpda_uo

submit

SUBMIT Submits the given objects to an LTPDA repository

ltpda_uo

update

UPDATE Updates the given object in an LTPDA repository

ltpda_uo

string

STRING writes a command string that can be used to recreate the input object(s).

ltpda_uoh

type

TYPE converts the input objects to MATLAB functions.

ltpda_uoh

generateConstructorPlist

GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.

smodel

Back to Top of Section Back to Top of Section

Operator

Methods Description Defined in class

convol_integral

CONVOL_INTEGRAL implements the convolution integral for smodel objects.

smodel

det

DET evaluates the determinant of smodel objects.

smodel

diff

DIFF implements differentiation operator for smodel objects.

smodel

fourier

FOURIER implements continuous f-domain Fourier transform for smodel objects.

smodel

ifourier

IFOURIER implements continuous f-domain inverse Fourier transform for smodel objects.

smodel

ilaplace

ILAPLACE implements continuous s-domain inverse Laplace transform for smodel objects.

smodel

inv

INV evaluates the inverse of smodel objects.

smodel

iztrans

IZTRANS implements continuous z-domain inverse Z-transform for smodel objects.

smodel

laplace

LAPLACE implements continuous s-domain Laplace transform for smodel objects.

smodel

linearize

LINEARIZE output the derivatives of the model relative to the parameters.

smodel

simplify

SIMPLIFY implements simplify operator for smodel objects.

smodel

sum

SUM adds all the elements of smodel objects arrays.

smodel

ztrans

ZTRANS implements continuous z-domain Z-transform for smodel objects.

smodel

Back to Top of Section Back to Top of Section

Output

Methods Description Defined in class

save

SAVE overloads save operator for ltpda objects.

ltpda_uo

report

REPORT generates an HTML report about the input objects.

ltpda_uoh

viewHistory

VIEWHISTORY Displays the history of an object as a dot-view or a MATLAB figure.

ltpda_uoh

char

CHAR convert a smodel object into a string.

smodel

display

DISPLAY overloads display functionality for smodel objects.

smodel

Back to Top of Section Back to Top of Section

Relational Operator

Methods Description Defined in class

eq

EQ overloads the == operator for ltpda objects.

ltpda_obj

ne

NE overloads the ~= operator for ltpda objects.

ltpda_obj

Back to Top of Section Back to Top of Section




©LTP Team