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

vb_batch_mgr_remove_variable

PURPOSE ^

Remove variable from the table

SYNOPSIS ^

function [obj] = vb_batch_mgr_remove_varable(obj, variable_name)

DESCRIPTION ^

 Remove variable from the table

 [USAGE]
    [obj] = vb_batch_mgr_remove_varable(<obj, <variable_name>);
 [IN]
              obj : vb_batch_mgr object
    variable_name : variable name such as '$ID$', '$SUBJ$' [STRING]
 [OUT]
       obj : vb_batch_mgr 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] = vb_batch_mgr_remove_varable(obj, variable_name)
0002 % Remove variable from the table
0003 %
0004 % [USAGE]
0005 %    [obj] = vb_batch_mgr_remove_varable(<obj, <variable_name>);
0006 % [IN]
0007 %              obj : vb_batch_mgr object
0008 %    variable_name : variable name such as '$ID$', '$SUBJ$' [STRING]
0009 % [OUT]
0010 %       obj : vb_batch_mgr object
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')
0019     error('obj is a required parameter.');
0020 end
0021 if ~exist('variable_name', 'var')
0022     error('obj is a required parameter.');
0023 end
0024 if ~ischar(variable_name) || isempty(variable_name)
0025     error('variable name is invalid');
0026 end
0027 
0028 %
0029 % --- Main Procedure
0030 %
0031 
0032 % Add variable
0033 [obj.table] = ...
0034     vb_batch_variable_table_remove_column(obj.table, variable_name);
0035 
0036 %
0037 % --- After check
0038 %
0039 if nargout < 1
0040     error('function caller should receive obj.');
0041 end

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