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

vb_batch_mgr_set_name

PURPOSE ^

Change name of batch manager.

SYNOPSIS ^

function [obj] = vb_batch_mgr_set_name(obj, name)

DESCRIPTION ^

 Change name of batch manager.
 [USAGE]
    [obj] = vb_batch_mgr_set_name(<obj>, <name>);
 [IN]
     obj : vb_batch_mgr object
    name : batch manager name
 [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_set_name(obj, name)
0002 % Change name of batch manager.
0003 % [USAGE]
0004 %    [obj] = vb_batch_mgr_set_name(<obj>, <name>);
0005 % [IN]
0006 %     obj : vb_batch_mgr object
0007 %    name : batch manager name
0008 % [OUT]
0009 %    obj : vb_batch_mgr object
0010 %
0011 % Copyright (C) 2011, ATR All Rights Reserved.
0012 % License : New BSD License(see VBMEG_LICENSE.txt)
0013 
0014 %
0015 % --- Previous check
0016 %
0017 if ~exist('obj', 'var')
0018     error('obj is a required parameter.');
0019 end
0020 if ~exist('name', 'var')
0021     error('name is a required parameter.');
0022 end
0023 
0024 %
0025 % --- Main Procedure
0026 %
0027 obj.name = name;
0028 
0029 %
0030 % --- After check
0031 %
0032 if nargout < 1
0033     error('function caller should receive vb_batch_mgr object.');
0034 end
0035

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