xxsimSetScriptMode

PURPOSE ^

xxsimSetScriptMode - sets or unsets 20-sim in scripting mode.

SYNOPSIS ^

function retval = xxsimSetScriptMode(varargin)

DESCRIPTION ^

 xxsimSetScriptMode - sets or unsets 20-sim in scripting mode.
 Script mode deactivates all buttons in the simulation window except the stop simulation button.

 Syntax: 
    retval = xxsimSetScriptMode(varargin)

 Inputs:
   varargin = boolean argument (optional). If true, sets 20-sim in scripting mode (default),
              if false, unsets 20-sim from scripting mode.

 Outputs:
   result = boolean indicating the success.

 Examples:
   
   xxsimSetScriptMode(true) or xxsimSetScriptMode
       sets 20-sim in scripting mode
   xxsimSetScriptMode(false)  
       reverts 20-sim back from scripting mode
 
 Author: Controllab Products B.V.
 email: info@controllab.nl
 Website: http://www.controllab.nl
 September 2013

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function retval = xxsimSetScriptMode(varargin)
0002 % xxsimSetScriptMode - sets or unsets 20-sim in scripting mode.
0003 % Script mode deactivates all buttons in the simulation window except the stop simulation button.
0004 %
0005 % Syntax:
0006 %    retval = xxsimSetScriptMode(varargin)
0007 %
0008 % Inputs:
0009 %   varargin = boolean argument (optional). If true, sets 20-sim in scripting mode (default),
0010 %              if false, unsets 20-sim from scripting mode.
0011 %
0012 % Outputs:
0013 %   result = boolean indicating the success.
0014 %
0015 % Examples:
0016 %
0017 %   xxsimSetScriptMode(true) or xxsimSetScriptMode
0018 %       sets 20-sim in scripting mode
0019 %   xxsimSetScriptMode(false)
0020 %       reverts 20-sim back from scripting mode
0021 %
0022 % Author: Controllab Products B.V.
0023 % email: info@controllab.nl
0024 % Website: http://www.controllab.nl
0025 % September 2013
0026 
0027 %------------- BEGIN CODE --------------
0028 % call the interface function
0029 
0030     %check input arguments
0031     if length(varargin)> 1
0032         error('Too many input arguments.');
0033     end
0034     
0035     % if no argument is given set to true
0036     if length(varargin) < 1
0037         set = true;
0038     end
0039     
0040     %check if the input is a boolean
0041     if length(varargin) == 1
0042         if islogical(varargin{1})
0043             set = varargin{1};
0044         else
0045            error('argument should be a boolean');  
0046         end
0047     end
0048 
0049     retval = xrlinvoke('xxsim.setScriptMode', struct('set', set ));
0050     if ( retval == false )
0051         if set 
0052             error('could not set 20-sim in scripting mode');
0053         else
0054             error('could not unset 20-sim in scripting mode');
0055         end
0056     end
0057 end

Generated on Sun 10-Dec-2017 19:24:51