feat: update Library V19 (#1)

Author: dssAutomation

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Siemens AG
+Copyright (c) 2024 Siemens AG
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -1,13 +1,29 @@
-# UseCaseBasedDoku for the SIMATIC Modular Application Creator **Module Builder**
+# Usecases for the SIMATIC Modular Application Creator **Module Builder**
 
 This repository demonstrates how to use the comfort functions of the Modular Application Creator Module Builder. With those comfort functions the Openness programmer does not need to handle the xml file when e.g. calls in ladder logic should be generated. More information is available under [Modular Application Creator on SIOS](https://support.industry.siemens.com/cs/de/en/view/109762852).
 
-## 🚀 Getting started
+## 🚀 Getting started Documentation
 
-We just updated our [Use Case Based Dokumentation](https://usecasebaseddoku-pma-apc-mac-em-development-c8b2234f1dd10384098.code.siemens.io/html/index.html)!
+To see the documentation download html folder and start index.html in your browser.
+
+## Prerequisites
+- TIA-Portal 19 installed on Windows PC
+- Download the [Modular Application Creator 19.1](https://support.industry.siemens.com/cs/attachments/109762852/Modular_Application_Creator_19.00.01_all_in_one.zip)
+- Microsoft Visual Studio with [Modular Application Creator Module Builder](https://support.industry.siemens.com/cs/de/en/view/109762852) installed
+
+## First steps
+1. clone this repository in your Visual Studio
+1. optional: go to the Properties of your project in Visual Studio --> Debug --> Start external program and select the ModularApplicationCreator.exe
+1. Start your solution --> Modular Application Creator should show up
+    1. Create new Modular Application Creator project
+    1. Assign Equipment Module: modular-application-creator-use-cases to your PLC
+    1. Configure your Module under the "Configure modules" tab
+    1. Click generate under the "Generate" tab
+
+    --> your TIA-Portal project is generated
 
 ## 📝 License
 
-Copyright © 2022 [Siemens AG](https://www.siemens.com/).
+Copyright © 2024 [Siemens AG](https://www.siemens.com/).
 
 This project is MIT licensed.

SECURITY.md

@@ -6,4 +6,4 @@ SPDX-License-Identifier: MIT
 
 # Reporting Security Issues
 
-If you believe you have found a security vulnerability in usecasebaseddoku, we encourage you to let us know right away via [email protected]. We will investigate all legitimate reports and do our best to quickly fix the problem.
+If you believe you have found a security vulnerability in Modular Application Creator use cases documentation, we encourage you to let us know right away via [email protected]. We will investigate all legitimate reports and do our best to quickly fix the problem.

UseCaseBasedDoku/TiaImports/GeneratedClasses/UseCaseBasedDokuLibrary.cs

@@ -33,7 +33,7 @@ public static string TiaVersion
         {
             get
             {
-                return "TIA-V18.0";
+                return "TIA-V19.0";
             }
         }
 

UseCaseBasedDoku/TiaImports/ResourceManagement.cs

@@ -24,8 +24,13 @@ namespace UseCaseBasedDoku.TiaImports
 {
     public class ResourceManagement
     {
-        private List<TiaLibraryInfo> _libraryInfos;
+        private List<TiaLibraryInfo> m_libraryInfos;
+        private List<LibraryBase> m_libraries;
         private Dictionary<NameAndType, LibraryTypeObject> m_nameAndType2LibraryTypeObject = new Dictionary<NameAndType, LibraryTypeObject>();
+        private List<TagGroup> m_duplicatedRootTagGroups = new List<TagGroup>();
+        private List<TypeGroup> m_duplicatedRootTypeGroups = new List<TypeGroup>();
+        private List<BlockGroup> m_duplicatedRootBlockGroups = new List<BlockGroup>();
+        private List<WatchTableGroup> m_duplicatedRootWatchTableGroups = new List<WatchTableGroup>();
         // List of generated blocks
         public Dictionary<object, object> __created_block_list = new Dictionary<object, object>();
         public UseCaseBasedDokuLibrary UseCaseBasedDokuLibrary { get; set; }
@@ -155,18 +160,28 @@ public DataBlock CreateInstanceDbWithStandardizedName(LibraryTypeObject function
 
         public List<TiaLibraryInfo> GetLibraryInfos()
         {
-            if (_libraryInfos != null)
+            if (m_libraryInfos != null)
             {
-                return _libraryInfos;
+                return m_libraryInfos;
             }
 
-            _libraryInfos = new List<TiaLibraryInfo>();
+            m_libraryInfos = new List<TiaLibraryInfo>();
 
             LibraryBase lib = new UseCaseBasedDokuLibrary(false);
             var libInfo = new TiaLibraryInfo("UseCaseBasedDokuLibrary", lib.Version);
-            _libraryInfos.Add(libInfo);
+            m_libraryInfos.Add(libInfo);
 
-            return _libraryInfos;
+            return m_libraryInfos;
+        }
+
+        public List<LibraryBase> GetLibraries()
+        {
+
+            m_libraries = new List<LibraryBase>();
+
+            m_libraries.Add(UseCaseBasedDokuLibrary);
+
+            return m_libraries;
         }
 
         private void DeleteExistingInstanceGroups(PlcDevice targetDevice, UseCaseBasedDokuEM module)
@@ -303,6 +318,9 @@ private void AddResourcesToTiaProject(TiaTemplateContext tiaTemplateContext, Use
             LibraryWatchTablesRootGroup.AddGroup("UseCaseBasedDokuLibrary_WatchTables");
 
 
+            // Populate library types with ModuleBlocksRootGroup for InstanceDB creation
+            AddRootGroupToLibraryTypes();
+
             // Create tag lists
 
             // Create types
@@ -331,6 +349,26 @@ private void PostGeneration(TiaTemplateContext tiaTemplateContext, UseCaseBasedD
 
         private void FinishGeneration(TiaTemplateContext tiaTemplateContext, UseCaseBasedDokuEM module)
         {
+            foreach (var group in m_duplicatedRootBlockGroups)
+            {
+                tiaTemplateContext.EquipmentModuleHierarchyBuilder.RemoveEmptyGroups(group);
+            }
+
+            foreach (var group in m_duplicatedRootTagGroups)
+            {
+                tiaTemplateContext.EquipmentModuleHierarchyBuilder.RemoveEmptyGroups(group);
+            }
+
+            foreach (var group in m_duplicatedRootTypeGroups)
+            {
+                tiaTemplateContext.EquipmentModuleHierarchyBuilder.RemoveEmptyGroups(group);
+            }
+
+            foreach (var group in m_duplicatedRootWatchTableGroups)
+            {
+                tiaTemplateContext.EquipmentModuleHierarchyBuilder.RemoveEmptyGroups(group);
+            }
+
             tiaTemplateContext.EquipmentModuleHierarchyBuilder.RemoveEmptyGroups(ModuleTagsRootGroup);
             tiaTemplateContext.EquipmentModuleHierarchyBuilder.RemoveEmptyGroups(ModuleTypesRootGroup);
             tiaTemplateContext.EquipmentModuleHierarchyBuilder.RemoveEmptyGroups(ModuleBlocksRootGroup);
@@ -406,6 +444,20 @@ private void CorrectTheWrapperClasses(TiaTemplateContext tiaTemplateContext)
             }
         }
 
+        private void AddRootGroupToLibraryTypes()
+        {
+            foreach (LibraryBase library in GetLibraries())
+            {
+                foreach (LibraryTypeObject libraryTypeObject in library.Types.Values)
+                {
+                    if (libraryTypeObject is ICanCreateInstanceDB canCreateInstanceDbType)
+                    {
+                        canCreateInstanceDbType.InstanceDbTargetFolder = ModuleBlocksRootGroup.Blocks;
+                    }
+                }
+            }
+        }
+
         private class NameAndType
         {
             public string Name { get; }