xxsimGetPlotWindows

PURPOSE ^

xxsimGetPlotWindows - Get all currently available plot windows that are present in the simulator by both name and ID.

SYNOPSIS ^

function retval = xxsimGetPlotWindows()

DESCRIPTION ^

 xxsimGetPlotWindows - Get all currently available plot windows that are present in the simulator by both name and ID. 

 Syntax: 
   retval = xxsimGetPlotWindows()

 Inputs:
    takes no arguments.
 
 Outputs: 
   retval = returns a structure array in which each element has a structure with a windowName and corresponding windowID member.
 
 Examples:
   retval = xxsimGetPlotWindows()
   
     - retval now contains the list of window names and window IDs .
     - the output is returned in a structure array form. 
       e.g
         retval.windowName   : returns the name of the plot window.
         retval.windowID     : returns the ID of the plot window.
         retval.isHidden     : 0 = visible, 1 = plot is hidden.
     - Note: The simulator should be open before calling this function.  

 See also: xxsimOpenSimulator

 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 = xxsimGetPlotWindows()
0002 % xxsimGetPlotWindows - Get all currently available plot windows that are present in the simulator by both name and ID.
0003 %
0004 % Syntax:
0005 %   retval = xxsimGetPlotWindows()
0006 %
0007 % Inputs:
0008 %    takes no arguments.
0009 %
0010 % Outputs:
0011 %   retval = returns a structure array in which each element has a structure with a windowName and corresponding windowID member.
0012 %
0013 % Examples:
0014 %   retval = xxsimGetPlotWindows()
0015 %
0016 %     - retval now contains the list of window names and window IDs .
0017 %     - the output is returned in a structure array form.
0018 %       e.g
0019 %         retval.windowName   : returns the name of the plot window.
0020 %         retval.windowID     : returns the ID of the plot window.
0021 %         retval.isHidden     : 0 = visible, 1 = plot is hidden.
0022 %     - Note: The simulator should be open before calling this function.
0023 %
0024 % See also: xxsimOpenSimulator
0025 %
0026 % Author: Controllab Products B.V.
0027 % email: info@controllab.nl
0028 % Website: http://www.controllab.nl
0029 % November 2015
0030 
0031 %------------- BEGIN CODE --------------
0032     if(nargin>0)
0033         error('Too many input arguments: xxsimGetPlotWindows does not expect any input arguments.');
0034     end;
0035 
0036   % Make the call to 20-sim
0037     retval = xrlinvoke('xxsim.plot.getPlotWindows');
0038 end

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