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

vb_batch_parm_set_swap

PURPOSE ^

swap parameters

SYNOPSIS ^

function [obj] = vb_batch_parm_set_swap(obj, ix1, ix2)

DESCRIPTION ^

 swap parameters
 [USAGE]
    [obj] = vb_batch_parm_set_swap(<obj>, <ix1>, <ix2>);
 [IN]
    obj : vb_batch_parm_set object
    ix1 : index to be swapped
    ix2 : index to be swapped
 [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_swap(obj, ix1, ix2)
0002 % swap parameters
0003 % [USAGE]
0004 %    [obj] = vb_batch_parm_set_swap(<obj>, <ix1>, <ix2>);
0005 % [IN]
0006 %    obj : vb_batch_parm_set object
0007 %    ix1 : index to be swapped
0008 %    ix2 : index to be swapped
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('ix1', 'var')
0022     error('ix1 is a required parameter.');
0023 end
0024 if ~exist('ix2', 'var')
0025     error('ix2 is a required parameter.');
0026 end
0027 
0028 %
0029 % --- Main Procedure
0030 %
0031 
0032 tmp = obj.list(ix1, :);
0033 obj.list(ix1, :) = obj.list(ix2, :);
0034 obj.list(ix2, :) = tmp;
0035 
0036 %
0037 % --- After check
0038 %
0039 if nargout < 1
0040     error('function caller should receive vb_batch_parm_set object.');
0041 end

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