<Sequence Diagram Specification> Maharishi International University 1971-1995 MAHARISHI UNIVERSITY OF MANAGEMENT Software Engineering Use Case Desing Thomas Ogbamichael Thaer Omar Mousa Subas Chandra Shrestha Haisheng Chen 2011 Maharishi’s Year of Invincibility — Global Raam Raj 1 <Sequence Diagram Specification> Table of Contents 1 2 3 4 5 6 7 Revision History ......................................................................................................... 5 Introduction ................................................................................................................. 5 2.1 Purpose................................................................................................................ 5 2.2 Scope ................................................................................................................... 5 2.3 Definitions, Acronyms, and Abbreviations ........................................................ 6 2.4 Overview ............................................................................................................. 6 Analysis Model ........................................................................................................... 6 Sequence Diagrams ..................................................................................................... 7 4.1 Add user Sequence Diagram ............................................................................... 7 4.2 Add user Communication Diagram .................................................................... 7 4.3 Delete user Sequence Diagram ........................................................................... 7 4.4 Delete user Communication Diagram ................................................................. 8 4.5 Configure Machine Sequence Diagram .............................................................. 8 4.6 Configure Machine Communication Diagram.................................................... 9 4.7 Add Machine Sequence Diagram ..................................................................... 10 4.8 Add Machine Communication Diagram ........................................................... 10 4.9 Delete Machine Sequence Diagram .................................................................. 10 4.10 Delete Machine Communication Diagram ....................................................... 11 4.11 Handle Exception Sequence Diagram .............................................................. 11 4.12 Handle Exception Communication Diagram .................................................... 12 4.13 Generate Exception Sequence Diagram ............................................................ 13 4.14 Generate Exception Communication Diagram ................................................. 14 4.15 View Machine State sequence Diagram ........................................................... 14 4.16 View Machine State communication Diagram ................................................. 15 4.17 View Log Sequence Diagram ........................................................................... 15 4.18 View Log Communication Diagram ................................................................. 16 4.19 Turn on/off Machine Sequence Diagram .......................................................... 16 4.20 Turn on/off Machine Communication Diagram ............................................... 17 VOPC ........................................................................................................................ 19 Glossary .................................................................................................................... 19 References ................................................................................................................. 19 2 <Sequence Diagram Specification> List of Figures Figure 1Use Case Analysis Model ...................................................................................... 6 Figure 2 Add User Sequence diagram ................................................................................ 7 Figure 3 Add User Communication Diagram ..................................................................... 7 Figure 4 Delete user Sequence Diagram ............................................................................. 8 Figure 5 Delete user Communication Diagram .................................................................. 8 Figure 10 Delete Machine Sequence Diagram ................................................................. 11 Figure 11 Delete Machine Communication Diagram ....................................................... 11 Figure 12 Handle Exception Sequence Diagram .............................................................. 12 Figure 13 Handle Exception Communication Diagram.................................................... 13 Figure 14 Generate Exception Sequence Diagram ........................................................... 13 Figure 15 Generate Exception Communication Diagram ................................................. 14 Figure 16 View Machine State Sequence Diagram .......................................................... 15 Figure 17 View Machine State Sequence Diagram .......................................................... 15 Figure 18 View Log Sequence Diagram ........................................................................... 16 Figure 19 View Log Communication Diagram ................................................................ 16 3 <Sequence Diagram Specification> List of Tables Table 1 Revision History .................................................................................................... 5 4 <Sequence Diagram Specification> 1 Revision History Version 1.0 Document Status draft Change Status Author Description 04/20/2011 Group6 First draft Table 1 Revision History 2 Introduction The analysis model describes the structure of the machine control system. It consists of sequence diagrams and communication diagram that describe the logical implementation of the functional requirements identified in the use case model. The analysis model identifies the main classes in the system and contains a set of use case realizations that describe how the system will be built. The view of participating class (VOPC) diagrams describes the static structure of the system by using stereotypes to model the functional parts of the system. Sequence diagrams realize the use cases by describing the flow of events in the use cases when they are executed. Sequence Diagrams and Communication diagrams are used to realize use cases in the analysis model. Sequence diagrams are a type of interaction diagram. Communication diagrams are another type of interaction diagram. Although each of these types of interaction diagrams provides the same information, the focus of attention is different. Communication diagrams focus on the objects that work together to accomplish a given task or series of tasks. 2.1 Purpose This document provides a comprehensive view of the machine control system, using a number of different diagrams for representing the system functions (use cases). The realizations model how the parts of the system interact within the context of a specific use case. 2.2 Scope The machine control system allows the user to manage and operate machine by machine interface and mange user through login interface. And also store the configuration and user information into database or file. This document provides a set of model elements that show the internal behavior of the machine control system that corresponds to the use case—using sequence and communication diagrams. 5 <Sequence Diagram Specification> 2.3 Definitions, Acronyms, and Abbreviations See machine control system glossary document. 2.4 Overview The use case specification with GUI document describes use cases in terms of their flow of events, participant objects and corresponding diagram. Section 4 provides the sequence diagram, communication diagram for the machine control system. Section 5 provides the VOPC for all use case. 3 Analysis Model Figure 1Use Case Analysis Model 6 <Sequence Diagram Specification> 4 Sequence Diagrams 4.1 Add user Sequence Diagram From this diagram, we can see this use case is initiated by Login Interface, and through the User Controller to check if the user is an administrator, who is the only one can add user. And then new a user and insert it into database through DAL Controller. Figure 2 Add User Sequence diagram 4.2 Add user Communication Diagram From this diagram, we can see the User is added through the communication with boundary, controller and entity. And at last stored it into database through DB access controller. Figure 3 Add User Communication Diagram 4.3 Delete user Sequence Diagram From this diagram, we can see this use case is initiated by Login Interface, and through the User Controller to check if the user is an administrator, who is the only one can add user. And then delete a user and delete it from database through DAL Controller, too. 7 <Sequence Diagram Specification> Figure 4 Delete user Sequence Diagram 4.4 Delete user Communication Diagram From this diagram, we can see the User is deleted through the communication with boundary, controller and entity. And at last delete it from database through DB access controller. Figure 5 Delete user Communication Diagram 4.5 Configure Machine Sequence Diagram From this sequence diagram, the administrator use the interface configureMachine() to configure the machine passing by the configuration parameters, the MachineController firstly get the machine profile from the Database ,compare the valid parameters to configure, and then set parameter to Database ,change the machine state according the machine profile. 8 <Sequence Diagram Specification> Figure 6 Configure Machine Sequence Diagram 4.6 Configure Machine Communication Diagram From this communication diagram illustrate that we change the machine profile and then change the machine state according the machine profile. Figure 7 Configure Machine Communication Diagram 9 <Sequence Diagram Specification> 4.7 Add Machine Sequence Diagram From this diagram, administrator can add machine from MachineManagementInterface. The diagram provides the sequence of actions need to follow to add a new machine into the database. Figure 8 Add Machine Sequence Diagram 4.8 Add Machine Communication Diagram Add machine communication diagram provides the communication among objects to complete the Add machine request to the db. Figure 9 Add Machine Communication Diagram 4.9 Delete Machine Sequence Diagram This diagram provides the sequence of actions need to follow to delete an existing machine 10 <Sequence Diagram Specification> Figure 60 Delete Machine Sequence Diagram 4.10 Delete Machine Communication Diagram This diagram provides communication among objects to delete an existing machine. Machine need to be deleted from the machine list and database. Figure 71 Delete Machine Communication Diagram 4.11 Handle Exception Sequence Diagram From this sequence diagram, when finishing inspection of the machine logs and knowing what the problem is, the administrator use the interface of MachineController to clear the exception, and then reset the configuration of the machine. 11 <Sequence Diagram Specification> Figure 82 Handle Exception Sequence Diagram 4.12 Handle Exception Communication Diagram From this communication diagram, the administrator clear the machine exception and the reset the configuration of the machine. 12 <Sequence Diagram Specification> Figure 93 Handle Exception Communication Diagram 4.13 Generate Exception Sequence Diagram From this sequence diagram, the MachineExceptionStimulator use the time generates the exception randomly, and notify its exception to the MachineController, the MachineController will change the machine state according the specific machine and update the log to the file. Figure 104 Generate Exception Sequence Diagram 13 <Sequence Diagram Specification> 4.14 Generate Exception Communication Diagram From this communication diagram, MachineExcetionStimulator reports the exception to the MachineController, the MachineController change the machine state according the specific machine and update to the Log file. Figure 115 Generate Exception Communication Diagram 4.15 View Machine State sequence Diagram From this sequence diagram, the user use the interface of the MachineController to view machine state, the MachineController get the machine profile from the Database and the its current state to the user. 14 <Sequence Diagram Specification> Figure 126 View Machine State Sequence Diagram 4.16 View Machine State communication Diagram From this communication diagram, user gets the machine profile from the Database and its current state of the machine. Figure 137 View Machine State Sequence Diagram 4.17 View Log Sequence Diagram From this sequence diagram, the administrator use the interface of MachineController to view a machine log, the MachineController firstly get the specific machine profile from the Databas, and then get the log from the Log file according the specific machine keywords. 15 <Sequence Diagram Specification> Figure 148 View Log Sequence Diagram 4.18 View Log Communication Diagram From this communication diagram, the administrator get machine log from the Log file according its machine profile parameter. Figure 159 View Log Communication Diagram 4.19 Turn on/off Machine Sequence Diagram User pressed Turn on/off machine if on/off button is enabled in the user interface. Presentation Controller will receive this request and transfer to machine controller to process. DAL controller will update machine status in the DB 16 <Sequence Diagram Specification> Figure 20 Turn on/off Machine Sequence Diagram 4.20 Turn on/off Machine Communication Diagram When user submits turn on request, this request will be passed to machine controller to process through the presentation controller. Machinelist will update machine status and DAL controller will update machine status in DB 17 <Sequence Diagram Specification> Figure 21 : Turn on/off Machine Communication Diagram 18 <Sequence Diagram Specification> 5 VOPC Figure 22 View of Participating Classes (VOPC) 6 Glossary See glossary 7 References [1] Ref1 Problem Statement – Machine Control System [2] Ref2 Use case model– Machine Control System [3]Ref3 Use case specification– Machine Control System [4]Ref4. Architecture Analysis—Machine Control System 19