Home > functions > gui > batch > batch_parm_set > vb_batch_parm_set_new.m

vb_batch_parm_set_new

PURPOSE ^

This is a constructor of vb_batch_parm_set class.

SYNOPSIS ^

function [obj] = vb_batch_parm_set_new(set_name)

DESCRIPTION ^

 This is a constructor of vb_batch_parm_set class.
 This class is a container of batch parameters.
 
 [USAGE]
    vb_batch_parm_set_new(set_name);
 [IN]
    set_name : container name
 [OUT]
    obj : vb_batch_parm_set 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_parm_set_new(set_name)
0002 % This is a constructor of vb_batch_parm_set class.
0003 % This class is a container of batch parameters.
0004 %
0005 % [USAGE]
0006 %    vb_batch_parm_set_new(set_name);
0007 % [IN]
0008 %    set_name : container name
0009 % [OUT]
0010 %    obj : vb_batch_parm_set 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('set_name', 'var')
0019     set_name = '';
0020 end
0021 
0022 %
0023 % --- Main Procedure
0024 %
0025 obj = struct;
0026 obj.set_name = set_name;
0027 
0028 obj.list = [];  % this varable will be set by batch_parm_set_add function.
0029 
0030 %
0031 % --- After check
0032 %
0033 if nargout < 1
0034     error('function caller should receive obj.');
0035 end

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