diff m-toolbox/classes/@ltpda_uo/setName.m @ 0:f0afece42f48

Import.
author Daniele Nicolodi <nicolodi@science.unitn.it>
date Wed, 23 Nov 2011 19:22:13 +0100
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/m-toolbox/classes/@ltpda_uo/setName.m	Wed Nov 23 19:22:13 2011 +0100
@@ -0,0 +1,134 @@
+% SETNAME Sets the property 'name' of an ltpda_uoh object.
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% DESCRIPTION: Sets the property 'name' of an ltpda_uoh object.
+%
+% CALL:        objs.setName(val);
+%              objs.setName(val1, val2);
+%              objs.setName(plist('name', val));
+%              objs = setName();
+%
+% EXAMPLE:     objs.setName() -> Sets the name to the variable name.
+%                                In this case to 'objs'
+%
+% INPUTS:      objs: Can be a vector, matrix, list, or a mix of them.
+%              val:
+%                 1. Single string e.g. 'val'
+%                      Each object in objs get this value.
+%                 2. Single string in a cell-array e.g. {'val'}
+%                      Each object in objs get this value.
+%                 3. cell-array with the same number of strings as in objs
+%                    e.g. {'val1', 'val2', 'val3'} and 3 objects in objs
+%                      Each object in objs get its corresponding value from the
+%                      cell-array
+%
+% <a href="matlab:utils.helper.displayMethodInfo('ltpda_uoh', 'setName')">Parameters Description</a>
+%
+% VERSION:     $Id: setName.m,v 1.20 2011/09/16 05:00:38 hewitson Exp $
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+function varargout = setName(varargin)
+  
+  % Check if this is a call from a class method
+  callerIsMethod = utils.helper.callerIsMethod;
+    
+  if callerIsMethod
+    in_names = {};
+  else
+    % Collect input variable names
+    in_names = cell(size(varargin));
+    for ii = 1:nargin,in_names{ii} = inputname(ii);end
+  end
+  
+  objects = setPropertyValue(...
+    varargin{:}, ...
+    in_names, ...
+    callerIsMethod, ...
+    'name', ...
+    @setterFcn, ...
+    nargout, ...
+    @getInfo);
+  
+  % set outputs
+  varargout = utils.helper.setoutputs(nargout, objects);
+  
+  % Setter function to set the name
+  function value = setterFcn(varargin)
+    
+    obj = varargin{1};
+    pl  = varargin{2};
+    if nargin > 2
+      value = varargin{3};
+    else      
+      value = in_names{1};
+      % Here we need to create the plist that will end up in the history
+      % because we want this actually variable name to be in the history
+      % otherwise the rebuild would end up setting the generated variable
+      % name as the object name.
+      pl.pset('name', value);
+    end
+    
+    MAX_LENGTH = 200;
+    
+    if ~ischar(value)
+      error('The ''name'' property requires a string value');
+    end
+    
+    if length(value) > MAX_LENGTH
+      chop = floor(MAX_LENGTH/2);
+      value = [value(1:chop) ' ... ' value(end-chop:end)];
+    end
+    
+    obj.name = value;
+    
+  end
+  
+end
+
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%                               Local Functions                               %
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% FUNCTION:    getInfo
+%
+% DESCRIPTION: Get Info Object
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+function ii = getInfo(varargin)
+  if nargin == 1 && strcmpi(varargin{1}, 'None')
+    sets = {};
+    pl   = [];
+  else
+    sets = {'Default'};
+    pl   = getDefaultPlist;
+  end
+  % Build info object
+  ii = minfo(mfilename, mfilename('class'), 'ltpda', utils.const.categories.helper, '$Id: setName.m,v 1.20 2011/09/16 05:00:38 hewitson Exp $', sets, pl);
+end
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% FUNCTION:    getDefaultPlist
+%
+% DESCRIPTION: Get Default Plist
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+function plout = getDefaultPlist()
+  persistent pl;
+  if ~exist('pl', 'var') || isempty(pl)
+    pl = buildplist();
+  end
+  plout = pl;
+end
+
+function pl = buildplist()
+  pl = plist({'name', 'New name for the object.'}, '');
+end
+