Merge pull request #56 from siemens/22-how-do-i-include-typed-libraries

feat: add typed function block master copy example (#22)

Author: ClaudiusR

MAC_use_cases/MAC_use_cases.csproj

@@ -98,9 +98,10 @@ where to where -->
     <Compile Include="Model\BaseMAC_use_casesEM.cs" />
     <Compile Include="Model\BaseMAC_use_casesEMGeneratedItems.cs" />
     <Compile Include="TiaImports\GeneratedClasses\Lib_MAC_use_cases.cs" />
-    <Compile Include="TiaImports\GeneratedClasses\MAC_use_casesFB.cs" />
-    <Compile Include="TiaImports\GeneratedClasses\MAC_use_casesFB_FailSafe.cs" />
-    <Compile Include="TiaImports\GeneratedClasses\myDataType.cs" />
+    <Compile Include="TiaImports\GeneratedClasses\MyDataType.cs" />
+    <Compile Include="TiaImports\GeneratedClasses\MyFunctionBlock.cs" />
+    <Compile Include="TiaImports\GeneratedClasses\MyFunctionBlock_FailSafe.cs" />
+    <Compile Include="TiaImports\GeneratedClasses\MyFunctionBlock_Typed.cs" />
     <Compile Include="TiaImports\ResourceManagement.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="UI\MultiPageFrame.xaml.cs">
@@ -210,4 +211,4 @@ where to where -->
   <Target Name="AfterBuild">
   </Target>
   -->
-</Project>
+</Project>

MAC_use_cases/MAC_use_cases.nuspec

@@ -2,7 +2,7 @@
 <package>
   <metadata>
     <id>MAC_use_cases</id>
-    <version>1.0.9236-pre20250415123600</version>
+    <version>1.0.9237-pre20250416105728</version>
     <title>MAC_use_cases</title>
     <authors>SIEMENS AG</authors>
     <projectUrl>http://equipmentmodule.info/</projectUrl>

MAC_use_cases/MAC_use_cases.tiares

@@ -9,15 +9,16 @@
       <Group Name="LibraryRoot" GenerationName="Types.Groups[&quot;LibraryRoot&quot;]" RootGroupMemberName="LibraryTypesRootGroup">
         <Group Name="Lib_MAC_use_cases_Types" GenerationName="Types.Groups[&quot;LibraryRoot&quot;][&quot;Lib_MAC_use_cases_Types&quot;]" />
       </Group>
-      <Types Name="myDataType" GroupPath="Types.Groups[&quot;LibraryRoot&quot;][&quot;Lib_MAC_use_cases_Types&quot;].Types" allowRename="false" createOnlyOnce="true" ContainingLibrary="Lib_MAC_use_cases" OriginalTypeName="myDataType" LibraryType="False" />
+      <Types Name="MyDataType" GroupPath="Types.Groups[&quot;LibraryRoot&quot;][&quot;Lib_MAC_use_cases_Types&quot;].Types" allowRename="false" createOnlyOnce="true" ContainingLibrary="Lib_MAC_use_cases" OriginalTypeName="MyDataType" LibraryType="False" />
     </ResourceCategory>
     <ResourceCategory Name="SoftwareUnits" />
     <ResourceCategory Name="Blocks" GenerationName="Blocks.Groups[&quot;LibraryRoot&quot;][&quot;Lib_MAC_use_cases_Blocks&quot;]">
       <Group Name="LibraryRoot" GenerationName="Blocks.Groups[&quot;LibraryRoot&quot;]" RootGroupMemberName="LibraryBlocksRootGroup">
         <Group Name="Lib_MAC_use_cases_Blocks" GenerationName="Blocks.Groups[&quot;LibraryRoot&quot;][&quot;Lib_MAC_use_cases_Blocks&quot;]" />
       </Group>
-      <Blocks Name="MAC_use_casesFB" GroupPath="Blocks.Groups[&quot;LibraryRoot&quot;][&quot;Lib_MAC_use_cases_Blocks&quot;].Blocks" BlockType="FB" allowRename="true" createOnlyOnce="false" ContainingLibrary="Lib_MAC_use_cases" OriginalTypeName="MAC_use_casesFB" LibraryType="False" />
-      <Blocks Name="MAC_use_casesFB_FailSafe" GroupPath="Blocks.Groups[&quot;LibraryRoot&quot;][&quot;Lib_MAC_use_cases_Blocks&quot;].Blocks" BlockType="FB" allowRename="true" createOnlyOnce="false" ContainingLibrary="Lib_MAC_use_cases" OriginalTypeName="MAC_use_casesFB_FailSafe" LibraryType="False" />
+      <Blocks Name="MyFunctionBlock" GroupPath="Blocks.Groups[&quot;LibraryRoot&quot;][&quot;Lib_MAC_use_cases_Blocks&quot;].Blocks" BlockType="FB" allowRename="true" createOnlyOnce="false" ContainingLibrary="Lib_MAC_use_cases" OriginalTypeName="MyFunctionBlock" LibraryType="False" />
+      <Blocks Name="MyFunctionBlock_FailSafe" GroupPath="Blocks.Groups[&quot;LibraryRoot&quot;][&quot;Lib_MAC_use_cases_Blocks&quot;].Blocks" BlockType="FB" allowRename="true" createOnlyOnce="false" ContainingLibrary="Lib_MAC_use_cases" OriginalTypeName="MyFunctionBlock_FailSafe" LibraryType="False" />
+      <Blocks Name="MyFunctionBlock_Typed" GroupPath="Blocks.Groups[&quot;LibraryRoot&quot;][&quot;Lib_MAC_use_cases_Blocks&quot;].Blocks" BlockType="FB" allowRename="true" createOnlyOnce="false" ContainingLibrary="Lib_MAC_use_cases" OriginalTypeName="MyFunctionBlock_Typed" DefaultVersionGuid="37350dd3-dc9a-4954-a0dd-22084d7f0321" DefaultVersionIsIndependent="True" LibraryType="True" />
     </ResourceCategory>
     <ResourceCategory Name="TOs" />
     <ResourceCategory Name="WatchTables" GenerationName="WatchTables.Groups[&quot;LibraryRoot&quot;][&quot;Lib_MAC_use_cases_WatchTables&quot;]">

MAC_use_cases/Model/MAC_use_casesEM.cs

@@ -83,13 +83,13 @@ public ModuleEdge ModuleStart
     ///     This attribute is the string which is used for the renaming of the FB.
     ///     This string can be changed in the View
     /// </summary>
-    public string NameOfMyFb { get; set; } = "myFB";
+    public string NameOfMyFb { get; set; } = "MyFunctionBlock";
 
     /// <summary>
     ///     This attribute is the string which is used for the renaming of the safety-FB.
     ///     This string can be changed in the View
     /// </summary>
-    public string NameOfMyFailSafeFb { get; set; } = "myFailSafeFB";
+    public string NameOfMyFailSafeFb { get; set; } = "MyFunctionBlock_FailSafe";
 
     [JsonIgnore]
     public string NameAndType => NamingConventions.CreateModuleNameAndTypeForEM("MAC_use_cases", this);
@@ -131,54 +131,70 @@ public override bool GenerateTiaPortal(TiaTemplateContext tiaTemplateContext, st
             case TiaGenerationPhases.Build:
 
                 // Add equipment module specific code generation here.
-
                 var opennessTIAPortalProject = GeneralSupport.GetOpennessProject(tiaTemplateContext.TiaProject);
                 var opennessCPU = GeneralSupport.GetOpennessDeviceItem(tiaTemplateContext.TiaDevice);
                 m_softwareUnit = SoftwareUnits.GetOrCreateSoftwareUnit(m_plcDevice, "MyUnit", this);
 
+                // Configure a Technology Object
                 myTO.ConfigureTO(myTO.TechnologicalObject, this);
-
+                // Log messages
                 GeneralSupport.LogMessage(LogTypes.GenerationInfo, "Generate technology objects", this);
+                // Create Technology Object
                 TechnologyObjectClass.CreateTOs(m_plcDevice, this);
 
-                IntegrateLibraries.CreateInstanceDB(this, ResourceManagement.MAC_use_casesFB,
-                    "CreatedDbFromMasterCopy", ResourceManagement.ModuleBlocksRootGroup);
-
-                IntegrateLibraries.CreateInstanceDB(this, ResourceManagement.MAC_use_casesFB_FailSafe,
-                    "CreatedDbFromFailSafeFbMasterCopy", ResourceManagement.ModuleBlocksRootGroup);
-
-                IntegrateLibraries.CreateInstanceDB_via_XmlInstDB(this, ResourceManagement.MAC_use_casesFB,
+                IntegrateLibraries.CreateInstanceDB_via_XmlInstDB(this, ResourceManagement.MyFunctionBlock,
                     "CreatedDbFromMasterCopy_XmlInstDB", ResourceManagement.ModuleBlocksRootGroup, m_plcDevice);
 
-                GenericBlockCreation.GenerateDB("myDB", m_plcDevice, this);
+                var myDataBlockGlobal =
+                    GenericBlockCreation.GenerateGlobalDataBlock("MyDataBlock_Global", m_plcDevice, this);
 
-                GenericBlockCreation.SetDefaultValue("myDB", "myParameterName", TIATYPE.INT, "99", this);
+                GenericBlockCreation.SetDefaultValue(myDataBlockGlobal.Name, "myParameterName", TIATYPE.INT, "99",
+                    this);
 
                 GenericBlockCreation.GenerateMultiInstanceFB(m_plcDevice,
                     tiaTemplateContext.TiaProject.GetEditingLanguage(), this);
 
-                GenericBlockCreation.GenerateOB_Main("CreatedDbFromMasterCopy", this,
+                var dbFromMasterCopy = IntegrateLibraries.CreateInstanceDataBlock(this,
+                    ResourceManagement.MyFunctionBlock,
+                    $"{nameof(ResourceManagement.MyFunctionBlock)}Db", ResourceManagement.ModuleBlocksRootGroup);
+
+                GenericBlockCreation.GenerateOB_Main(dbFromMasterCopy.Name, this,
                     tiaTemplateContext.TiaProject.GetEditingLanguage(), m_plcDevice);
 
                 GenericBlockCreation.GenerateMainOBWithMultipleCalls("myOB", 10,
                     tiaTemplateContext.TiaProject.GetEditingLanguage(), m_plcDevice, this);
 
-                GenericBlockCreation.CreateFunctionBlock($"{NameOfMyFb}_FBD", "CreatedDbFromMasterCopy",
+                GenericBlockCreation.CreateFunctionBlock($"{NameOfMyFb}_FBD", dbFromMasterCopy.Name,
                     ProgrammingLanguage.FBD,
                     m_plcDevice);
-                GenericBlockCreation.CreateFunctionBlock($"{NameOfMyFb}_LAD", "CreatedDbFromMasterCopy",
+                GenericBlockCreation.CreateFunctionBlock($"{NameOfMyFb}_LAD", dbFromMasterCopy.Name,
                     ProgrammingLanguage.LAD,
                     m_plcDevice);
-                GenericBlockCreation.CreateFunctionBlock($"{NameOfMyFb}_SCL", "CreatedDbFromMasterCopy",
+                GenericBlockCreation.CreateFunctionBlock($"{NameOfMyFb}_SCL", dbFromMasterCopy.Name,
                     ProgrammingLanguage.SCL,
                     m_plcDevice);
+
+                var dbFromFailSafeFbMasterCopy = IntegrateLibraries.CreateInstanceDataBlock(this,
+                    ResourceManagement.MyFunctionBlock_FailSafe,
+                    $"{nameof(ResourceManagement.MyFunctionBlock_FailSafe)}Db",
+                    ResourceManagement.ModuleBlocksRootGroup);
+
                 GenericBlockCreation.CreateFailSafeFunctionBlock($"{NameOfMyFailSafeFb}_F_LAD",
-                    "CreatedDbFromFailSafeFbMasterCopy",
+                    dbFromFailSafeFbMasterCopy.Name,
                     ProgrammingLanguage.F_LAD,
                     m_plcDevice);
                 GenericBlockCreation.CreateFunctionBlockInSoftwareUnit(m_softwareUnit, "MyFb_FBD",
                     ProgrammingLanguage.FBD);
 
+                var dbFromTypedMasterCopy = IntegrateLibraries.CreateInstanceDataBlock(this,
+                    ResourceManagement.MyFunctionBlock_Typed,
+                    $"{nameof(ResourceManagement.MyFunctionBlock_Typed)}Db", ResourceManagement.ModuleBlocksRootGroup);
+
+                GenericBlockCreation.CreateFunctionBlock($"{nameof(ResourceManagement.MyFunctionBlock_Typed)}_FBD",
+                    dbFromTypedMasterCopy.Name,
+                    ProgrammingLanguage.FBD,
+                    m_plcDevice);
+
                 var myTagTable = CreateVariables.CreateTagTable(m_plcDevice, "myTagTable");
                 var mySoftwareUnitTagTable = CreateVariables.CreateTagTable(m_softwareUnit, "mySoftwareUnitTagTable");
 

MAC_use_cases/Model/UseCases/GenericBlockCreation.cs

@@ -144,10 +144,10 @@ public static void CreateFailSafeFunctionBlock(string blockName, string instance
     /// <param name="dbName"></param>
     /// <param name="plcDevice">The PLC on which the equipment module is implemented</param>
     /// <param name="module">The corresponding equipment module</param>
-    public static void GenerateDB(string dbName, PlcDevice plcDevice, MAC_use_casesEM module)
+    public static XmlGlobalDB GenerateGlobalDataBlock(string dbName, PlcDevice plcDevice, MAC_use_casesEM module)
     {
-        var axesDataDB = new XmlGlobalDB(dbName);
-        var itf = axesDataDB.Interface[InterfaceSections.Static];
+        var dataBlock = new XmlGlobalDB(dbName);
+        var itf = dataBlock.Interface[InterfaceSections.Static];
 
         //Create new parameters. The custom parameter means you are using your own user defined data type.
         var standardParam = new InterfaceParameter(ParameterName, "Int");
@@ -161,7 +161,8 @@ public static void GenerateDB(string dbName, PlcDevice plcDevice, MAC_use_casesE
         itf.Add(customParam1);
         itf.Add(customParam2);
 
-        axesDataDB.GenerateXmlBlock(plcDevice);
+        dataBlock.GenerateXmlBlock(plcDevice);
+        return dataBlock;
     }
 
     /// <summary>
@@ -260,40 +261,34 @@ public static void SetDefaultValue(string dbName, string parameterName, TIATYPE
     /// <param name="module">The Module</param>
     public static void GenerateMultiInstanceFB(PlcDevice plcDevice, string languageSettings, MAC_use_casesEM module)
     {
-        var myFb = new XmlFB("MyMultiInstanceFB");
-        myFb.BlockAttributes.ProgrammingLanguage = ProgrammingLanguage.LAD;
-
-        var myMultiInstanceFBCall = new MultiInstanceCall("MyMultiInstanceDbName", "MAC_use_casesFB", plcDevice)
+        var myFb = new XmlFB("MyFunctionBlock_MultiInstance")
         {
-            ["Input1"] = "1", // inputVariable1
-            ["Input2"] = "0" // inputVariable1
-            //["Input2"] = "inputVariable1", 
-
-            //["Output1"] = "outputVariable1", 
+            BlockAttributes = { ProgrammingLanguage = ProgrammingLanguage.LAD }
         };
 
-        //manipulate interface
-        //var axesDataDB = new XmlFB (dbName);
-        var itf = myFb.Interface[InterfaceSections.Static];
+        var multiInstanceDataBlockName = myFb.Name + "_Instance";
+        var myMultiInstanceFbCall =
+            new MultiInstanceCall(multiInstanceDataBlockName, module.ResourceManagement.MyFunctionBlock.Name, plcDevice)
+            {
+                ["Input1"] = "1", // inputVariable1
+                ["Input2"] = "0" // inputVariable1
+            };
 
-        //Define two interface parameters
-        InterfaceParameter customParam;
+        //manipulate interface
+        var interfaceParameters = myFb.Interface[InterfaceSections.Static];
 
         //Create new parameters. The custom parameter means you are using your own user defined data type.
-
-        customParam =
-            new InterfaceParameter("MyMultiInstanceDbName", "\"" + "MAC_use_casesFB" + "\"")
-            {
-                Remanence = RemanenceSettings.IgnoreRemanence
-            };
+        var customParam =
+            new InterfaceParameter(multiInstanceDataBlockName,
+                module.ResourceManagement.MyFunctionBlock.Name) { Remanence = RemanenceSettings.IgnoreRemanence };
 
         //Add your parameters 
-        itf.Add(customParam);
+        interfaceParameters.Add(customParam);
 
         var networkMultiInstance = new BlockNetwork();
-        networkMultiInstance.Blocks.Add(myMultiInstanceFBCall);
+        networkMultiInstance.Blocks.Add(myMultiInstanceFbCall);
         networkMultiInstance.GenerationLabel =
-            new GenerationLabel(module.Name, "Generated by MAC2", module.ModuleID.ToString());
+            new GenerationLabel(module.Name, "Generated by MAC", module.ModuleID.ToString());
         myFb.Networks.Add(networkMultiInstance);
         AddCodeBlockToOB(myFb, module.ResourceManagement, languageSettings, plcDevice);
     }
@@ -335,7 +330,7 @@ public static void GenerateOB_Main(string instanceDbName, MAC_use_casesEM module
         mainOb.Networks.Add(blockNetwork);
 
         ///Create a SCL-network with IF and ELSE Statements
-        var content = "\"myDB\".myParameterName := 100;\n";
+        var content = "\"MyDataBlock_Global\".myParameterName := 100;\n";
         content += "IF #Temp THEN\n";
         content += "#TempInt := 5;\n";
         content += "ELSE\n";
@@ -404,19 +399,19 @@ public static void GenerateMainOBWithMultipleCalls(string name, int numberOfCall
 
         for (var i = 1; i <= numberOfCalls; i++)
         {
-            IntegrateLibraries.CreateInstanceDB(module, module.ResourceManagement.MAC_use_casesFB,
-                "CreatedDbFromMasterCopy" + i, module.ResourceManagement.ModuleBlocksRootGroup);
-            var blockname = "CreatedDbFromMasterCopy" + i;
-            var myOBCall = new BlockCall(blockname, plcDevice)
+            var blockName = $"{nameof(module.ResourceManagement.MyFunctionBlock)}DB" + i;
+            IntegrateLibraries.CreateInstanceDataBlock(module, module.ResourceManagement.MyFunctionBlock,
+                blockName, module.ResourceManagement.ModuleBlocksRootGroup);
+            var myOBCall = new BlockCall(blockName, plcDevice)
             {
                 ["Input1"] = "1", // inputVariable1
                 ["Input2"] = "0" // inputVariable1
             };
 
             var myObBlockNetwork = new BlockNetwork();
             myObBlockNetwork.Blocks.Add(myOBCall);
-            myObBlockNetwork.GenerationLabel = new GenerationLabel(blockname,
-                "Generated by MAC. Blockname: \"" + blockname + "\"", module.ModuleID.ToString());
+            myObBlockNetwork.GenerationLabel = new GenerationLabel(blockName,
+                "Generated by MAC. Blockname: \"" + blockName + "\"", module.ModuleID.ToString());
             myOb.Networks.Add(myObBlockNetwork);
         }