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

bm_manager_rename_model

PURPOSE ^

rename brain model

SYNOPSIS ^

function [obj] = bm_manager_rename_model(obj, index, new_name)

DESCRIPTION ^

 rename brain model
 [USAGE]
    [obj] = bm_manager_rename_model(<obj>, <index>, <new_name>);
 [IN]
         obj : bm_manager object
       index : bm_list index
    new_name : new model name

 [OUT]
    obj : bm_manager object

 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] = bm_manager_rename_model(obj, index, new_name)
0002 % rename brain model
0003 % [USAGE]
0004 %    [obj] = bm_manager_rename_model(<obj>, <index>, <new_name>);
0005 % [IN]
0006 %         obj : bm_manager object
0007 %       index : bm_list index
0008 %    new_name : new model name
0009 %
0010 % [OUT]
0011 %    obj : bm_manager object
0012 %
0013 % Copyright (C) 2011, ATR All Rights Reserved.
0014 % License : New BSD License(see VBMEG_LICENSE.txt)
0015 
0016 %
0017 % --- Previous check
0018 %
0019 if ~exist('obj', 'var'), error('obj is a required parameter.'); end
0020 if ~exist('index', 'var'), error('index is a required parameter.'); end
0021 if ~exist('new_name', 'var'), error('new_name is a required parameter.'); end
0022 
0023 %
0024 % --- Main Procedure
0025 %
0026 brain_data_cell = bm_list_get_brain_model(obj.bm_list, index);
0027 
0028 for k=1:length(brain_data_cell)
0029     brain_data = brain_data_cell{k};
0030     old_name = brain_data_get_model_name(brain_data);
0031 
0032     % Rename
0033     brain_data = brain_data_set_model_name(brain_data, new_name);
0034 
0035     % write rename history
0036     history_str = ['renamed from ' old_name ' to ' new_name];
0037     brain_data  = brain_data_add_history_item(brain_data, history_str);
0038     % regist
0039     obj.bm_list = bm_list_overwrite_model(obj.bm_list, ...
0040                                              brain_data, ...
0041                                              index(k));
0042 end
0043 
0044 %
0045 % --- After check
0046 %
0047 if nargout ~= 1
0048     error('function caller should receive obj.');
0049 end

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