Home > functions > gui > batch > batch_variable_table > vb_batch_variable_table_change_column_name.m

vb_batch_variable_table_change_column_name

PURPOSE ^

Rename variable name

SYNOPSIS ^

function [obj, errmsg] =vb_batch_variable_table_change_column_name(obj, old_name, new_name)

DESCRIPTION ^

 Rename variable name
 [USAGE]
    [obj, errmsg] = ...
      vb_batch_variable_table_change_column_name(<obj>,<old_name>,<new_name>);
 [IN]
         obj : vb_batch_variable_table object
    old_name : name before changing [STRING]
    new_name : name after changing  [STRING]
 [OUT]
         obj : vb_batch_variable_table object
      errmsg : error msg(when error occurs, reason is put here.)

 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, errmsg] = ...
0002              vb_batch_variable_table_change_column_name(obj, old_name, new_name)
0003 % Rename variable name
0004 % [USAGE]
0005 %    [obj, errmsg] = ...
0006 %      vb_batch_variable_table_change_column_name(<obj>,<old_name>,<new_name>);
0007 % [IN]
0008 %         obj : vb_batch_variable_table object
0009 %    old_name : name before changing [STRING]
0010 %    new_name : name after changing  [STRING]
0011 % [OUT]
0012 %         obj : vb_batch_variable_table object
0013 %      errmsg : error msg(when error occurs, reason is put here.)
0014 %
0015 % Copyright (C) 2011, ATR All Rights Reserved.
0016 % License : New BSD License(see VBMEG_LICENSE.txt)
0017 
0018 %
0019 % --- Previous check
0020 %
0021 if ~exist('obj', 'var')
0022     error('obj is a requierd parameter.');
0023 end
0024 if ~exist('old_name', 'var')
0025     error('old_name is a required parameter.');
0026 end
0027 if ~exist('new_name', 'var')
0028     error('new_name is a required parameter.');
0029 end
0030 
0031 %
0032 % --- Main Procedure
0033 %
0034 errmsg = '';
0035 
0036 % Duplication check
0037 ix_dup = strmatch(new_name, obj.column_name_list, 'exact');
0038 if ~isempty(ix_dup)
0039     errmsg = 'Specified variable name already exists.';
0040     return;
0041 end
0042 ix = strmatch(old_name, obj.column_name_list, 'exact');
0043 if isempty(ix)
0044     errmsg = 'The variable name before changing was not found.';
0045     return;
0046 else
0047     obj.column_name_list{ix} = new_name;
0048 end
0049 
0050 %
0051 % --- After check
0052 %
0053 if nargout < 1
0054     error('function caller should receive this object.');
0055 end

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