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

vb_batch_parm_set_add_parm

PURPOSE ^

Add parameter to the parameter set

SYNOPSIS ^

function [obj] = vb_batch_parm_set_add_parm(obj, parm, parm_type)

DESCRIPTION ^

 Add parameter to the parameter set
 [USAGE]
   [obj] = vb_batch_parm_set_add_parm(<obj>, <parm>, <parm_type>);
 [IN]
          obj : vb_batch_parm_set object
         parm : to be added parameter to the set
    parm_type : parameter type such as 'brain_parm', 'head_parm',.. [STRING]
 [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_add_parm(obj, parm, parm_type)
0002 % Add parameter to the parameter set
0003 % [USAGE]
0004 %   [obj] = vb_batch_parm_set_add_parm(<obj>, <parm>, <parm_type>);
0005 % [IN]
0006 %          obj : vb_batch_parm_set object
0007 %         parm : to be added parameter to the set
0008 %    parm_type : parameter type such as 'brain_parm', 'head_parm',.. [STRING]
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('parm', 'var')
0022     error('parm is a required parameter.');
0023 end
0024 if ~exist('parm_type', 'var')
0025     error('parm_type is a required parameter.');
0026 end
0027 
0028 
0029 %
0030 % --- Main Procedure
0031 %
0032 Nparm = size(obj.list, 1);
0033 obj.list{Nparm+1, 1} = parm;
0034 obj.list{Nparm+1, 2} = parm_type;
0035 
0036 %
0037 % --- After check
0038 %
0039 if nargout < 1
0040     error('function caller should receive this object.');
0041 end

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