Home > functions > gui > batch > batch_mgr > vb_batch_mgr_change_variable_name.m

vb_batch_mgr_change_variable_name

PURPOSE ^

Rename variable name

SYNOPSIS ^

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

DESCRIPTION ^

 Rename variable name
 [USAGE]
    [obj, errmsg] = ...
            vb_batch_mgr_change_variable_name(<obj>,<old_name>,<new_name>);
 [IN]
         obj : vb_batch_mgr_object
    old_name : name before changing [STRING]
    new_name : name after changing  [STRING]
 [OUT]
         obj : vb_batch_mgr_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_mgr_change_variable_name(obj, old_name, new_name)
0003 % Rename variable name
0004 % [USAGE]
0005 %    [obj, errmsg] = ...
0006 %            vb_batch_mgr_change_variable_name(<obj>,<old_name>,<new_name>);
0007 % [IN]
0008 %         obj : vb_batch_mgr_object
0009 %    old_name : name before changing [STRING]
0010 %    new_name : name after changing  [STRING]
0011 % [OUT]
0012 %         obj : vb_batch_mgr_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 [obj.table, errmsg] = ...
0035    vb_batch_variable_table_change_column_name(obj.table, old_name, new_name);
0036 
0037 %
0038 % --- After check
0039 %
0040 if nargout < 1
0041     error('function caller should receive this object.');
0042 end

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