Home > classes > @ltpda_uoh > ltpda_uoh.m

ltpda_uoh

PURPOSE ^

LTPDA_UOH is the abstract ltpda base class for ltpda user object classes with history

SYNOPSIS ^

This is a script file.

DESCRIPTION ^

 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.14 2008/09/03 16:34:07 hewitson Exp $

 HISTORY:     19-05-2008 Diepholz
                 Creation.

 SEE ALSO:    ltpda_obj, ao, miir, mfir, specwin, timespan, pzmodel, history, ssm

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

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.14 2008/09/03 16:34:07 hewitson 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 
0097       if nargin == 1
0098 
0099         if isstruct(varargin{1})
0100           %%%%%%%%%%   obj = ltpda_uoh(struct)   %%%%%%%%%%
0101           %%% Set properties which are declared in this class
0102           obj.hist = utils.helper.struct2obj(varargin{1}.hist, 'history');
0103         end
0104 
0105       end
0106 
0107     end
0108 
0109   end
0110 
0111   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0112   %                              Methods (public)                             %
0113   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0114 
0115   methods
0116   end
0117 
0118   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0119   %                              Methods (protected)                          %
0120   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0121 
0122   methods (Access = protected)
0123     varargout = setHist(obj, val)
0124     obj = fromFile(pbj, pli)
0125     obj = fromRepository(obj, pli)
0126     obj = fromLISO(obj, filename)
0127     obj = fromDataInMAT(obj, data, filename)
0128     obj = fromDatafile(obj, pli)
0129   end
0130 
0131   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0132   %                              Methods (public)                             %
0133   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0134 
0135   methods
0136     varargout = addHistory(varargin)
0137     varargout = setName(varargin)
0138   end
0139 
0140   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0141   %                              Methods (static)                             %
0142   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0143 
0144   methods (Static)
0145     function ii = getInfo(varargin)
0146       ii = utils.helper.generic_getInfo(varargin{:}, 'ltpda_uoh');
0147     end
0148 
0149     function out = VEROUT()
0150       out = '$Id: ltpda_uoh.m,v 1.14 2008/09/03 16:34:07 hewitson Exp $';
0151     end
0152 
0153     function out = SETS()
0154       out = {};
0155     end
0156 
0157     function out = getDefaultPlist()
0158       out = [];
0159     end
0160 
0161   end
0162 
0163   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0164   %                              Methods (abstract)                           %
0165   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0166 
0167   methods (Abstract)
0168   end
0169 
0170 end
0171

Generated on Mon 08-Sep-2008 13:18:47 by m2html © 2003