Functionality to Convert Subsystem to Simulink Function #1

stephen99scott · 2020-06-18T03:51:29Z

Three main edits:

Added isSubsystem.m
- Checks if a block is a subsystem
- Used in determining whether to display 'Convert Subsystem' in the Simulink context menu
Added subToSimFcn.m
- Converts subsystem to Sim-fcn by adding a trigger port and swapping ports for arguments
Edited sl_customization.m
- Added function callbacks for subToSimFcn

monikajaskolka

sl_customization.m

Line 40:
- Use a dialog box to get user input: https://www.mathworks.com/help/matlab/ref/inputdlg.html
- Change "Simulink-function" to "Simulink Function" to be consistent with other menus.
Line 33, 47: Capitalize "To" to be consistent with the other menus.
Check that a new Simulink Function with the user's input is allowed to be added to the model without causing simulations errors, e.g., if a function of that name already exists in scope. Use getCallableFunctions.m to get a list of all Simulink Functions in scope at the model level where the new function is to be added, and if the new function has the same name (including qualifier) as another that is in scope (regardless of parameter list), then it cannot be added.

isSubsystem.m

Even though this function is used in the specific sense of converting a subsystem, it should be made more general, so we can reuse it in the future. In particular on Line 11, don't assume that the input will be a cell array with a pathname. When dealing with inputs that can represent a block or other model elements, you should allow the function to accept it as a pathname or handle. So, the input can be a char array, a numeric block handle, a cell array of names, or a vector of handles. The function fails for these cases:

isSubsystem({}), isSubsystem('') Empty input
isSubsystem(gcb) Char array name
isSubsystem(gcbh) Numeric handle
isSubsystem({gcb, gcb}), isSubsystem([gcbh, gcbh]) Multiple elements. This should return [1, 1]. Note: The function get_param already works on multiple elements.

Other

Please make the code formatting consistent. In particular, add spaces around assignment (=), and one space after commas. You can try using MBeautifier to automatically do it, but I haven't used it myself. Unfortunately MathWorks doesn't provide code beautification other than automatic code indentation.

…nctions in scope

src/isGoodSimFcnName.m

…e into subsys-to-simfunc

monikajaskolka · 2020-06-22T20:25:54Z

I noticed that when the inports and outports of a subsystem have invalid variable names (e.g. they contain spaces) the resulting argin and argout names are a "arg1", "arg2", etc. for both the argin and argout. If we are giving them generic names automatically, they should be "ArgIn1" , "ArgIn2", etc. for inports and "ArgOut1", "ArgOut2", etc. for outports. But that leads me to point Converting Subsystem to Simulink Function from inside existing Simulink Function #2...

Before:

After:

Can you use the genvarname command to take the existing block names and use them as the argument names? Could this also be done to use the subsystem name as the function name?

monikajaskolka · 2020-06-23T00:44:47Z

src/subToSimFcn.m

+    %% Add Trigger to Subsystem
+
+    % Disable subsystem link
+    set_param(subsystem, 'LinkStatus', 'inactive');


Can you check if the LinkStatus is okay to leave as 'inactive', or do we want to break it entirely by setting it to 'none'? See this for more info: https://www.mathworks.com/help/simulink/ug/control-linked-block-status-programmatically.html

monikajaskolka · 2020-06-23T00:51:35Z

src/subToSimFcn.m

+    set_param(subsystem, 'LinkStatus', 'inactive');
+
+    % Adding the trigger block to the subsystem and calibrating its parameters
+    TriggerPath = append(subsystem, '/', simulinkFcnName);


Variable names should start with lowercase.

monikajaskolka · 2020-06-23T00:55:18Z

src/subToSimFcn.m

+        try
+            assert(not(strcmp(parameters{port, 4}, 'Inherit: auto')));
+        catch
+            disp(['Invalid data type of port', newline, ports{port}, newline,...


Can this be printed on one line? Please also add single quotes around 'Inherit' and 'double'. To print a single quite you escape it with another single quote.

monikajaskolka · 2020-06-23T00:55:37Z

src/subToSimFcn.m

+        try
+            assert(not(strcmp(parameters{port, 6}, '-1')))
+        catch
+            disp(['Invalid port dimensions of port:', newline, ports{port},...


Print on one line please.

monikajaskolka · 2020-06-23T00:56:07Z

src/sl_customization.m

+    subToSimFcn(subsystem{1}, simulinkFcnName, 'scoped');
+end
+
+function schema=toGlobalSimFcn(callbackInfo)


Spaces around = please.

monikajaskolka · 2020-06-23T00:56:22Z

src/sl_customization.m

+    schema.ChildrenFcns = {@toScopedSimFcn, @toGlobalSimFcn};
+end
+
+function schema=toScopedSimFcn(callbackInfo)


Spaces around = please.

monikajaskolka · 2020-06-23T00:56:45Z

src/isSubsystem.m

+    % Check each block to see if its a subsystem
+    for block = 1:length(blocks)
+        try
+            b(block) = strcmpi(get_param(blocks(block),'BlockType'),'SubSystem');


Spaces around commas please.

monikajaskolka · 2020-06-23T01:02:17Z

src/isGoodSimFcnName.m

@@ -0,0 +1,37 @@
+function goodName = isGoodSimFcnName(subsystem, simulinkFcnName)
+% isGoodSimFcnName          Checks to see if a Simulink-fcn name clashes with


Please be precise and consistent with language in the comments. Please write out 'Simulink Function' instead of 'Simulink-fcn' or 'Simulink-function'. For actual parameter/variable/function names it's okay to shorten it, but be aware that the Simulink language has another block called 'Fcn'.

stephen99scott added 6 commits June 17, 2020 16:28

Added script to convert a subsystem into a Simulink-function

19e8260

Added getPortParameters function, and improved structure

7e4ad3a

Added comment header for getPortParameters function

43aef65

Renamed and added setArgumentParameters function

ab05454

Added function to check if a block is a subsystem

796bb26

Added callbacks for subToSimFcn

7438cf4

stephen99scott requested a review from monikajaskolka June 18, 2020 03:51

monikajaskolka requested changes Jun 18, 2020

View reviewed changes

stephen99scott added 5 commits June 18, 2020 14:03

Added script to check whether a function name is the same as other fu…

ab85109

…nctions in scope

Added script which prompts user for fcn name until good name is picked

7818e8a

Added functionality to accept different input types

54c36b7

Code formatting

b1212ee

Added user prompt functionality

d0d633a

stephen99scott requested a review from monikajaskolka June 18, 2020 18:07

Fixed function definition formatting

9979bfb

monikajaskolka reviewed Jun 19, 2020

View reviewed changes

src/isGoodSimFcnName.m Outdated Show resolved Hide resolved

stephen99scott added 2 commits June 18, 2020 21:38

Incorporated getPrototypeName.m funcitonality

7a1e91c

Merge branch 'subsys-to-simfunc' of github.com:McSCert/Simulink-Modul…

377e7cf

…e into subsys-to-simfunc

stephen99scott requested a review from monikajaskolka June 22, 2020 17:13

Added genvarname for ArgIn/Out invalid variable name handling

1005d2b

monikajaskolka reviewed Jun 23, 2020

View reviewed changes

stephen99scott and others added 4 commits June 23, 2020 11:57

Updated comments to say Simulink Function

8b7df61

Fixed formatting/spacing

713d4dd

Changed error message to display on one line, and formatting

3cb3741

Removed newline from port dimensions catch

621c4af

monikajaskolka merged commit e59dbd0 into master Jun 24, 2020

monikajaskolka deleted the subsys-to-simfunc branch June 24, 2020 20:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Functionality to Convert Subsystem to Simulink Function #1

Functionality to Convert Subsystem to Simulink Function #1

stephen99scott commented Jun 18, 2020

Uh oh!

monikajaskolka left a comment

Uh oh!

Uh oh!

monikajaskolka commented Jun 22, 2020

Uh oh!

monikajaskolka Jun 23, 2020

Uh oh!

monikajaskolka Jun 23, 2020

Uh oh!

monikajaskolka Jun 23, 2020

Uh oh!

monikajaskolka Jun 23, 2020

Uh oh!

monikajaskolka Jun 23, 2020

Uh oh!

monikajaskolka Jun 23, 2020

Uh oh!

monikajaskolka Jun 23, 2020

Uh oh!

monikajaskolka Jun 23, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -0,0 +1,37 @@
		function goodName = isGoodSimFcnName(subsystem, simulinkFcnName)
		% isGoodSimFcnName Checks to see if a Simulink-fcn name clashes with

Functionality to Convert Subsystem to Simulink Function #1

Functionality to Convert Subsystem to Simulink Function #1

Conversation

stephen99scott commented Jun 18, 2020

Uh oh!

monikajaskolka left a comment

Choose a reason for hiding this comment

sl_customization.m

isSubsystem.m

Other

Uh oh!

Uh oh!

monikajaskolka commented Jun 22, 2020

Before:

After:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants