Mercurial > hg > ltpda

comparison m-toolbox/classes/@ltpda_obj/ltpda_obj.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_OBJ is the abstract ltpda base class.
2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 %
4 % DESCRIPTION: LTPDA_OBJ is the ltpda base class.
5 % This ltpda_obj class is an abstract class and it is not
6 % possible to create an instance of this class.
7 %
8 % SUPER CLASSES: handle (MATLAB class)
9 %
10 % SUB CLASSES: ltpda_nuc, ltpda_uc
11 %
12 % LTPDA_OBJ PROPERTIES:
13 %
14 % Protected Properties (read only)
15 %
16 % LTPDA_OBJ METHODS:
17 %
18 % Public Methods
19 % eq - Overloads the == operator for ltpda objects.
20 % get - Get a property of a object.
21 % isprop - Tests if the given field is one of the object
22 % properties.
23 % ne - Overloads the ~= operator for ltpda objects.
24 %
25 % Static Methods
26 % SETS - Retruns the different sets of the constructor
27 % getDefaultPlist - Returns the default plsit for the specified set-name
28 % getInfo - Static method to get information of a method
29 %
30 % Abstract Methods
31 % char
32 % copy
33 % display
34 %
35 % REMARK: It is necessary to define the ABSTRACT methods and properties in
36 % the sub-classes because if they are not defined is the sub-class
37 % as well an abstract class. (See ltpda_nuo)
38 %
39 % VERSION: $Id: ltpda_obj.m,v 1.39 2011/04/27 11:49:39 hewitson Exp $
40 %
41 % SEE ALSO: ltpda_nuo, ltpda_uo, handle
42 %
43 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
44
45 classdef (Hidden = true) ltpda_obj < handle
46
47 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
48 % Property definition %
49 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
50
51 %---------- Public (read/write) Properties ----------
52 properties
53 end
54
55 %---------- Protected read-only Properties ----------
56 properties (SetAccess = protected)
57 end
58
59 %---------- Abstract Properties ----------
60 properties (Abstract = true, SetAccess = protected)
61 end
62
63 %---------- Removed properties ----------
64 % We have to define the removed properties as hidden constants.
65 % In case of backwards compatibility it is necessary to keep them because
66 % MATLAB will read older MAT-files as structures which we have to convert
67 % into an object if we make major change to a class.
68 % For MATLAB is a major change if we remove a proeprty.
69 properties (Constant = true, Hidden = true)
70 version = '';
71 end
72
73 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
74 % Check property setting %
75 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
76
77 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
78 % Constructor %
79 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
80
81 methods
82 function obj = ltpda_obj(varargin)
83 end
84 end
85
86 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
87 % Methods (public) %
88 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
89
90 methods (Access = public)
91 varargout = eq(obj1, obj2, varargin)
92 varargout = ne(obj1, obj2, varargin)
93 varargout = isprop(varargin)
94 end
95
96 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
97 % Methods (hidden) %
98 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
99
100 methods (Hidden = true)
101 end
102
103 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
104 % Methods (protected) %
105 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
106
107 methods (Access = protected)
108 varargout = fromStruct(varargin)
109 varargout = fromDom(varargin)
110 end
111
112 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
113 % Methods (static) %
114 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
115
116 methods (Static)
117
118 function ii = getInfo(varargin)
119 ii = utils.helper.generic_getInfo(varargin{:}, 'ltpda_obj');
120 end
121
122 function out = VEROUT()
123 out = '$Id: ltpda_obj.m,v 1.39 2011/04/27 11:49:39 hewitson Exp $';
124 end
125
126 function out = SETS()
127 out = {};
128 end
129
130 function out = getDefaultPlist()
131 out = [];
132 end
133
134 end
135
136 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
137 % Methods (abstract, static, hidden) %
138 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
139
140 methods (Abstract, Static = true, Hidden = true)
141 varargout = loadobj(varargin)
142 end
143
144 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
145 % Methods (abstract) %
146 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
147
148 methods (Abstract)
149 varargout = char(varargin)
150 varargout = copy(varargin)
151 txt = display(varargin)
152 end
153
154 methods (Abstract = true, Static = true)
155 varargout = update_struct(varargin);
156 end
157
158 end
159