


LTPDA_UOH is the abstract ltpda base class for ltpda user object classes with history
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
DESCRIPTION: LTPDA_UOH is the ltpda base class for ltpda user object classes
This class is an abstract class and it is not possible to create
an instance of this class.
SUPER CLASSES: ltpda_uo < ltpda_obj
SUB CLASSES: ao, miir, mfir, specwin, timespan, pzmodel, history, ssm,
PROPERTIES:
Inherit Properties (read only)
name - name of object
created - creation time (time-object)
prov - contains a instance of the provenance class.
hist - history of the object (history object)
version - cvs-version string.
Protected Properties (read only)
hist - history of the object (history object)
LTPDA_UOH Methods:
Protected Methods
setHist - set the property 'hist'
addHistory - add a history to a ltpda_uo object
Public Methods
setName - set the property 'name' - Overloading the method in ltpda_uo
This set-functions adds the history
M-FILE INFO: The following call returns an minfo object that contains
information about the ltpda_uoh constructor:
>> info = ltpda_uoh.getInfo
or >> info = ltpda_uoh.getInfo('ltpda_uoh')
VERSION: $Id: ltpda_uoh.m,v 1.12 2008/08/22 14:17:26 ingo Exp $
HISTORY: 19-05-2008 Diepholz
Creation.
SEE ALSO: ltpda_obj, ao, miir, mfir, specwin, timespan, pzmodel, history, ssm
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


0001 % LTPDA_UOH is the abstract ltpda base class for ltpda user object classes with history 0002 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0003 % 0004 % DESCRIPTION: LTPDA_UOH is the ltpda base class for ltpda user object classes 0005 % This class is an abstract class and it is not possible to create 0006 % an instance of this class. 0007 % 0008 % SUPER CLASSES: ltpda_uo < ltpda_obj 0009 % 0010 % SUB CLASSES: ao, miir, mfir, specwin, timespan, pzmodel, history, ssm, 0011 % 0012 % PROPERTIES: 0013 % 0014 % Inherit Properties (read only) 0015 % name - name of object 0016 % created - creation time (time-object) 0017 % prov - contains a instance of the provenance class. 0018 % hist - history of the object (history object) 0019 % version - cvs-version string. 0020 % 0021 % Protected Properties (read only) 0022 % hist - history of the object (history object) 0023 % 0024 % LTPDA_UOH Methods: 0025 % 0026 % Protected Methods 0027 % setHist - set the property 'hist' 0028 % addHistory - add a history to a ltpda_uo object 0029 % 0030 % Public Methods 0031 % setName - set the property 'name' - Overloading the method in ltpda_uo 0032 % This set-functions adds the history 0033 % 0034 % M-FILE INFO: The following call returns an minfo object that contains 0035 % information about the ltpda_uoh constructor: 0036 % >> info = ltpda_uoh.getInfo 0037 % or >> info = ltpda_uoh.getInfo('ltpda_uoh') 0038 % 0039 % VERSION: $Id: ltpda_uoh.m,v 1.12 2008/08/22 14:17:26 ingo Exp $ 0040 % 0041 % HISTORY: 19-05-2008 Diepholz 0042 % Creation. 0043 % 0044 % SEE ALSO: ltpda_obj, ao, miir, mfir, specwin, timespan, pzmodel, history, ssm 0045 % 0046 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0047 0048 classdef ltpda_uoh < ltpda_uo 0049 0050 0051 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0052 % Property definition % 0053 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0054 0055 %---------- Public (read/write) Properties ---------- 0056 properties 0057 end 0058 0059 %---------- Protected read-only Properties ---------- 0060 properties (SetAccess = protected) 0061 hist = ''; 0062 end 0063 0064 %---------- Private Properties ---------- 0065 properties (GetAccess = protected, SetAccess = protected) 0066 end 0067 0068 %---------- Abstract Properties ---------- 0069 properties (Abstract = true, SetAccess = protected) 0070 end 0071 0072 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0073 % Check property setting % 0074 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0075 0076 methods 0077 function obj = set.hist(obj, val) 0078 if ~(isa(val, 'history') || isempty(val)) 0079 error('### The value for the property ''hist'' must be\n### a history-object or empty but it is\n### from the class %s', class(val)); 0080 end 0081 obj.hist = val; 0082 end 0083 end 0084 0085 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0086 % Constructor % 0087 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0088 0089 methods 0090 function obj = ltpda_uoh(varargin) 0091 0092 %%% Call superclass 0093 obj = obj@ltpda_uo(varargin{:}); 0094 0095 %%%%%%%%%% Set dafault values %%%%%%%%%% 0096 %%% Exept for a struct as an input 0097 if ~(nargin == 1 && isstruct(varargin{1})) 0098 % Set version 0099 obj.prependVersion('$Id: ltpda_uoh.m,v 1.12 2008/08/22 14:17:26 ingo Exp $'); 0100 end 0101 0102 0103 if nargin == 1 0104 0105 if isstruct(varargin{1}) 0106 %%%%%%%%%% obj = ltpda_uoh(struct) %%%%%%%%%% 0107 %%% Set properties which are declared in this class 0108 obj.hist = utils.helper.struct2obj(varargin{1}.hist, 'history'); 0109 end 0110 0111 end 0112 0113 end 0114 0115 end 0116 0117 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0118 % Methods (public) % 0119 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0120 0121 methods 0122 end 0123 0124 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0125 % Methods (protected) % 0126 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0127 0128 methods (Access = protected) 0129 varargout = setHist(obj, val) 0130 obj = fromFile(pbj, pli) 0131 obj = fromRepository(obj, pli) 0132 obj = fromLISO(obj, filename) 0133 obj = fromDataInMAT(obj, data, filename) 0134 obj = fromDatafile(obj, pli) 0135 end 0136 0137 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0138 % Methods (public) % 0139 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0140 0141 methods 0142 varargout = addHistory(varargin) 0143 varargout = setName(varargin) 0144 end 0145 0146 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0147 % Methods (static) % 0148 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0149 0150 methods (Static) 0151 function ii = getInfo(varargin) 0152 ii = utils.helper.generic_getInfo(varargin{:}, 'ltpda_uoh'); 0153 end 0154 0155 function out = VEROUT() 0156 out = '$Id: ltpda_uoh.m,v 1.12 2008/08/22 14:17:26 ingo Exp $'; 0157 end 0158 0159 function out = SETS() 0160 out = {}; 0161 end 0162 0163 function out = getDefaultPlist() 0164 out = []; 0165 end 0166 0167 end 0168 0169 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0170 % Methods (abstract) % 0171 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 0172 0173 methods (Abstract) 0174 end 0175 0176 end 0177