xxsimHidePlotWindow

PURPOSE ^

xxsimHidePlotWindow - Set the hidden state of the specified plot window to isHidden.

SYNOPSIS ^

function retval = xxsimHidePlotWindow(window,isHidden)

DESCRIPTION ^

 xxsimHidePlotWindow - Set the hidden state of the specified plot window to isHidden.

 Syntax: 
   retval = xxsimHidePlotWindow(window,isHidden)

 Inputs:
   window   = The ID or name of the plot window of which the isHidden state should be changed.
   isHidden = Boolean that indicates if the plot window should be hidden (1) or shown (0).
 
 Outputs: 
   retval = returns true if the new hidden status of the plot window is properly set, false otherwise.  

 See also: xxsimAddPlotWindow, xxsimRemovePlotWindow, xxsimOpenSimulator, xxsimGetPlotWindows

 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 = xxsimHidePlotWindow(window,isHidden)
0002 % xxsimHidePlotWindow - Set the hidden state of the specified plot window to isHidden.
0003 %
0004 % Syntax:
0005 %   retval = xxsimHidePlotWindow(window,isHidden)
0006 %
0007 % Inputs:
0008 %   window   = The ID or name of the plot window of which the isHidden state should be changed.
0009 %   isHidden = Boolean that indicates if the plot window should be hidden (1) or shown (0).
0010 %
0011 % Outputs:
0012 %   retval = returns true if the new hidden status of the plot window is properly set, false otherwise.
0013 %
0014 % See also: xxsimAddPlotWindow, xxsimRemovePlotWindow, xxsimOpenSimulator, xxsimGetPlotWindows
0015 %
0016 % Author: Controllab Products B.V.
0017 % email: info@controllab.nl
0018 % Website: http://www.controllab.nl
0019 % November 2015
0020 
0021 %------------- BEGIN CODE --------------
0022 
0023     % Check the obtained amount of input arguments.
0024     if(nargin>2)
0025         error('Too many input arguments were specified.');
0026     elseif(nargin<2)
0027         error('Too little input arguments were specified.');
0028     end
0029 
0030     % Check if the window is an ID or name.
0031     if(~ischar(window) && ~isnumeric(window))
0032         error('Window is not a valid ID (number) or name (string).');
0033     end
0034     
0035     % Check if the isHidden input argument is a boolean.
0036     if(~islogical(isHidden))
0037         error('isHidden is not a boolean.');
0038     end
0039 
0040     % Get the ID from the name, if the input argument was not already an ID.
0041     windowID = xxsimGetPlotWindowIDFromName(window);
0042     
0043     % Make the call to 20-sim
0044     retval = xrlinvoke('xxsim.plot.hidePlotWindow',struct('windowID',int32(windowID),'isHidden',isHidden));
0045 end
0046 %------------- END OF CODE --------------

Generated on Thu 25-Apr-2024 10:30:24