Home > functions > gui > batch > batch_mgr > vb_batch_mgr_add_parm.m

vb_batch_mgr_add_parm

PURPOSE ^

Add the parameter to the specified parameter set.

SYNOPSIS ^

function [obj] = vb_batch_mgr_add_parm(obj, ix_main, parm, parm_type)

DESCRIPTION ^

 Add the parameter to the specified parameter set.

 [USAGE]
    [obj] = vb_batch_mgr_add_parm(<obj>, <ix_main>, <parm>, <parm_type>);
 [IN]
          obj : vb_batch_mgr object
      ix_main : parameter set specifier
                = 0 : template parameter set
                >=1 : batch parameter set
         parm : to be added parameter to the set
    parm_type : parameter type such as 'brain_parm', 'head_parm',.. [STRING]
 [OUT]
    obj : vb_batch_mgr 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_mgr_add_parm(obj, ix_main, parm, parm_type)
0002 % Add the parameter to the specified parameter set.
0003 %
0004 % [USAGE]
0005 %    [obj] = vb_batch_mgr_add_parm(<obj>, <ix_main>, <parm>, <parm_type>);
0006 % [IN]
0007 %          obj : vb_batch_mgr object
0008 %      ix_main : parameter set specifier
0009 %                = 0 : template parameter set
0010 %                >=1 : batch parameter set
0011 %         parm : to be added parameter to the set
0012 %    parm_type : parameter type such as 'brain_parm', 'head_parm',.. [STRING]
0013 % [OUT]
0014 %    obj : vb_batch_mgr object
0015 %
0016 % Copyright (C) 2011, ATR All Rights Reserved.
0017 % License : New BSD License(see VBMEG_LICENSE.txt)
0018 
0019 %
0020 % --- Previous check
0021 %
0022 if ~exist('obj', 'var')
0023     error('obj is a required parameter.');
0024 end
0025 if ~exist('ix_main', 'var')
0026     error('ix_main is a required parameter.');
0027 end
0028 if ~exist('parm', 'var')
0029     error('parm is a required parameter.');
0030 end
0031 if ~exist('parm_type', 'var')
0032     error('parm_type is a required parameter.');
0033 end
0034 
0035 %
0036 % --- Main Procedure
0037 %
0038 
0039 % get specified parameter set
0040 parm_set = vb_batch_mgr_get_parm_set(obj, ix_main);
0041 
0042 % add parameter to the set
0043 parm_set = vb_batch_parm_set_add_parm(parm_set, parm, parm_type);
0044 
0045 % save parameter set
0046 obj = vb_batch_mgr_set_parm_set(obj, ix_main, parm_set);
0047 
0048 %
0049 % --- After check
0050 %
0051 if nargout<1
0052     error('function caller should receive this object.');
0053 end

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