BDD & STM: UsageScenario

Gallery
Tutorial
TRAIL: SysPhS-1.1 Annex A examples in MagicDraw/Cameo SysML vs Modelica (Wolfram SystemsModeler)
Section
Annex A.5: Humidifier (with Units)
Topic level
INTERMEDIATE
UML keywords
StateMachine
SysML keywords
Block
Real
Integer
SysPhS Keywords
IntegerSignalInElement
Modelica keywords
Integer
Real
Keywords
Slide kind
hybrid diagram
SysML Block Definition Diagram (BDD)
SysML StateMachine Diagram
This diagram shows the Block UsageScenario with a supporting StateMachine UsageScenarioSM:
Click on the image to view it full size

Basically, the UsageScenario controls the ControlSM, which in turn controls the heater via the HeaterControlSM and the fan of the VaporGenerationPlant (the physical manifestation of which has the actual fan and heater, not explicitly shown in the model).

The UsageScenario waits a bit before starting the entire system up then after a while shutting it all down (after which the safety fan may continue to run cooling the water down for a while until it reaches a safe temperature).

Apart from more consistent naming, there are a few subtle differences between the StateMachines shown in this trail version and those shown the spec or the MagicDraw/Cameo sample version.

In order to get the system to run properly a workaround is needed, the Port oSwitch has to by typed by a conjugated IntegerSignalInElement so that its signal iSig is an Integer. This is in fact necessary for ControlSM, the downstream consumer of the iSig value:

Modelica does not support comparison of Real values using == outside of functions (so not directly inside state machines)
This nice tool feature has been used:
MagicDraw/Cameo: Display options: On an 'entry', 'doActivity', or 'exit' Behavior of a State you may choose to display the specification code of an OpaqueBehavior or just its name.

In the image, the names of the Behaviors have also been shown using "callouts" into Notes.

Beware this!

GOTCHA: MagicDraw SysML/Cameo 19SP3: Export to Modelica: 'entry', 'doActivity', or 'exit' Behaviors of a State must be directly owned (not just "wrapped") or they won't be seen on export!
In this case, you may wish to leverage this tool behavior:
MagicDraw SysML/Cameo 19SP3: GOTCHA: If you drag a Behavior from the model browser onto the 'entry', 'doActivity', or 'exit' field in a specification dialog of a State it WILL BECOME OWNED by the State (which "steals ownership")!
And (in this case) avoid this:
MagicDraw/Cameo: If you drag a Behavior from the model browser onto the SYMBOL of a State (that does not already own the Behavior) and set it as an 'entry', 'doActivity', or 'exit' Behavior a "wrapper" Behavior owned by the State will be created.
Up next
BDD & STM: Control
Notes
[MODELLING, NAVIGATION, PATTERN, TIP, TOOL]{STRONG} Webel: UML/SysML: Navigation: ALWAYS offer a way out of a diagram (usually up a hierarchy, but possibly across) using a navigable symbol (linked to a diagram) and/or a diagram symbol. Avoid "cul-de-sacs"! [But beware of shared package cross-dependencies]
[CAPABILITY, FEATURE, TOOL] MagicDraw/Cameo: Supports embedding of one or more Diagrams in another via the Diagram Overview feature. Awesome!
[CONVENTION, DISPLAY, MODELLING, STYLE, TIP]{STRONG} Webel: SysMLv1: Highly recommend creating a "focus" Block Definition Diagram (BDD) for each main Block with expanded feature details and relationships to at least nearest neighbours
[NAMING, TIP]{OPTION} Optionally suffix the "focus" BDD for a Block with '.bdd' so that it won't clash with a corresponding IBD on diagram export. This is not a SysMLv1 concern, it is purely a workflow concern. It has the slight disadvantage that BDD may "indicated" twice.
[DISPLAY, STYLE, TIP, TOOL]{SUGGESTED} Style: use line width 2 or 3 on the border of the "focus" element in "focus" diagrams (such as the main Block or Class of a dedicated Block Definition Diagram or Class Diagram)
[CONVENTION, MODELLING, NAMING, TIP]{STRONG} Webel: If you must name your Ports or Pins, name them simply 'i', 'o', or 'io' (or 'oi') to indicate direction UNLESS you have to indicate a special role like 'iRole', 'oAuxiliary'. DO NOT use Port or Pin names like 'input', 'output', etc.
[GOTCHA] Modelica does not support comparison of Real values using == outside of functions (so not directly inside state machines)
[DISPLAY, MODELLING, TIP, TOOL]{INFORMATIVE} MagicDraw/Cameo: Display options: On an 'entry', 'doActivity', or 'exit' Behavior of a State you may choose to display the specification code of an OpaqueBehavior or just its name.
[ISSUE, MODELLING, TIP, WARNING] GOTCHA: MagicDraw SysML/Cameo 19SP3: Export to Modelica: 'entry', 'doActivity', or 'exit' Behaviors of a State must be directly owned (not just "wrapped") or they won't be seen on export!
[GOTCHA, MODELLING, TIP, WARNING] MagicDraw SysML/Cameo 19SP3: GOTCHA: If you drag a Behavior from the model browser onto the 'entry', 'doActivity', or 'exit' field in a specification dialog of a State it WILL BECOME OWNED by the State (which "steals ownership")!
[GOTCHA, MODELLING, TIP, WARNING] MagicDraw/Cameo: If you drag a Behavior from the model browser onto the SYMBOL of a State (that does not already own the Behavior) and set it as an 'entry', 'doActivity', or 'exit' Behavior a "wrapper" Behavior owned by the State will be created.
Snippets (quotes/extracts)
Visit also
Visit also (backlinks)
Related slides (includes other tutorials)
Figure 27: Default values and initial value in SysML
Related slides (backlinks, includes other tutorials)