Home > classes > @ltpda_uo > ltpda_uo.m

ltpda_uo

PURPOSE ^

LTPDA_UO is the abstract ltpda base class for ltpda user object classes.

SYNOPSIS ^

This is a script file.

DESCRIPTION ^

 LTPDA_UO is the abstract ltpda base class for ltpda user object classes.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: LTPDA_UO 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.
              ALL ltpda user object classes inherit this 'abstract' class.

 SUPER CLASSES: ltpda_obj

 SUB CLASSES:   ltpda_uoh, plist

 PROPERTIES:

     Inherit Properties (read only)
       version  - cvs-version string.

     Protected Properties (read only)
       name     - name of object
       created  - creation time (time-object)
       creator  - contains a instance of the provenance class.

 LTPDA_UO Methods:

     Public Methods
       setName    - set the property 'name'
       save       - save ltpda user objects
       submit     - submits the given collection of objects to an LTPDA Repository.

     Protected Methods
       setCreated - set the property 'created'
       setCreator - set the property 'creator'

     Static Methods
       retrieve   - retrieve ltpda objects with given ids from the repository

     Abstract Methods
       string     - writes a command string that can be used to recreate the object

 M-FILE INFO: The following call returns an minfo object that contains
              information about the ltpda_uo constructor:
                   >> info = ltpda_uo.getInfo
              or   >> info = ltpda_uo.getInfo('ltpda_uo')

 VERSION:     $Id: ltpda_uo.m,v 1.23 2008/09/03 16:33:56 hewitson Exp $

 HISTORY:     19-05-2008 Diepholz
                 Creation.

 SEE ALSO: ltpda_obj, ltpda_uoh, plist

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 % LTPDA_UO is the abstract ltpda base class for ltpda user object classes.
0002 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0003 %
0004 % DESCRIPTION: LTPDA_UO 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 %              ALL ltpda user object classes inherit this 'abstract' class.
0008 %
0009 % SUPER CLASSES: ltpda_obj
0010 %
0011 % SUB CLASSES:   ltpda_uoh, plist
0012 %
0013 % PROPERTIES:
0014 %
0015 %     Inherit Properties (read only)
0016 %       version  - cvs-version string.
0017 %
0018 %     Protected Properties (read only)
0019 %       name     - name of object
0020 %       created  - creation time (time-object)
0021 %       creator  - contains a instance of the provenance class.
0022 %
0023 % LTPDA_UO Methods:
0024 %
0025 %     Public Methods
0026 %       setName    - set the property 'name'
0027 %       save       - save ltpda user objects
0028 %       submit     - submits the given collection of objects to an LTPDA Repository.
0029 %
0030 %     Protected Methods
0031 %       setCreated - set the property 'created'
0032 %       setCreator - set the property 'creator'
0033 %
0034 %     Static Methods
0035 %       retrieve   - retrieve ltpda objects with given ids from the repository
0036 %
0037 %     Abstract Methods
0038 %       string     - writes a command string that can be used to recreate the object
0039 %
0040 % M-FILE INFO: The following call returns an minfo object that contains
0041 %              information about the ltpda_uo constructor:
0042 %                   >> info = ltpda_uo.getInfo
0043 %              or   >> info = ltpda_uo.getInfo('ltpda_uo')
0044 %
0045 % VERSION:     $Id: ltpda_uo.m,v 1.23 2008/09/03 16:33:56 hewitson Exp $
0046 %
0047 % HISTORY:     19-05-2008 Diepholz
0048 %                 Creation.
0049 %
0050 % SEE ALSO: ltpda_obj, ltpda_uoh, plist
0051 %
0052 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0053 
0054 classdef ltpda_uo < ltpda_obj
0055 
0056 
0057   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0058   %                            Property definition                            %
0059   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0060 
0061   %---------- Public (read/write) Properties  ----------
0062   properties
0063   end
0064 
0065   %---------- Protected read-only Properties ----------
0066   properties (SetAccess = protected)
0067     name    = 'none';
0068     created = time(0);
0069     creator = provenance();
0070   end
0071 
0072   %---------- Private Properties ----------
0073   properties (GetAccess = protected, SetAccess = protected)
0074   end
0075 
0076   %---------- Abstract Properties ----------
0077   properties (Abstract = true, SetAccess = protected)
0078   end
0079 
0080   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0081   %                          Check property setting                           %
0082   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0083 
0084   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0085   %                                Constructor                                %
0086   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0087 
0088   methods
0089     function obj = ltpda_uo(varargin)
0090 
0091       %%% Call superclass
0092       obj = obj@ltpda_obj(varargin{:});
0093 
0094       %%%%%%%%%%   Set dafault values   %%%%%%%%%%
0095       %%% Exept for a struct as an input
0096       if ~(nargin == 1 && isstruct(varargin{1}))
0097         % Set created time
0098         obj.created = time();
0099       end
0100 
0101       if nargin == 1
0102 
0103         if isstruct(varargin{1})
0104           %%%%%%%%%%   obj = ltpda_uo(struct)   %%%%%%%%%%
0105 
0106           %%% Set properties which are declared in this class
0107           uo_struct = varargin{1};
0108 
0109           obj.name    = uo_struct.name;
0110           obj.created = utils.helper.struct2obj(uo_struct.created, 'time');
0111           obj.creator = utils.helper.struct2obj(uo_struct.creator, 'provenance');
0112         end
0113 
0114       end
0115     end
0116 
0117   end
0118 
0119   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0120   %                              Methods (public)                             %
0121   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0122 
0123   methods
0124     varargout = submit(varargin)
0125     varargout = setName(varargin)
0126     varargout = save(varargin)
0127   end
0128 
0129   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0130   %                              Methods (protected)                          %
0131   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0132 
0133   methods (Access = protected)
0134     varargout = setCreated(obj, val)
0135     varargout = setCreator(obj, val)
0136   end
0137 
0138   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0139   %                              Methods (private)                             %
0140   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0141 
0142   methods (Access = protected)
0143   end
0144 
0145   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0146   %                              Methods (static)                             %
0147   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0148 
0149   methods (Static)
0150 
0151     varargout = retrieve(varargin)
0152 
0153     function ii = getInfo(varargin)
0154       ii = utils.helper.generic_getInfo(varargin{:}, 'ltpda_uo');
0155     end
0156 
0157     function out = VEROUT()
0158       out = '$Id: ltpda_uo.m,v 1.23 2008/09/03 16:33:56 hewitson Exp $';
0159     end
0160 
0161     function out = SETS()
0162       out = {};
0163     end
0164 
0165     function out = getDefaultPlist()
0166       out = [];
0167     end
0168 
0169   end
0170 
0171   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0172   %                              Methods (abstract)                           %
0173   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0174 
0175   methods (Abstract)
0176     cmd = string(obj, varargin)
0177   end
0178 
0179 end
0180 
0181

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