xxsimGetModels

PURPOSE ^

xxsimGetModels - returns the list of opened 20-sim models.

SYNOPSIS ^

function [models] = xxsimGetModels()

DESCRIPTION ^

 xxsimGetModels - returns the list of opened 20-sim models.

 Syntax: 
    [models] = xxsimGetModels()

 Inputs:
   takes no arguments

 Outputs:
   models = is a structure with two fields namely, identifier and name .

      models.identifier = returns the identifier assigned to the model.
      models.name = returns the name of the model. 
                   Note: an empty string is returned if 20-sim editor has no saved model.

 Examples:
   open a new 20-sim editor.
   [models] = xxsimGetModels()
  
      models.identifier = 1  (the number depends on what has been opened beforehand).
      models.name       = '' (no name is assigned for an empty 20-sim editor).
 
 See also: xxsimOpenModel, xxsimCloseModel

 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 [models] = xxsimGetModels()
0002 % xxsimGetModels - returns the list of opened 20-sim models.
0003 %
0004 % Syntax:
0005 %    [models] = xxsimGetModels()
0006 %
0007 % Inputs:
0008 %   takes no arguments
0009 %
0010 % Outputs:
0011 %   models = is a structure with two fields namely, identifier and name .
0012 %
0013 %      models.identifier = returns the identifier assigned to the model.
0014 %      models.name = returns the name of the model.
0015 %                   Note: an empty string is returned if 20-sim editor has no saved model.
0016 %
0017 % Examples:
0018 %   open a new 20-sim editor.
0019 %   [models] = xxsimGetModels()
0020 %
0021 %      models.identifier = 1  (the number depends on what has been opened beforehand).
0022 %      models.name       = '' (no name is assigned for an empty 20-sim editor).
0023 %
0024 % See also: xxsimOpenModel, xxsimCloseModel
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 
0033     if(nargin>0)
0034         error('Too many input arguments: xxsimGetModels does not expect any input arguments.');
0035     end;
0036 
0037 % call the interface function
0038     models = xrlinvoke('xxsim.getModels');
0039 
0040 end
0041 %------------- END OF CODE --------------

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