xxsimSetLogVariables

PURPOSE ^

xxsimSetLogVariables - logs specified variables while running active model.

SYNOPSIS ^

function [retval] = xxsimSetLogVariables(logVariables)

DESCRIPTION ^

 xxsimSetLogVariables - logs specified variables while running active model.

 Syntax: 
   retval = xxsimSetLogVariables(logVariables)

 Inputs:
   logVariables = list of variables e.g {'time', 'LogVarTest.v1'}
                  Note: make sure the variable name exists in the active model.
                        An error message will be returned when one or more variables could not be found.
 
 Outputs: 
   retval = returns true if arguments are valid.

 Examples:
    retval = xxsimSetLogVariables({'time','LogVarTest.v1'});

 See also: xxsimWriteLogToCsv

 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 [retval] = xxsimSetLogVariables(logVariables)
0002 % xxsimSetLogVariables - logs specified variables while running active model.
0003 %
0004 % Syntax:
0005 %   retval = xxsimSetLogVariables(logVariables)
0006 %
0007 % Inputs:
0008 %   logVariables = list of variables e.g {'time', 'LogVarTest.v1'}
0009 %                  Note: make sure the variable name exists in the active model.
0010 %                        An error message will be returned when one or more variables could not be found.
0011 %
0012 % Outputs:
0013 %   retval = returns true if arguments are valid.
0014 %
0015 % Examples:
0016 %    retval = xxsimSetLogVariables({'time','LogVarTest.v1'});
0017 %
0018 % See also: xxsimWriteLogToCsv
0019 %
0020 % Author: Controllab Products B.V.
0021 % email: info@controllab.nl
0022 % Website: http://www.controllab.nl
0023 % November 2015
0024 
0025 %------------- BEGIN CODE --------------
0026     retval = false;
0027     
0028     retval = xrlinvoke('xxsim.simulator.setLogVariables', struct('variables', {{ logVariables, 'array' }} )  );
0029 end
0030 %------------- END OF CODE --------------

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