Home > functions > gui > bm_editor > bm_manager > bm_manager_set_process_parameter.m

bm_manager_set_process_parameter

PURPOSE ^

set parameter to parameter list

SYNOPSIS ^

function [obj, result] =bm_manager_set_process_parameter(obj, parm_type, parm)

DESCRIPTION ^

 set parameter to parameter list
 [USAGE]
    [obj, result] = ...
    bm_manager_set_process_parameter(<obj>, <parm_type>, <parm>);
 [IN]
          obj : bm_manager object
    parm_type : parameter type
         parm : <<structure>> parameter
 [OUT]
       obj : bm_manager object
    result : set result(SUCCESS/FAILURE)

 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, result] = ...
0002         bm_manager_set_process_parameter(obj, parm_type, parm)
0003 % set parameter to parameter list
0004 % [USAGE]
0005 %    [obj, result] = ...
0006 %    bm_manager_set_process_parameter(<obj>, <parm_type>, <parm>);
0007 % [IN]
0008 %          obj : bm_manager object
0009 %    parm_type : parameter type
0010 %         parm : <<structure>> parameter
0011 % [OUT]
0012 %       obj : bm_manager object
0013 %    result : set result(SUCCESS/FAILURE)
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'), error('obj is a required parameter.'); end
0022 if ~strcmp(obj.class_type, 'bm_manager')
0023     error('class type is invalid.');
0024 end
0025 if ~exist('parm_type', 'var')
0026     error('parm_type is a required parameter.');
0027 end
0028 if ~exist('parm', 'var'), error('parm is a required parameter.'); end
0029 
0030 %
0031 % --- Main Procedure
0032 %
0033 
0034 % set parameter to parameter list
0035 [obj.parm_list, result] = ...
0036     bm_process_parm_list_set_parameter(obj.parm_list, parm_type, parm);
0037 
0038 %
0039 % --- After check
0040 %
0041 if nargout ~= 2
0042     error('function caller should receive obj and result');
0043 end

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