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

history_get_item_all

PURPOSE ^

get all items

SYNOPSIS ^

function [item_list] = history_get_item_all(obj)

DESCRIPTION ^

 get all items
 [USAGE]
    [item_list] = history_get_item_all(<obj>);
 [IN]
    obj : history object
 [OUT]
    item_list : cell array of item.
                item_list{k}.description  % <<string>> history explanation
                item_list{k}.parm         % <<struct>> parameter

 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 [item_list] = history_get_item_all(obj)
0002 % get all items
0003 % [USAGE]
0004 %    [item_list] = history_get_item_all(<obj>);
0005 % [IN]
0006 %    obj : history object
0007 % [OUT]
0008 %    item_list : cell array of item.
0009 %                item_list{k}.description  % <<string>> history explanation
0010 %                item_list{k}.parm         % <<struct>> parameter
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 
0020 %
0021 % --- Main Procedure
0022 %
0023 item_list = obj.item_list;

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