Home > functions > gui > batch > batch_mgr > private > vb_batch_mgr_get_parm_set.m

vb_batch_mgr_get_parm_set

PURPOSE ^

get parameter set.

SYNOPSIS ^

function [parm_set] = vb_batch_mgr_get_parm_set(obj, ix)

DESCRIPTION ^

 get parameter set.
 This is inner private function.(utility)
 [USAGE]
    [parm_set] = vb_batch_mgr_get_focus_parm_set(<obj>, <ix>);
 [IN]
    obj : vb_batch_mgr object
     ix : index for focusing on parameter set. [INTEGER]
           = 0 : template parameter set.
           >=1 : batch parameter set.
 [OUT]
    parm_set : 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 [parm_set] = vb_batch_mgr_get_parm_set(obj, ix)
0002 % get parameter set.
0003 % This is inner private function.(utility)
0004 % [USAGE]
0005 %    [parm_set] = vb_batch_mgr_get_focus_parm_set(<obj>, <ix>);
0006 % [IN]
0007 %    obj : vb_batch_mgr object
0008 %     ix : index for focusing on parameter set. [INTEGER]
0009 %           = 0 : template parameter set.
0010 %           >=1 : batch parameter set.
0011 % [OUT]
0012 %    parm_set : vb_batch_parm_set 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', 'var')
0024     error('ix is a required parameter.');
0025 end
0026 if ix < 0
0027     error('Invalid index is specified. maybe bug of the program');
0028 end
0029 
0030 %
0031 % --- Main Procedure
0032 %
0033 try
0034     if ix == 0
0035         parm_set = obj.template;
0036     else
0037         parm_set = obj.parm_set{ix};
0038     end
0039 catch
0040     parm_set = [];
0041 end

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