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

vb_batch_parm_set_get_name

PURPOSE ^

Return the name of this parameter set.

SYNOPSIS ^

function [parm_set_name] = vb_batch_parm_set_get_name(obj)

DESCRIPTION ^

 Return the name of this parameter set.
 [USAGE]
    [parm_set_name] = vb_batch_parm_set_get_name(obj);
 [IN]
    obj : vb_batch_parm_set object.
 [OUT]
    parm_set_name : The name of this parameter set.

 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 [parm_set_name] = vb_batch_parm_set_get_name(obj)
0002 % Return the name of this parameter set.
0003 % [USAGE]
0004 %    [parm_set_name] = vb_batch_parm_set_get_name(obj);
0005 % [IN]
0006 %    obj : vb_batch_parm_set object.
0007 % [OUT]
0008 %    parm_set_name : The name of this parameter set.
0009 %
0010 % Copyright (C) 2011, ATR All Rights Reserved.
0011 % License : New BSD License(see VBMEG_LICENSE.txt)
0012 
0013 %
0014 % --- Previous check
0015 %
0016 if ~exist('obj', 'var')
0017     error('obj is a required parameter.');
0018 end
0019 
0020 %
0021 % --- Main Procedure
0022 %
0023 parm_set_name = obj.set_name;

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