Home > functions > gui > bm_editor > history > history_get_item.m

history_get_item

PURPOSE ^

get description and processing parameter.

SYNOPSIS ^

function [description, parm] = history_get_item(obj, index_no)

DESCRIPTION ^

 get description and processing parameter.
 [USAGE]
    [description, proc_parm] = history_get_item(<obj>, <index_no>);
 [IN]
         obj : history object
    index_no : index number of history(scalar)
 [OUT]
    description : <<string>>    explanation of history 
           parm : <<structure>> parameter

 --- Previous check


 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 [description, parm] = history_get_item(obj, index_no)
0002 % get description and processing parameter.
0003 % [USAGE]
0004 %    [description, proc_parm] = history_get_item(<obj>, <index_no>);
0005 % [IN]
0006 %         obj : history object
0007 %    index_no : index number of history(scalar)
0008 % [OUT]
0009 %    description : <<string>>    explanation of history
0010 %           parm : <<structure>> parameter
0011 %
0012 % --- Previous check
0013 %
0014 %
0015 % Copyright (C) 2011, ATR All Rights Reserved.
0016 % License : New BSD License(see VBMEG_LICENSE.txt)
0017 if ~exist('obj', 'var'), error('obj is a required parameter.'); end
0018 if ~exist('index_no', 'var')
0019     error('index_no is a required parameter.');
0020 end
0021 if length(index_no) > 1
0022     error('index_no should be scalar');
0023 end
0024 len = history_get_length(obj);
0025 if len < index_no
0026     error('specified index_no is invalid.');
0027 end
0028 
0029 %
0030 % --- Main Procedure
0031 %
0032 description = obj.item_list{index_no}.description;
0033 parm        = obj.item_list{index_no}.parm;

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