* after refactor of predefined concepts

eclipse-aaspe · Mar 3, 2024 · dcef9a2 · dcef9a2
1 parent b5322bd
commit dcef9a2
Show file tree

Hide file tree

Showing 33 changed files with 68 additions and 45 deletions.
diff --git a/src/AasxPluginExportTable/Table/ExportTableProcessor.cs b/src/AasxPluginExportTable/Table/ExportTableProcessor.cs
@@ -25,7 +25,7 @@ This source code may use other Open Source software components (see LICENSE.txt)
 using System.Text.RegularExpressions;
 using System.Windows.Media;
 using Aas = AasCore.Aas3_0;
-using AasxPredefinedConcepts;
+using AasxPredefinedConcepts.Qualifiers;
 
 // ReSharper disable PossiblyMistakenUseOfParamsMethod .. issue, even if according to samples of Word API
 

diff --git a/src/AasxPluginExportTable/Uml/BaseWriter.cs b/src/AasxPluginExportTable/Uml/BaseWriter.cs
@@ -24,7 +24,7 @@ This source code may use other Open Source software components (see LICENSE.txt)
 using Aas = AasCore.Aas3_0;
 using AdminShellNS;
 using Extensions;
-using AasxPredefinedConcepts;
+using AasxPredefinedConcepts.Qualifiers;
 
 namespace AasxPluginExportTable.Uml
 {

diff --git a/...xPredefinedConcepts/AasxDefinitionBase.cs → ...oncepts/BaseTopUtil/AasxDefinitionBase.cs b/...xPredefinedConcepts/AasxDefinitionBase.cs → ...oncepts/BaseTopUtil/AasxDefinitionBase.cs
diff --git a/...AasxPredefinedConcepts/DefinitionsPool.cs → ...edConcepts/BaseTopUtil/DefinitionsPool.cs b/...AasxPredefinedConcepts/DefinitionsPool.cs → ...edConcepts/BaseTopUtil/DefinitionsPool.cs
diff --git a/...finedConcepts/ExportPredefinedConcepts.cs → ...s/BaseTopUtil/ExportPredefinedConcepts.cs b/...finedConcepts/ExportPredefinedConcepts.cs → ...s/BaseTopUtil/ExportPredefinedConcepts.cs
diff --git a/...Concepts/PredefinedConceptsClassMapper.cs → ...eTopUtil/PredefinedConceptsClassMapper.cs b/...Concepts/PredefinedConceptsClassMapper.cs → ...eTopUtil/PredefinedConceptsClassMapper.cs
diff --git a/...redefinedConcepts/DefinitionsAasEvents.cs → ...cepts/Definitions/DefinitionsAasEvents.cs b/...redefinedConcepts/DefinitionsAasEvents.cs → ...cepts/Definitions/DefinitionsAasEvents.cs
diff --git a/...PredefinedConcepts/DefinitionsAsciiDoc.cs → ...ncepts/Definitions/DefinitionsAsciiDoc.cs b/...PredefinedConcepts/DefinitionsAsciiDoc.cs → ...ncepts/Definitions/DefinitionsAsciiDoc.cs
diff --git a/...oncepts/DefinitionsDigitalNameplateV20.cs → ...nitions/DefinitionsDigitalNameplateV20.cs b/...oncepts/DefinitionsDigitalNameplateV20.cs → ...nitions/DefinitionsDigitalNameplateV20.cs
diff --git a/...efinedConcepts/DefinitionsExperimental.cs → ...ts/Definitions/DefinitionsExperimental.cs b/...efinedConcepts/DefinitionsExperimental.cs → ...ts/Definitions/DefinitionsExperimental.cs
diff --git a/...s/DefinitionsIdtaContactInformationV10.cs → ...s/DefinitionsIdtaContactInformationV10.cs b/...s/DefinitionsIdtaContactInformationV10.cs → ...s/DefinitionsIdtaContactInformationV10.cs
diff --git a/...efinitionsIdtaHandoverDocumentationV12.cs → ...efinitionsIdtaHandoverDocumentationV12.cs b/...efinitionsIdtaHandoverDocumentationV12.cs → ...efinitionsIdtaHandoverDocumentationV12.cs
diff --git a/...finitionsIdtaHierarchicalStructuresV10.cs → ...finitionsIdtaHierarchicalStructuresV10.cs b/...finitionsIdtaHierarchicalStructuresV10.cs → ...finitionsIdtaHierarchicalStructuresV10.cs
diff --git a/...ncepts/DefinitionsIdtaTechnicalDataV12.cs → ...itions/DefinitionsIdtaTechnicalDataV12.cs b/...ncepts/DefinitionsIdtaTechnicalDataV12.cs → ...itions/DefinitionsIdtaTechnicalDataV12.cs
diff --git a/...PredefinedConcepts/DefinitionsImageMap.cs → ...ncepts/Definitions/DefinitionsImageMap.cs b/...PredefinedConcepts/DefinitionsImageMap.cs → ...ncepts/Definitions/DefinitionsImageMap.cs
diff --git a/...redefinedConcepts/DefinitionsLanguages.cs → ...cepts/Definitions/DefinitionsLanguages.cs b/...redefinedConcepts/DefinitionsLanguages.cs → ...cepts/Definitions/DefinitionsLanguages.cs
diff --git a/src/AasxPredefinedConcepts/DefinitionsMTP.cs → ...nedConcepts/Definitions/DefinitionsMTP.cs b/src/AasxPredefinedConcepts/DefinitionsMTP.cs → ...nedConcepts/Definitions/DefinitionsMTP.cs
diff --git a/...nedConcepts/DefinitionsPackageExplorer.cs → ...Definitions/DefinitionsPackageExplorer.cs b/...nedConcepts/DefinitionsPackageExplorer.cs → ...Definitions/DefinitionsPackageExplorer.cs
diff --git a/...PredefinedConcepts/DefinitionsPlotting.cs → ...ncepts/Definitions/DefinitionsPlotting.cs b/...PredefinedConcepts/DefinitionsPlotting.cs → ...ncepts/Definitions/DefinitionsPlotting.cs
diff --git a/...definedConcepts/DefinitionsSmdExporter.cs → ...pts/Definitions/DefinitionsSmdExporter.cs b/...definedConcepts/DefinitionsSmdExporter.cs → ...pts/Definitions/DefinitionsSmdExporter.cs
diff --git a/...efinedConcepts/DefinitionsSmtAdditions.cs → ...ts/Definitions/DefinitionsSmtAdditions.cs b/...efinedConcepts/DefinitionsSmtAdditions.cs → ...ts/Definitions/DefinitionsSmtAdditions.cs
diff --git a/...PredefinedConcepts/DefinitionsV2770v11.cs → ...ncepts/Definitions/DefinitionsV2770v11.cs b/...PredefinedConcepts/DefinitionsV2770v11.cs → ...ncepts/Definitions/DefinitionsV2770v11.cs
diff --git a/...xPredefinedConcepts/DefinitionsVDI2770.cs → ...oncepts/Definitions/DefinitionsVDI2770.cs b/...xPredefinedConcepts/DefinitionsVDI2770.cs → ...oncepts/Definitions/DefinitionsVDI2770.cs
diff --git a/...ncepts/DefinitionsZveiDigitalTypeplate.cs → ...itions/DefinitionsZveiDigitalTypeplate.cs b/...ncepts/DefinitionsZveiDigitalTypeplate.cs → ...itions/DefinitionsZveiDigitalTypeplate.cs
diff --git a/...edConcepts/DefinitionsZveiNameplateV10.cs → ...efinitions/DefinitionsZveiNameplateV10.cs b/...edConcepts/DefinitionsZveiNameplateV10.cs → ...efinitions/DefinitionsZveiNameplateV10.cs
diff --git a/...dConcepts/DefinitionsZveiTechnicalData.cs → ...finitions/DefinitionsZveiTechnicalData.cs b/...dConcepts/DefinitionsZveiTechnicalData.cs → ...finitions/DefinitionsZveiTechnicalData.cs
diff --git a/...ncepts/DefinitionsZveiTechnicalDataV11.cs → ...itions/DefinitionsZveiTechnicalDataV11.cs b/...ncepts/DefinitionsZveiTechnicalDataV11.cs → ...itions/DefinitionsZveiTechnicalDataV11.cs
diff --git a/...cepts/DefinitionsZveiTimeSeriesDataV10.cs → ...tions/DefinitionsZveiTimeSeriesDataV10.cs b/...cepts/DefinitionsZveiTimeSeriesDataV10.cs → ...tions/DefinitionsZveiTimeSeriesDataV10.cs
diff --git a/...pts/MappingsAssetInterfacesDescription.cs → ...ngs/MappingsAssetInterfacesDescription.cs b/...pts/MappingsAssetInterfacesDescription.cs → ...ngs/MappingsAssetInterfacesDescription.cs
diff --git a/...oncepts/MappingsAssetInterfacesMapping.cs → ...appings/MappingsAssetInterfacesMapping.cs b/...oncepts/MappingsAssetInterfacesMapping.cs → ...appings/MappingsAssetInterfacesMapping.cs
diff --git a/...pts/MappingsProductChangeNotifications.cs → ...ngs/MappingsProductChangeNotifications.cs b/...pts/MappingsProductChangeNotifications.cs → ...ngs/MappingsProductChangeNotifications.cs
diff --git a/src/AasxPredefinedConcepts/QualifiersSmt.cs → ...finedConcepts/Qualifiers/QualifiersSmt.cs b/src/AasxPredefinedConcepts/QualifiersSmt.cs → ...finedConcepts/Qualifiers/QualifiersSmt.cs
@@ -21,7 +21,7 @@ This source code may use other Open Source software components (see LICENSE.txt)
 // reSharper disable UnusedType.Global
 // reSharper disable ClassNeverInstantiated.Global
 
-namespace AasxPredefinedConcepts
+namespace AasxPredefinedConcepts.Qualifiers
 {
     /// <summary>
     /// This class provides handles specific qualifiers, extensions
@@ -64,105 +64,105 @@ public enum AccessMode
             ReadOnly
         };
 
-        public static Aas.IQualifier CreateQualifierSmtCardinality(SmtCardinality card)
+        public static IQualifier CreateQualifierSmtCardinality(SmtCardinality card)
         {
-            return new Aas.Qualifier(
+            return new Qualifier(
                 type: "SMT/Cardinality",
                 valueType: DataTypeDefXsd.String,
                 kind: QualifierKind.TemplateQualifier,
-                semanticId: new Aas.Reference(ReferenceTypes.ExternalReference,
-                    (new Aas.IKey[] {
-                        new Aas.Key(KeyTypes.GlobalReference,
+                semanticId: new Reference(ReferenceTypes.ExternalReference,
+                    (new IKey[] {
+                        new Key(KeyTypes.GlobalReference,
                             "https://admin-shell.io/SubmodelTemplates/Cardinality/1/0")
                     }).ToList()),
                 value: "" + card);
         }
 
-        public static Aas.IQualifier CreateQualifierSmtAllowedValue(string regex)
+        public static IQualifier CreateQualifierSmtAllowedValue(string regex)
         {
-            return new Aas.Qualifier(
+            return new Qualifier(
                 type: "SMT/AllowedValue",
                 valueType: DataTypeDefXsd.String,
                 kind: QualifierKind.TemplateQualifier,
-                semanticId: new Aas.Reference(ReferenceTypes.ExternalReference,
-                    (new Aas.IKey[] {
-                        new Aas.Key(KeyTypes.GlobalReference,
+                semanticId: new Reference(ReferenceTypes.ExternalReference,
+                    (new IKey[] {
+                        new Key(KeyTypes.GlobalReference,
                             "https://admin-shell.io/SubmodelTemplates/AllowedValue/1/0")
                     }).ToList()),
                 value: "" + regex);
         }
 
-        public static Aas.IQualifier CreateQualifierSmtExampleValue(string exampleValue)
+        public static IQualifier CreateQualifierSmtExampleValue(string exampleValue)
         {
-            return new Aas.Qualifier(
+            return new Qualifier(
                 type: "SMT/ExampleValue",
                 valueType: DataTypeDefXsd.String,
                 kind: QualifierKind.TemplateQualifier,
-                semanticId: new Aas.Reference(ReferenceTypes.ExternalReference,
-                    (new Aas.IKey[] {
-                        new Aas.Key(KeyTypes.GlobalReference,
+                semanticId: new Reference(ReferenceTypes.ExternalReference,
+                    (new IKey[] {
+                        new Key(KeyTypes.GlobalReference,
                             "https://admin-shell.io/SubmodelTemplates/ExampleValue/1/0")
                     }).ToList()),
                 value: "" + exampleValue);
         }
 
-        public static Aas.IQualifier CreateQualifierSmtDefaultValue(string defaultValue)
+        public static IQualifier CreateQualifierSmtDefaultValue(string defaultValue)
         {
-            return new Aas.Qualifier(
+            return new Qualifier(
                 type: "SMT/DefaultValue",
                 valueType: DataTypeDefXsd.String,
                 kind: QualifierKind.TemplateQualifier,
-                semanticId: new Aas.Reference(ReferenceTypes.ExternalReference,
-                    (new Aas.IKey[] {
-                        new Aas.Key(KeyTypes.GlobalReference,
+                semanticId: new Reference(ReferenceTypes.ExternalReference,
+                    (new IKey[] {
+                        new Key(KeyTypes.GlobalReference,
                             "https://admin-shell.io/SubmodelTemplates/DefaultValue/1/0")
                     }).ToList()),
                 value: "" + defaultValue);
         }
 
-        public static Aas.IQualifier CreateQualifierSmtEitherOr(string equivalencyClass)
+        public static IQualifier CreateQualifierSmtEitherOr(string equivalencyClass)
         {
-            return new Aas.Qualifier(
+            return new Qualifier(
                 type: "SMT/EitherOr",
                 valueType: DataTypeDefXsd.String,
                 kind: QualifierKind.TemplateQualifier,
-                semanticId: new Aas.Reference(ReferenceTypes.ExternalReference,
-                    (new Aas.IKey[] {
-                        new Aas.Key(KeyTypes.GlobalReference,
+                semanticId: new Reference(ReferenceTypes.ExternalReference,
+                    (new IKey[] {
+                        new Key(KeyTypes.GlobalReference,
                             "https://admin-shell.io/SubmodelTemplates/Cardinality/1/0")
                     }).ToList()),
                 value: "" + equivalencyClass);
         }
 
-        public static Aas.IQualifier CreateQualifierSmtRequiredLang(string reqLang)
+        public static IQualifier CreateQualifierSmtRequiredLang(string reqLang)
         {
-            return new Aas.Qualifier(
+            return new Qualifier(
                 type: "SMT/RequiredLang",
                 valueType: DataTypeDefXsd.String,
                 kind: QualifierKind.TemplateQualifier,
-                semanticId: new Aas.Reference(ReferenceTypes.ExternalReference,
-                    (new Aas.IKey[] {
-                        new Aas.Key(KeyTypes.GlobalReference,
+                semanticId: new Reference(ReferenceTypes.ExternalReference,
+                    (new IKey[] {
+                        new Key(KeyTypes.GlobalReference,
                             "https://admin-shell.io/SubmodelTemplates/RequiredLang/1/0")
                     }).ToList()),
                 value: "" + reqLang);
         }
 
-        public static Aas.IQualifier CreateQualifierSmtAccessMode(AccessMode mode)
+        public static IQualifier CreateQualifierSmtAccessMode(AccessMode mode)
         {
-            return new Aas.Qualifier(
+            return new Qualifier(
                 type: "SMT/AccessMode",
                 valueType: DataTypeDefXsd.String,
                 kind: QualifierKind.TemplateQualifier,
-                semanticId: new Aas.Reference(ReferenceTypes.ExternalReference,
-                    (new Aas.IKey[] {
-                        new Aas.Key(KeyTypes.GlobalReference,
+                semanticId: new Reference(ReferenceTypes.ExternalReference,
+                    (new IKey[] {
+                        new Key(KeyTypes.GlobalReference,
                             "https://admin-shell.io/SubmodelTemplates/AccessMode/1/0")
                     }).ToList()),
                 value: "" + mode);
         }
 
-        public static Aas.IQualifier[] AllSmtQualifiers =
+        public static IQualifier[] AllSmtQualifiers =
         {
             CreateQualifierSmtCardinality(SmtCardinality.One),
             CreateQualifierSmtAllowedValue(""),
@@ -177,11 +177,11 @@ public static Aas.IQualifier CreateQualifierSmtAccessMode(AccessMode mode)
         /// Find either <c>type</c> or <c>semanticId</c> and returns the link
         /// to a STATIC IQualifier (not to be changed!).
         /// </summary>
-        public static Aas.IQualifier FindQualifierTypeInst(
-            string type, Aas.IReference semanticId, bool relaxed = true)
+        public static IQualifier FindQualifierTypeInst(
+            string type, IReference semanticId, bool relaxed = true)
         {
             // at best: tries to find semanticId
-            Aas.IQualifier res = null;
+            IQualifier res = null;
             foreach (var qti in AllSmtQualifiers)
                 if (semanticId?.IsValid() == true && semanticId.Matches(qti.SemanticId, MatchMode.Relaxed))
                     res = qti;
@@ -210,7 +210,7 @@ public static Aas.IQualifier FindQualifierTypeInst(
         /// <summary>
         /// Ask for different Qualifier names for cardinality and give a match back.
         /// </summary>
-        public static Aas.IQualifier FindSmtCardinalityQualfier(IEnumerable<IQualifier> qualifiers)
+        public static IQualifier FindSmtCardinalityQualfier(IEnumerable<IQualifier> qualifiers)
         {
             // TODO (MIHO, 2024-02-20): In future, check semanticIds as well?
 
@@ -234,7 +234,7 @@ public static string CardinalityToString(SmtCardinality card, int format = 0,
             if (p >= 0)
                 multiStr = multiStr.Substring(p).Trim('[', ']');
 #else
-            switch (card) 
+            switch (card)
             {
                 case SmtCardinality.ZeroToOne:
                     switch (format)

diff --git a/src/AasxPredefinedConcepts/README/Overview.md b/src/AasxPredefinedConcepts/README/Overview.md
@@ -7,7 +7,18 @@ semanticIds and class structures. These concepts could be used on
 *source code level* to avoid having semanticIds as sttring constants.
 
 Nearly everything here was produced by the export function:
-AASPE / File / Export / Export predefined concepts
+AASPE / File / Export / Export predefined concepts.
+
+Multiple low level SDK function are designed for using these symbols, e.g.
+
+```
+foreach (var srcLst in this.theSubmodel.SubmodelElements
+    .FindAllSemanticIdAs<Aas.SubmodelElementCollection>(
+        this.defsMtp.CD_SourceList?.GetReference(), MatchMode.Relaxed))
+{
+    ...
+}
+```
 
 ## Programmers note
 
@@ -19,6 +30,18 @@ However, when using "Add predefined .." button in References dialogue, the user
 has to wait some 8sec for the first results, as *ALL* classes are firstly 
 instantiated for this scan.
 
+## Namespaces
+
+Currently, the folder names do not influence the namespaces of the classes, because
+handling would even get longer.
+
+## BaseTopUtil
+
+These classes are either base classes, utility functions or the root definitions,
+where all others are linked to.
+
+Note: New definition classes shall be linked within `DefinitionsPool.cs`.
+
 ## Concept model
 
 (Deprecated) approach to provide a switcher between different sets of concepts,