Home > functions > gui > bm_editor > bm_process_parm > bm_process_parm_set_parameter.m

bm_process_parm_set_parameter

PURPOSE ^

set parameter from inherit objects.

SYNOPSIS ^

function [obj, result] = bm_process_parm_set_parameter(obj, parm)

DESCRIPTION ^

 set parameter from inherit objects.
 [USAGE]
    [obj] = bm_process_parm_set_parameter(<obj>, <parm>);
 [IN]
    obj : bm_process_parm object
 [OUT]
      parm : parameter structure defined in inherit class.
    result : set result.

 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] = bm_process_parm_set_parameter(obj, parm)
0002 % set parameter from inherit objects.
0003 % [USAGE]
0004 %    [obj] = bm_process_parm_set_parameter(<obj>, <parm>);
0005 % [IN]
0006 %    obj : bm_process_parm object
0007 % [OUT]
0008 %      parm : parameter structure defined in inherit class.
0009 %    result : set result.
0010 %
0011 % Copyright (C) 2011, ATR All Rights Reserved.
0012 % License : New BSD License(see VBMEG_LICENSE.txt)
0013 
0014 %
0015 % --- Previous check
0016 %
0017 if ~exist('obj', 'var'), error('obj is a required parameter.'); end
0018 
0019 %
0020 % --- Main Procedure
0021 %
0022 result = bm_process_parm_check_parameter(obj);
0023 if result == FAILURE;
0024     return;
0025 else
0026     obj.parm = parm;
0027 end
0028 
0029 %
0030 % --- After check
0031 %
0032 if nargout ~= 2
0033     error('function caller should receive obj and result.');
0034 end

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