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

vb_batch_mgr_get_num_of_parm

PURPOSE ^

return the number of parameters which parameter set has.

SYNOPSIS ^

function [N] = vb_batch_mgr_get_num_of_parm(obj, ix_main)

DESCRIPTION ^

 return the number of parameters which parameter set has.

 [USAGE]
    [N] = vb_batch_mgr_get_num_of_parm(<obj>,<ix_main>)
 [IN]
        obj : vb_batch_mgr object
    ix_main : = 0 : check template parameter set.
    ix_main   >=1 : check specified parameter set.
                    (to get the number of parameter set,
                     use vb_batch_mgr_get_num_of_parm_set(); )
 [OUT]
    the number of parameters which parameter set has.

 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 [N] = vb_batch_mgr_get_num_of_parm(obj, ix_main)
0002 % return the number of parameters which parameter set has.
0003 %
0004 % [USAGE]
0005 %    [N] = vb_batch_mgr_get_num_of_parm(<obj>,<ix_main>)
0006 % [IN]
0007 %        obj : vb_batch_mgr object
0008 %    ix_main : = 0 : check template parameter set.
0009 %    ix_main   >=1 : check specified parameter set.
0010 %                    (to get the number of parameter set,
0011 %                     use vb_batch_mgr_get_num_of_parm_set(); )
0012 % [OUT]
0013 %    the number of parameters which parameter set has.
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 
0028 %
0029 % --- Main Procedure
0030 %
0031 N = 0;
0032 [parm_set] = vb_batch_mgr_get_parm_set(obj, ix_main);
0033 
0034 % Return the number of parameters in the specified parameter set.
0035 if ~isempty(parm_set)
0036     N = vb_batch_parm_set_get_num_of_parm(parm_set);
0037 end

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