Home > functions > tool_box > mri_toolbox > mri_point_select_dir > display_factor > vb_display_factor_add_element.m

vb_display_factor_add_element

PURPOSE ^

Add display_element object to display_factor object.

SYNOPSIS ^

function [obj] = vb_display_factor_add_element(obj, display_element)

DESCRIPTION ^

 Add display_element object to display_factor object.
 [USAGE]
    [obj] = vb_display_factor_add_element(<obj>, <display_element>);
 [IN]
                obj : display_factor object
    display_element : display_element object
 [OUT]
    obj : display_factor object

 Author: rhayashi
 Created: 2007-07-18

 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_display_factor_add_element(obj, display_element)
0002 % Add display_element object to display_factor object.
0003 % [USAGE]
0004 %    [obj] = vb_display_factor_add_element(<obj>, <display_element>);
0005 % [IN]
0006 %                obj : display_factor object
0007 %    display_element : display_element object
0008 % [OUT]
0009 %    obj : display_factor object
0010 %
0011 % Author: rhayashi
0012 % Created: 2007-07-18
0013 %
0014 % Copyright (C) 2011, ATR All Rights Reserved.
0015 % License : New BSD License(see VBMEG_LICENSE.txt)
0016 
0017 %
0018 % --- Previous check
0019 %
0020 if ~exist('obj', 'var'), error('obj is a required parameter.'); end
0021 if ~exist('display_element', 'var')
0022     error('display_element is a required parameter.');
0023 end
0024 
0025 %
0026 % --- Main Procedure
0027 %
0028 obj.element_cell{length(obj.element_cell)+1} = display_element;
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