xxsimGetPorts

PURPOSE ^

xxsimGetPorts - Get all ports for a submodel.

SYNOPSIS ^

function retval = xxsimGetPorts(submodelName)

DESCRIPTION ^

 xxsimGetPorts - Get all ports for a submodel.

 Syntax: 
   retval = xxsimGetPorts(submodelName)

 Inputs:
   submodelName = Name of the submodel to obtain the port definitions from.
 
 Outputs: 
   retval = To do: add
 
 Examples:
   retval = xxsimGetPorts('PID')
   
     - returns the structure array with all the ports for the
       submodel "PID".

 Author: Controllab Products B.V.
 Email: info@controllab.nl
 Website: https://www.20sim.com
 March 2019

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function retval = xxsimGetPorts(submodelName)
0002 % xxsimGetPorts - Get all ports for a submodel.
0003 %
0004 % Syntax:
0005 %   retval = xxsimGetPorts(submodelName)
0006 %
0007 % Inputs:
0008 %   submodelName = Name of the submodel to obtain the port definitions from.
0009 %
0010 % Outputs:
0011 %   retval = To do: add
0012 %
0013 % Examples:
0014 %   retval = xxsimGetPorts('PID')
0015 %
0016 %     - returns the structure array with all the ports for the
0017 %       submodel "PID".
0018 %
0019 % Author: Controllab Products B.V.
0020 % Email: info@controllab.nl
0021 % Website: https://www.20sim.com
0022 % March 2019
0023 
0024 %------------- BEGIN CODE --------------
0025 
0026   % Check if the submodelName is a string.
0027   if(~ischar(submodelName))
0028     error('Please specify a valid submodel name.');
0029   end;
0030 
0031   retval = xrlinvoke('xxsim.model.getPorts', struct('submodelName',submodelName));
0032 end

Generated on Tue 19-Oct-2021 21:32:08