DHBW/TINF20C_ModellingWizard_Devices
1
0
Fork 0
Code Issues 4 Pull Requests Packages Projects Releases 7 Wiki Activity

Updated 2. Software Architecture Specification (markdown)

Cyber-Luke 2022-05-05 18:58:22 +02:00
parent a1d642664c
commit 7e43b4f962
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
2.-Software-Architecture-Specification.md

@ -221,22 +221,22 @@ The current design of the plugin has changed a little, but not much (cf. Figure
<em>Figure 6 - MVC pattern</em> <em>Figure 6 - MVC pattern</em>
</p> </p>
Still the MVC pattern is a small part of the whole system design (cf. Figure 6). In this case the InputFromUser is obviously the user input. DeviceDesc (standing for Device Description), due to its two different C# program files, once maps the GUI and once the controller. DataMW is the class that takes care of the data management and creates an object of the type MWData, which can then export, store and process through the controller. The source code is located in the "app-source-code" branch under the "Source" folder. Click to open the [Source folder](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/tree/app-source-code/SOURCE). Still the MVC pattern is a small part of the whole system design (cf. Figure 6). In this case the InputFromUser is obviously the user input. DeviceDesc (standing for Device Description), due to its two different C# program files, once maps the GUI and once the controller. DataMW is the class that takes care of the data management and creates an object of the type MWData, which can then export, store and process through the controller. The source code is located in the "main" branch under the "Source" folder. Click to open the [Source folder](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/tree/main/SOURCE).
| **Classname** | **Storage location** | | **Classname** | **Storage location** |
| --- | --- | | --- | --- |
| About | [SOURCE/Plugin/About.xaml.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/app-source-code/SOURCE/Plugin/About.xaml.cs) | | About | [SOURCE/Plugin/About.xaml.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Plugin/About.xaml.cs) |
| AnimationClass | [SOURCE/Plugin/Animationclass.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/app-source-code/SOURCE/Plugin/AnimationClass.cs) | | AnimationClass | [SOURCE/Plugin/Animationclass.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Plugin/AnimationClass.cs) |
| AutomationMLDataTables | [SOURCE/Plugin/AutomationMLDataTables.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/app-source-code/SOURCE/Plugin/AutomationMLDataTables.cs) | | AutomationMLDataTables | [SOURCE/Plugin/AutomationMLDataTables.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Plugin/AutomationMLDataTables.cs) |
| ClassOfListFromReferenceFile | [SOURCE/Plugin/ClassOfListsFromReferencefile.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/app-source-code/SOURCE/Plugin/ClassOfListsFromReferencefile.cs) | | ClassOfListFromReferenceFile | [SOURCE/Plugin/ClassOfListsFromReferencefile.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Plugin/ClassOfListsFromReferencefile.cs) |
| DeviceDescription | GUI: [SOURCE/Plugin/DeviceDescription.Designer.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/app-source-code/SOURCE/Plugin/DeviceDescription.Designer.cs) <br> Logic: [SOURCE/Plugin/DeviceDescription.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/app-source-code/SOURCE/Plugin/DeviceDescription.cs) | | DeviceDescription | GUI: [SOURCE/Plugin/DeviceDescription.Designer.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Plugin/DeviceDescription.Designer.cs) <br> Logic: [SOURCE/Plugin/DeviceDescription.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Plugin/DeviceDescription.cs) |
| ModellingWizard | [SOURCE/Plugin/ModellingWizard.xaml.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/app-source-code/SOURCE/Plugin/ModellingWizard.xaml.cs) | | ModellingWizard | [SOURCE/Plugin/ModellingWizard.xaml.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Plugin/ModellingWizard.xaml.cs) |
| MWController | [SOURCE/Plugin/MWController.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/app-source-code/SOURCE/Plugin/MWController.cs) | | MWController | [SOURCE/Plugin/MWController.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Plugin/MWController.cs) |
| MWData | [SOURCE/Plugin/MWData.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/app-source-code/SOURCE/Plugin/MWData.cs) | | MWData | [SOURCE/Plugin/MWData.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Plugin/MWData.cs) |
| MWDevice | [SOURCE/Plugin/MWDevice.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/app-source-code/SOURCE/Plugin/MWDevice.cs) | | MWDevice | [SOURCE/Plugin/MWDevice.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Plugin/MWDevice.cs) |
| Resources | [SOURCE/Plugin/Resources/](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/tree/app-source-code/SOURCE/Plugin/Resources) | | Resources | [SOURCE/Plugin/Resources/](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/tree/main/SOURCE/Plugin/Resources) |
| SearchAMLComponentFile | [SOURCE/Plugin/SearchAMLComponentFile.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/app-source-code/SOURCE/Plugin/SearchAMLComponentFile.cs) | | SearchAMLComponentFile | [SOURCE/Plugin/SearchAMLComponentFile.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Plugin/SearchAMLComponentFile.cs) |
| SearchAMLLibraryFile | [SOURCE/Plugin/SearchAMLLibraryFile.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/app-source-code/SOURCE/Plugin/SearchAMLLibraryFile.cs) | | SearchAMLLibraryFile | [SOURCE/Plugin/SearchAMLLibraryFile.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Plugin/SearchAMLLibraryFile.cs) |
# 6. Subsystem specification <a name="SS"/> # 6. Subsystem specification <a name="SS"/>
@ -248,7 +248,7 @@ Still the MVC pattern is a small part of the whole system design (cf. Figure 6).
| **Services:** | The graphical user interface is taking input from the user and sending it to the controller by calling event functions. | | **Services:** | The graphical user interface is taking input from the user and sending it to the controller by calling event functions. |
| **Interfaces:** | --- | | **Interfaces:** | --- |
| **External Data:** | --- | | **External Data:** | --- |
| **Storage Location:** | [SOURCE/Plugin/DeviceDescription.Designer.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/app-source-code/SOURCE/Plugin/DeviceDescription.Designer.cs) | | **Storage Location:** | [SOURCE/Plugin/DeviceDescription.Designer.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Plugin/DeviceDescription.Designer.cs) |
| **Modul documentation:** | [MOD.001: Graphical User Interface (GUI)](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/wiki/MOD.001:-Graphical-User-Interface-(GUI)) | | **Modul documentation:** | [MOD.001: Graphical User Interface (GUI)](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/wiki/MOD.001:-Graphical-User-Interface-(GUI)) |
## 6.2 MOD.002 Controller <a name="SS2"/> ## 6.2 MOD.002 Controller <a name="SS2"/>
@ -259,7 +259,7 @@ Still the MVC pattern is a small part of the whole system design (cf. Figure 6).
| **Services:** | Logic distribution is handled by the controller. It is reacting to the events triggered by the GUI and takes care of creating the respective objects. Also the input and output functions are implemented in the controller. | | **Services:** | Logic distribution is handled by the controller. It is reacting to the events triggered by the GUI and takes care of creating the respective objects. Also the input and output functions are implemented in the controller. |
| **Interfaces:** | Interface of AMLX packages. For export/import of amlx files there is another class referenced: [SOURCE/Plugin/MWData.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Plugin/MWData.cs) | | **Interfaces:** | Interface of AMLX packages. For export/import of amlx files there is another class referenced: [SOURCE/Plugin/MWData.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Plugin/MWData.cs) |
| **External Data:** | --- | | **External Data:** | --- |
| **Storage location:** | [SOURCE/Plugin/DeviceDescription.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/app-source-code/SOURCE/Plugin/DeviceDescription.cs) | | **Storage location:** | [SOURCE/Plugin/DeviceDescription.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Plugin/DeviceDescription.cs) |
| **Modul documentation:** | [MOD.002: Controller](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/wiki/MOD.002:-Controller) | | **Modul documentation:** | [MOD.002: Controller](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/wiki/MOD.002:-Controller) |
## 6.3 MOD.003 Runtime <a name="SS3"/> ## 6.3 MOD.003 Runtime <a name="SS3"/>
@ -267,7 +267,7 @@ Still the MVC pattern is a small part of the whole system design (cf. Figure 6).
| **<MOD.003>** | **Runtime** | | **<MOD.003>** | **Runtime** |
| --- | --- | | --- | --- |
| **System&nbsp;requirements&nbsp;covered:** | /LF40/ | | **System&nbsp;requirements&nbsp;covered:** | /LF40/ |
| **Services:** | Here the logic is implemented to make the plugin standalone. | | **Services:** | This part of the programme turns the plug-in into a standalone application. The goal is that it has the same feature set as the AutomationML editor on which the plugin runs. |
| **Interfaces:** | --- | | **Interfaces:** | --- |
| **External Data:** | --- | | **External Data:** | --- |
| **Storage location:** | [SOURCE/Application/Program.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Application/Program.cs) | | **Storage location:** | [SOURCE/Application/Program.cs](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/blob/main/SOURCE/Application/Program.cs) |