Home > vbmeg > functions > gui > bm_editor > state > state_get_state.m

state_get_state

PURPOSE ^

get state and description

SYNOPSIS ^

function [state, description] = state_get_state(obj)

DESCRIPTION ^

 get state and description
 [USAGE]
    [state, description] = state_get_state(<obj>);
 [IN]
    obj : state object
 [OUT]
          state : state
    description : <<string>>state explanation

 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 [state, description] = state_get_state(obj)
0002 % get state and description
0003 % [USAGE]
0004 %    [state, description] = state_get_state(<obj>);
0005 % [IN]
0006 %    obj : state object
0007 % [OUT]
0008 %          state : state
0009 %    description : <<string>>state explanation
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'), error('obj is a required parameter.'); end
0018 
0019 %
0020 % --- Main Procedure
0021 %
0022 state = obj.state;
0023 description = obj.description;

Generated on Mon 22-May-2023 06:53:56 by m2html © 2005