Home > functions > gui > batch > batch_parm_set > vb_batch_parm_set_remove_parm.m

vb_batch_parm_set_remove_parm

PURPOSE ^

Remove parameter from parameter set

SYNOPSIS ^

function [obj] = vb_batch_parm_set_remove_parm(obj, ix)

DESCRIPTION ^

 Remove parameter from parameter set

 [USAGE]
    [obj] = vb_batch_parm_set_remove_parm(<obj>, <ix>);
 [IN]
    obj : vb_batch_parm_set object
     ix : index of this parameter set.
 [OUT]
    obj : vb_batch_parm_set object

 Copyright (C) 2011, ATR All Rights Reserved.
 License : New BSD License(see VBMEG_LICENSE.txt)

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function [obj] = vb_batch_parm_set_remove_parm(obj, ix)
0002 % Remove parameter from parameter set
0003 %
0004 % [USAGE]
0005 %    [obj] = vb_batch_parm_set_remove_parm(<obj>, <ix>);
0006 % [IN]
0007 %    obj : vb_batch_parm_set object
0008 %     ix : index of this parameter set.
0009 % [OUT]
0010 %    obj : vb_batch_parm_set object
0011 %
0012 % Copyright (C) 2011, ATR All Rights Reserved.
0013 % License : New BSD License(see VBMEG_LICENSE.txt)
0014 
0015 %
0016 % --- Previous check
0017 %
0018 if ~exist('obj', 'var')
0019     error('obj is a required parameter.');
0020 end
0021 if ~exist('ix', 'var')
0022     error('ix is a required parameter.');
0023 end
0024 
0025 %
0026 % --- Main Procedure
0027 %
0028 try
0029     obj.list(ix, :) = [];
0030 catch
0031     warning('specified index is invalid.');
0032 end
0033 
0034 %
0035 % --- After check
0036 %
0037 if nargout < 1
0038     error('function caller should receive vb_batch_parm_set object.');
0039 end

Generated on Tue 27-Aug-2013 11:46:04 by m2html © 2005