Mercurial > hg > ltpda

comparison m-toolbox/classes/@ltpda_tf/ltpda_tf.m @ 0:f0afece42f48

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import.
author Daniele Nicolodi <nicolodi@science.unitn.it>
date Wed, 23 Nov 2011 19:22:13 +0100
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:f0afece42f48
1 % LTPDA_TF is the abstract class which defines transfer functions.
2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 %
4 % DESCRIPTION: LTPDA_TF is the abstract class which defines transfer functions.
5 %
6 % SUPER CLASSES: ltpda_uoh < ltpda_uo < ltpda_obj
7 %
8 % SUB CLASSES: miir, mfir, pzmodel, rational, parfrac, ltpda_filter
9 %
10 % LTPDA_TF PROPERTIES:
11 %
12 % Protected Properties (read only)
13 % description - description of the object
14 % hist - history of the object (history object)
15 % name - name of the object
16 % iunits - input units of the object
17 % ounits - output units of the object
18 %
19 % LTPDA_TF METHODS:
20 %
21 % Public Methods
22 % bsubmit - Bsubmits the given collection of objects to an
23 % LTPDA Repository.
24 % created - Returns a time object of the last modification.
25 % creator - Extract the creator(s) from the history.
26 % eq - Overloads the == operator for ltpda objects.
27 % get - Get a property of a object.
28 % index - Index into a 'ltpda_uoh' object array or matrix.
29 % This properly captures the history.
30 % isprop - Tests if the given field is one of the object
31 % properties.
32 % ne - Overloads the ~= operator for ltpda objects.
33 % rebuild - Rebuilds the input objects using the history.
34 % report - Generates an HTML report about the input objects.
35 % resp - Returns the complex response of a transfer
36 % function as an Analysis Object.
37 % save - Overloads save operator for ltpda objects.
38 % setDescription - Sets the 'description' property of an ltpda_uoh
39 % object.
40 % setIunits - Sets the 'iunits' property of the ao.
41 % setName - Set the property 'name'.
42 % setOunits - Sets the 'ounits' property of the ao.
43 % setProperties - Set different properties of an object.
44 % string - Writes a command string that can be used to
45 % recreate the input object(s).
46 % submit - Submits the given collection of objects to an
47 % LTPDA Repository.
48 % type - Converts the input objects to MATLAB functions.
49 %
50 % Static Methods
51 % SETS - Retruns the different sets of the constructor
52 % getDefaultPlist - Returns the default plsit for the specified set-name
53 % getInfo - Static method to get information of a method
54 % retrieve - Retrieves a collection of objects from an LTPDA
55 % repository.
56 %
57 % Abstract Methods
58 % char
59 % copy
60 % display
61 %
62 % VERSION: $Id: ltpda_tf.m,v 1.10 2011/02/14 19:17:42 ingo Exp $
63 %
64 % SEE ALSO: miir, mfir, pzmodel, parfrac, rational, ltpda_uoh, ltpda_uo, ltpda_obj
65 %
66 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
67
68 classdef (Hidden = true) ltpda_tf < ltpda_uoh
69
70
71 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
72 % Property definition %
73 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
74
75 %---------- Public (read/write) Properties ----------
76 properties
77 end
78
79 %---------- Protected read-only Properties ----------
80 properties (SetAccess = protected)
81 iunits = unit(); % input units of the object
82 ounits = unit(); % output units of the object
83 end
84
85 %---------- Private Properties ----------
86 properties (GetAccess = protected, SetAccess = protected)
87 end
88
89 %---------- Abstract Properties ----------
90 properties (Abstract = true, SetAccess = protected)
91 end
92
93 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
94 % Check property setting %
95 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
96
97 methods
98 function set.iunits(obj, val)
99 if ischar(val)
100 val = unit(val);
101 elseif isa(val, 'unit')
102 else
103 error('### The value for the property ''iunits'' must be a char or a unit-object');
104 end
105 obj.iunits = val;
106 end
107 function set.ounits(obj, val)
108 if ischar(val)
109 val = unit(val);
110 elseif isa(val, 'unit')
111 else
112 error('### The value for the property ''ounits'' must be a char or a unit-object');
113 end
114 obj.ounits = val;
115 end
116 end
117
118 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
119 % Constructor %
120 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
121
122 methods
123 function obj = ltpda_tf(varargin)
124 end
125 end
126
127 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
128 % Methods (public) %
129 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
130
131 methods
132 varargout = setIunits(varargin)
133 varargout = setOunits(varargin)
134 varargout = resp(varargin)
135 varargout = simplifyUnits(varargin);
136 end
137
138 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
139 % Methods (protected) %
140 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
141
142 methods (Access = protected)
143 varargout = fromStruct(varargin)
144 varargout = fromDom(varargin)
145 end
146
147 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
148 % Methods (static) %
149 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
150
151 methods (Static)
152 function ii = getInfo(varargin)
153 ii = utils.helper.generic_getInfo(varargin{:}, 'ltpda_tf');
154 end
155
156 function out = VEROUT()
157 out = '$Id: ltpda_tf.m,v 1.10 2011/02/14 19:17:42 ingo Exp $';
158 end
159
160 function out = SETS()
161 out = {};
162 end
163
164 function out = getDefaultPlist()
165 out = [];
166 end
167
168 end
169
170 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
171 % Methods (abstract) %
172 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
173
174 methods (Abstract, Access = protected)
175 r = respCore(obj, f)
176 end
177
178 end
179