Harmony MBSE Modeling Guidelines Rev 2.0 Harmony MBSE Modeling Standards for use with UML, SysML, and Rhapsody Prepared by Dr. Bruce Powel Douglass, Ph.D. Chief Evangelist IBM Rational Page 1 of 51 © IBM 2015 Bruce Powel Douglass, Ph.D. Harmony MBSE Modeling Guidelines Rev 2.0 Page 1 of 51 © Telelogic, 2006 Bruce Powel Douglass, Ph.D. Harmony MBSE Modeling Guidelines Rev 2.0 Table of Contents 1.0 SCOPE .................................................................................................................................4 2.0 REFERENCED DOCUMENTS..............................................................................................4 3.0 MODELING STANDARDS....................................................................................................4 3.1 Naming Conventions ........................................................................................................................... 4 3.2 Modeling Guidelines ............................................................................................................................ 8 3.3 Model Reviews .................................................................................................................................. 13 3.4 General Diagram Guidelines ............................................................................................................. 14 3.5 Use Case Diagram Guidelines .......................................................................................................... 17 3.6 Class Diagram Guidelines ................................................................................................................. 25 3.7 Sequence Diagram Guidelines.......................................................................................................... 33 3.8 State Diagram Guidelines.................................................................................................................. 36 3.9 Activity Diagram Guidelines............................................................................................................... 45 3.10 Deployment Diagram Guidelines....................................................... Error! Bookmark not defined. 3.11 UML Extension Guidelines ................................................................ Error! Bookmark not defined. APPENDIX A – RHAPSODY ACTION LANGUAGE.................................................................46 BASIC SYNTAX .......................................................................................................................46 ASSIGNMENT AND ARITHMETIC OPERATORS....................................................................47 PRINTING.................................................................................................................................47 COMPARISON OPERATORS ..................................................................................................47 CONDITIONAL STATEMENTS ................................................................................................48 INCREMENTAL LOOPING STATEMENTS..............................................................................48 CONDITIONAL LOOPING STATEMENTS ...............................................................................48 INVOKING OPERATIONS........................................................................................................49 GENERATING EVENTS ...........................................................................................................49 REFERRING TO EVENT PARAMETERS IN TRANSITIONS ...................................................49 TESTING THE PORT ON WHICH AN EVENT ARRIVES.........................................................49 TESTING THE STATE OF A STATE MACHINE.......................................................................50 Page 2 of 51 Bruce Powel Douglass, Ph.D. Harmony MBSE Modeling Guidelines Rev 2.0 Figures Figure 1: Naming Blocks and Features......................................................................................................... 5 Figure 2: Naming on an Internal Block Diagram ........................................................................................... 6 Figure 3: Naming States and Transitions...................................................................................................... 7 Figure 4: Naming Use Cases ........................................................................................................................ 8 Figure 5: Domain Vocabulary........................................................................................................................ 8 Figure 6: Recommended Model Organization Set ........................................................................................ 9 Figure 7: Recommend SE Model Organization........................................................................................... 10 Figure 8: Subsystem Model Organization ................................................................................................... 11 Figure 9: Shared Model Organization ......................................................................................................... 11 Figure 10: Domains..................................................................................................................................... 12 Figure 12: Subsystem Model Organization ................................................................................................. 13 Figure 13: Example Class Diagram with Mission........................................................................................ 15 Figure 14: Example Project Overview diagram........................................................................................... 17 Figure 15: Use Case Description ................................................................................................................ 18 Figure 16: Scenario with description ........................................................................................................... 20 Figure 16: Fault Classification in Scenarios ................................................................................................ 21 Figure 17: Executable Use Cases Models as Objects ................................................................................ 23 Figure 18: Executable Use Case Statecharts ............................................................................................. 24 Figure 19: Executable Use Case Scenarios ............................................................................................... 25 Figure 20: Parameterized Classes.............................................................................................................. 27 Figure 21: Interfaces and Ports Example.................................................................................................... 28 Figure 22: Multiple Interface Implementations ............................................................................................ 29 Figure 23: Reflexive Associations ............................................................................................................... 30 Figure 24: Relations Example ..................................................................................................................... 30 Figure 25: Role Names Example ................................................................................................................ 31 Figure 26: Association Class....................................................................................................................... 31 Figure 27: Parameterization and Generalization......................................................................................... 32 Figure 28: Role Names Subclasses Example............................................................................................. 33 Figure 29: Sequence Diagram Example ..................................................................................................... 34 Figure 30: Interaction Fragment.................................................................................................................. 34 Figure 31: Loop Operator............................................................................................................................ 35 Figure 32: Opt and Alt Operators ................................................................................................................ 36 Figure 33: Nested States............................................................................................................................. 37 Figure 34: Complex statechart before decomposition into submachines ................................................... 38 Figure 35: Statechart decomposed into submachines – level 0.................................................................. 38 Figure 36: Statechart decomposed into submachines – level 1.................................................................. 39 Figure 37: Statechart decomposed into submachines – level 2.................................................................. 40 Figure 38: Coordinating And-States ............................................................................................................ 41 Figure 39: Use Case Statechart.................................................................................................................. 42 Figure 40: Forcing action closure...............................................................................................................