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

vb_batch_mgr_set_parm

PURPOSE ^

Set parameter to the specified parameter set

SYNOPSIS ^

function [obj, errmsg] =vb_batch_mgr_set_parm(obj, ix_main, ix_sub, parm, parm_type)

DESCRIPTION ^

 Set parameter to the specified parameter set

 [USAGE]
    [obj, errmsg] = 
        vb_batch_mgr_set_parm(<obj>, <ix_main>, <ix_sub>, <parm>, <parm_type>);
 [IN]
          obj : vb_batch_mgr object
      ix_main : parameter set specifier
                = 0 : template parameter set
                >=1 : batch parameter set
       ix_sub : index in the 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
    errmsg : if error occured, the reason will be containd.

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

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