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

vb_batch_mgr_duplicate_parm

PURPOSE ^

Duplicate specified parameter

SYNOPSIS ^

function [obj] = vb_batch_mgr_duplicate_parm(obj, ix_main, ix_sub)

DESCRIPTION ^

 Duplicate specified parameter
 [USAGE]
    [obj] = vb_batch_mgr_duplicate_parm(<obj>,<ix_main>,<ix_sub>);
 [IN]
        obj : vb_batch_mgr object.
    ix_main : parameter set specifier
               = 0 : template parameter set
               >=1 : batch parameter set
     ix_sub : Nth parameter in the parameter set.
 [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_duplicate_parm(obj, ix_main, ix_sub)
0002 % Duplicate specified parameter
0003 % [USAGE]
0004 %    [obj] = vb_batch_mgr_duplicate_parm(<obj>,<ix_main>,<ix_sub>);
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_sub : Nth parameter in the parameter set.
0011 % [OUT]
0012 %        obj : vb_batch_mgr object.
0013 %
0014 % Copyright (C) 2011, ATR All Rights Reserved.
0015 % License : New BSD License(see VBMEG_LICENSE.txt)
0016 
0017 %
0018 % --- Previous check
0019 %
0020 if ~exist('obj', 'var')
0021     error('obj is a required parameter.');
0022 end
0023 if ~exist('ix_main', 'var')
0024     error('ix_main is a required parameter.');
0025 end
0026 if ~exist('ix_sub', 'var')
0027     error('ix_sub is a required parameter.');
0028 end
0029 
0030 %
0031 % --- Main Procedure
0032 %
0033 
0034 % Get specified parameter
0035 [parm, parm_type] = vb_batch_mgr_get_parm(obj, ix_main, ix_sub);
0036 
0037 % Add copy mark
0038 if isfield(parm, 'time_stamp')
0039     parm.time_stamp = ['c' parm.time_stamp];
0040 end
0041 
0042 % Add parameter to the specified set
0043 obj = vb_batch_mgr_add_parm(obj, ix_main, parm, parm_type);
0044 
0045 %
0046 % --- After check
0047 %
0048 if nargout < 1
0049     error('function caller should receive this object.');
0050 end

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