xxsimCopyStatesToInitials

PURPOSE ^

xxsimCopyStatesToInitials - Copy current states to initial values.

SYNOPSIS ^

function [result] = xxsimCopyStatesToInitials()

DESCRIPTION ^

 xxsimCopyStatesToInitials - Copy current states to initial values.

 Syntax: 
   result = xxsimCopyStatesToInitials(action)

 Inputs:
    takes no arguments.

 Outputs:
   result = boolean indicating the success.
    
 Examples:
   result = xxsimCopyStatesToInitials()
   
      - copy all states to initial values.
 
 Author: Controllab Products B.V.
 email: info@controllab.nl
 Website: http://www.controllab.nl
 November 2015

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function [result] = xxsimCopyStatesToInitials()
0002 % xxsimCopyStatesToInitials - Copy current states to initial values.
0003 %
0004 % Syntax:
0005 %   result = xxsimCopyStatesToInitials(action)
0006 %
0007 % Inputs:
0008 %    takes no arguments.
0009 %
0010 % Outputs:
0011 %   result = boolean indicating the success.
0012 %
0013 % Examples:
0014 %   result = xxsimCopyStatesToInitials()
0015 %
0016 %      - copy all states to initial values.
0017 %
0018 % Author: Controllab Products B.V.
0019 % email: info@controllab.nl
0020 % Website: http://www.controllab.nl
0021 % November 2015
0022 
0023 %------------- BEGIN CODE --------------
0024 
0025     if(nargin>0)
0026         error('Too many input arguments: xxsimCopyStatesToInitials does not expect any input arguments.');
0027     end;
0028 
0029     % set the result variable
0030     result = xrlinvoke('xxsim.simulator.copyStatesToInitials');
0031 end
0032 %------------- END OF CODE --------------

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