Home > classes > @ltpda_filter > setHistout.m

setHistout

PURPOSE ^

SETHISTOUT Set the property 'histout'

SYNOPSIS ^

function varargout = setHistout(varargin)

DESCRIPTION ^

 SETHISTOUT Set the property 'histout'
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: SETHISTOUT Set the property 'histout'

 CALL:        obj = obj.setHistout(2);
              obj = setHistout(obj, 2);

 INPUTS:      obj - is a ltpda_filter object

 M-FILE INFO: Get information about this methods by calling
              >> miir.getInfo('setHistout')

              Get information about a specified set-plist by calling:
              >> miir.getInfo('setHistout', 'set')

 VERSION:     $Id: setHistout.m,v 1.3 2008/09/04 15:29:30 ingo Exp $

 HISTORY:     16-07-2008 Diepholz
                 Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 % SETHISTOUT Set the property 'histout'
0002 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0003 %
0004 % DESCRIPTION: SETHISTOUT Set the property 'histout'
0005 %
0006 % CALL:        obj = obj.setHistout(2);
0007 %              obj = setHistout(obj, 2);
0008 %
0009 % INPUTS:      obj - is a ltpda_filter object
0010 %
0011 % M-FILE INFO: Get information about this methods by calling
0012 %              >> miir.getInfo('setHistout')
0013 %
0014 %              Get information about a specified set-plist by calling:
0015 %              >> miir.getInfo('setHistout', 'set')
0016 %
0017 % VERSION:     $Id: setHistout.m,v 1.3 2008/09/04 15:29:30 ingo Exp $
0018 %
0019 % HISTORY:     16-07-2008 Diepholz
0020 %                 Creation
0021 %
0022 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0023 
0024 function varargout = setHistout(varargin)
0025 
0026   %%% Check if this is a call for parameters
0027   if utils.helper.isinfocall(varargin{:})
0028     varargout{1} = getInfo(varargin{3});
0029     return
0030   end
0031 
0032   obj = varargin{1};
0033   val = varargin{2};
0034 
0035   %%% decide whether we modify the ltpda_filter-object, or create a new one.
0036   obj = copy(obj, nargout);
0037 
0038   %%% set 'histout'
0039   obj.histout = val;
0040 
0041   %%% set output
0042   varargout{1} = obj;
0043 end
0044 
0045 
0046 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0047 %                               Local Functions                               %
0048 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0049 
0050 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0051 %
0052 % FUNCTION:    getInfo
0053 %
0054 % DESCRIPTION: Get Info Object
0055 %
0056 % HISTORY:     11-07-07 M Hewitson
0057 %                Creation.
0058 %
0059 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0060 
0061 function ii = getInfo(varargin)
0062   if nargin == 1 && strcmpi(varargin{1}, 'None')
0063     sets = {};
0064     pl   = [];
0065   else
0066     sets = {'Default'};
0067     pl   = getDefaultPlist;
0068   end
0069   % Build info object
0070   ii = minfo(mfilename, 'ltpda_filter', '', utils.const.categories.internal, '$Id: setHistout.m,v 1.3 2008/09/04 15:29:30 ingo Exp $', sets, pl);
0071 end
0072 
0073 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0074 %
0075 % FUNCTION:    getDefaultPlist
0076 %
0077 % DESCRIPTION: Get Default Plist
0078 %
0079 % HISTORY:     11-07-07 M Hewitson
0080 %                Creation.
0081 %
0082 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0083 
0084 function plo = getDefaultPlist()
0085   plo = plist('histout', '');
0086 end
0087

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