brain_data_add_history_item

 add processing history to brain_data.
 [USAGE]
    [obj] = brain_data_add_history_item(<obj>, <description>[, proc_parm]);
 [IN]
            obj : brain_data object
    description : comment
      proc_parm : processing parameter object.
 [OUT]
    obj : brain_data object

 Copyright (C) 2011, ATR All Rights Reserved.
 License : New BSD License(see VBMEG_LICENSE.txt)

0001 function [obj] = brain_data_add_history_item(obj, description, proc_parm)
0002 % add processing history to brain_data.
0003 % [USAGE]
0004 %    [obj] = brain_data_add_history_item(<obj>, <description>[, proc_parm]);
0005 % [IN]
0006 %            obj : brain_data object
0007 %    description : comment
0008 %      proc_parm : processing parameter object.
0009 % [OUT]
0010 %    obj : brain_data object
0011 %
0012 % Copyright (C) 2011, ATR All Rights Reserved.
0013 % License : New BSD License(see VBMEG_LICENSE.txt)
0014 
0015 %
0016 % --- Previous check
0017 %
0018 if ~exist('obj', 'var'), error('obj is a required parameter.'); end
0019 if ~exist('description', 'var')
0020     error('description is a required parameter.');
0021 end
0022 
0023 %
0024 % --- Main Procedure
0025 %
0026 if ~exist('proc_parm', 'var') || isempty(proc_parm)
0027     proc_parm = [];
0028 end
0029 obj.history = history_add_item(obj.history, description, proc_parm);
0030 
0031 %
0032 % --- After check
0033 %
0034 if nargout ~= 1
0035     error('function caller should receive obj.');
0036 end