| LTPDA Toolbox™ | contents | ![]() |
|
Back to Class descriptions
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:The set access is 'protected' and thus it is only possible to assign a value to a property with a set-method.
val = obj.prop(2).prop;
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 | Defining 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 | plotinfo object | 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 | Description | Defining Class |
|---|---|---|
| conj | Gives the complex conjugate of the input smodels | smodel |
| minus | Implements subtraction operator for smodel objects. | smodel |
| mrdivide | Implements mrdivide operator for smodel objects. | smodel |
| mtimes | Implements mtimes operator for smodel objects. | smodel |
| plus | Implements addition operator for smodel objects. | smodel |
| rdivide | Implements division operator for smodel objects. | smodel |
| times | Implements multiplication operator for smodel objects. | smodel |
Back to Top of Section
| Methods | Description | Defining Class |
|---|---|---|
| rebuild | Rebuilds the input objects using the history. | ltpda_uoh |
| smodel | Constructor for smodel class. | smodel |
Back to Top of Section
| Methods | Description | Defining Class |
|---|---|---|
| get | Get a property of a object. | ltpda_obj |
| setDescription | Sets the 'description' property of a ltpda_uoh object. | ltpda_uo |
| setMdlfile | Sets the 'mdlfile' property of a ltpda_uoh object. | ltpda_uo |
| setName | Sets the property 'name' of an ltpda_uoh object. | ltpda_uo |
| created | Returns a time object of the last modification. | ltpda_uoh |
| creator | Extract the creator(s) from the history. | ltpda_uoh |
| csvexport | Exports the data of an object to a csv file. | ltpda_uoh |
| index | Index into a 'ltpda_uoh' object array or matrix. This properly captures the history. | ltpda_uoh |
| plot | Plots the user object on a figure. | ltpda_uoh |
| requirements | Returns a list of LTPDA extension requirements for a given object. | ltpda_uoh |
| setPlotAxes | Sets the 'axes' property of a the object's plotinfo. | ltpda_uoh |
| setPlotColor | Sets the color of a the object's plotinfo. | ltpda_uoh |
| setPlotFigure | Sets the 'figure' property of a the object's plotinfo. | ltpda_uoh |
| setPlotLineStyle | Sets the linestyle of a the object's plotinfo. | ltpda_uoh |
| setPlotLinewidth | Sets the linewidth of a the object's plotinfo. | ltpda_uoh |
| setPlotMarker | Sets the marker of a the object's plotinfo. | ltpda_uoh |
| setPlotMarkersize | Sets the markersize of a the object's plotinfo. | ltpda_uoh |
| setPlotinfo | Sets the 'plotinfo' property of a ltpda_uoh object. | ltpda_uoh |
| setPlottingStyle | Sets the style property of a the object's plotinfo. | ltpda_uoh |
| setProcinfo | Sets the 'procinfo' property of a ltpda_uoh object. | ltpda_uoh |
| setShowsErrors | Sets the 'showErrors' property of a the object's plotinfo. | ltpda_uoh |
| addAliases | Add the key-value pairs to the alias-names and alias-values | smodel |
| addParameters | Add some parameters to the symbolic model (smodel) object | smodel |
| assignalias | Assign values to smodel alias | smodel |
| clearAliases | Clear the aliases. | smodel |
| double | Returns the numeric result of the model. | smodel |
| eval | Evaluates the symbolic model and returns an AO containing the numeric data. | smodel |
| fitfunc | Returns a function handle which sets the 'values' and 'xvals' to a ltpda model. | smodel |
| hessian | Compute the hessian matrix for a symbolic model. | smodel |
| op | Add a operation around the model expression | smodel |
| setAliasNames | Set the property 'aliasNames' | smodel |
| setAliasValues | Set the property 'aliasValues' | smodel |
| setAliases | Set the key-value pairs to the alias-names and alias-values | smodel |
| setParameters | Set some parameters to the symbolic model (smodel) object | smodel |
| setParams | Set the property 'params' AND 'values' | smodel |
| setTrans | Sets the 'trans' property of the smodel object. | smodel |
| setValues | Set the property 'values' | smodel |
| setXunits | Sets the 'xunits' property of the smodel object. | smodel |
| setXvals | Sets the 'xvals' property of the smodel object. | smodel |
| setXvar | Sets the 'xvar' property of the smodel object. | smodel |
| setYunits | Sets the 'yunits' property of the smodel object. | smodel |
| simplifyUnits | Simplify the x and/or y units of the model. | smodel |
| subs | Substitutes symbolic parameters with the given values. | smodel |
Back to Top of Section
| Methods | Description | Defining Class |
|---|---|---|
| isprop | Tests if the given field is one of the object properties. | ltpda_obj |
| bsubmit | Submits the given collection of objects in binary form to an LTPDA repository | ltpda_uo |
| submit | Submits the given collection of objects to an LTPDA repository | ltpda_uo |
| update | Updates the given object in an LTPDA repository | ltpda_uo |
| string | Writes a command string that can be used to recreate the input object(s). | ltpda_uoh |
| type | Converts the input objects to MATLAB functions. | ltpda_uoh |
| generateConstructorPlist | Generates a PLIST from the properties which can rebuild the object. | smodel |
Back to Top of Section
| Methods | Description | Defining Class |
|---|---|---|
| convol_integral | Implements the convolution integral for smodel objects. | smodel |
| det | Evaluates the determinant of smodel objects. | smodel |
| diff | Implements differentiation operator for smodel objects. | smodel |
| fourier | Implements continuous f-domain Fourier transform for smodel objects. | smodel |
| ifourier | Implements continuous f-domain inverse Fourier transform for smodel objects. | smodel |
| ilaplace | Implements continuous s-domain inverse Laplace transform for smodel objects. | smodel |
| inv | Evaluates the inverse of smodel objects. | smodel |
| iztrans | Implements continuous z-domain inverse Z-transform for smodel objects. | smodel |
| laplace | Implements continuous s-domain Laplace transform for smodel objects. | smodel |
| linearize | Output the derivatives of the model relative to the parameters. | smodel |
| simplify | Implements simplify operator for smodel objects. | smodel |
| sum | Adds all the elements of smodel objects arrays. | smodel |
| ztrans | Implements continuous z-domain Z-transform for smodel objects. | smodel |
Back to Top of Section
| Methods | Description | Defining Class |
|---|---|---|
| save | Overloads save operator for ltpda objects. | ltpda_uo |
| report | Generates an HTML report about the input objects. | ltpda_uoh |
| viewHistory | Displays the history of an object as a dot-view or a MATLAB figure. | ltpda_uoh |
| char | Convert a smodel object into a string. | smodel |
| display | Overloads display functionality for smodel objects. | smodel |
Back to Top of Section
| Methods | Description | Defining Class |
|---|---|---|
| eq | Overloads the == operator for ltpda objects. | ltpda_obj |
| isequal | Overloads the isequal operator for ltpda objects. | ltpda_obj |
| ne | Overloads the ~= operator for ltpda objects. | ltpda_obj |
Back to Top of Section
|
rational Class | ssm Class | ![]() |
©LTP Team