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

xvar

X-variable

smodel

xvals

Values for the x-variable

smodel

xunits

Units of the x-axis

smodel

yunits

Units of the y-axis

smodel

version

CVS version string of the constructor

smodel

hist

History object associated with this object

ltpda_uoh

procinfo

Contains extra processing information not contained in the main result of any method (plist-object).

ltpda_uoh

plotinfo

Plist-object which contains the plot information of the object

ltpda_uoh

name

Name of the object

ltpda_uo

description

Description of the object

ltpda_uo

mdlfile

Full text representation of the mdl-file that created this AO

ltpda_uo

UUID

Universally Unique Identifier of 128-bit

ltpda_uo

Back to Top Back to Top

Methods

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

minus

MINUS implements subtraction operator for ltpda model objects.

smodel

mrdivide

MRDIVIDE implements mrdivide operator for ltpda model objects.

smodel

mtimes

MTIMES implements mtimes operator for ltpda model objects.

smodel

plus

PLUS implements addition operator for ltpda model objects.

smodel

rdivide

RDIVIDE implements division operator for ltpda model objects.

smodel

times

TIMES implements multiplication operator for ltpda model 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

setDescription

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

ltpda_uoh

setMdlfile

SETMDLFILE sets the 'mdlfile' property of the ao.

ltpda_uoh

setName

SETNAME Set the property 'name'.

ltpda_uoh

setPlotinfo

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

ltpda_uoh

setProcinfo

SETPROCINFO sets the 'procinfo' property of the ao.

ltpda_uoh

setProperties

SETPROPERTIES set different properties of an object.

ltpda_uoh

conj

CONJ gives the complex conjugate of the input smodels

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

inv

INV makes the inverse of a matrix of smodels

smodel

op

OP Add a operation around the model expression

smodel

setParams

SETPARAMS Set the property 'params' AND 'values'

smodel

setValues

SETVALUES Set the property 'values'

smodel

setXunits

SETXUNITS Set the property 'xunits'.

smodel

setXvals

SETXVALS Set the property 'xvals'

smodel

setXvar

SETXVAR Set the property 'xvar'

smodel

setYunits

SETYUNITS Set the property 'yunits'.

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 collection of 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

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 for smodel objects matrices.

smodel

diff

DIFF implements differentiation operator for smodel objects.

smodel

inv_laplace_transform

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

smodel

simplify

SIMPLIFY implements simplify operator for smodel objects.

smodel

sum

SUM adds all the elements of smodel objects arrays.

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

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