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

vb_batch_mgr_swap_parm

PURPOSE ^

Swap parameters in the specified parameter set.

SYNOPSIS ^

function [obj] = vb_batch_mgr_swap_parm(obj, ix_main, ix_sub1, ix_sub2)

DESCRIPTION ^

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

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