New extension methods for schema attribute parsing

buildingSMART · Oct 21, 2023 · 95b6cdc · 95b6cdc
1 parent db51011
commit 95b6cdc
Show file tree

Hide file tree

Showing 4 changed files with 60 additions and 17 deletions.
diff --git a/ids-lib/IfcSchema/IfcSchemaVersionsExtensions.cs b/ids-lib/IfcSchema/IfcSchemaVersionsExtensions.cs
@@ -10,20 +10,35 @@ namespace IdsLib.IfcSchema;
 public static class IfcSchemaVersionsExtensions
 {
     /// <summary>
-    /// Converts a set of IFC schema name strings to the relative enum value
+    /// Canonical string version of the schema version
     /// </summary>
-    /// <param name="schemasStrings">Enumerable strings to be evaluated</param>
-    /// <returns>A single enumeration value representing all the <paramref name="schemasStrings"/></returns>
-    public static IfcSchemaVersions GetSchema(IEnumerable<string> schemasStrings)
+    public const string IfcSchema2x3String = "Ifc2x3";
+
+	/// <summary>
+	/// Canonical string version of the schema version
+	/// </summary>
+	public const string IfcSchema4String = "Ifc4";
+
+	/// <summary>
+	/// Canonical string version of the schema version
+	/// </summary>
+	public const string IfcSchema4x3String = "Ifc4x3";
+
+	/// <summary>
+	/// Converts a set of IFC schema name strings to the relative enum value
+	/// </summary>
+	/// <param name="schemaStrings">Enumerable strings to be evaluated</param>
+	/// <returns>A single enumeration value representing all the <paramref name="schemaStrings"/></returns>
+	public static IfcSchemaVersions GetSchema(IEnumerable<string> schemaStrings)
     {
         IfcSchemaVersions ret = IfcSchemaVersions.IfcNoVersion;
-        foreach (var scheme in schemasStrings)
+        foreach (var scheme in schemaStrings)
         {
             IfcSchemaVersions v = scheme switch
             {
-                "Ifc2x3" => IfcSchemaVersions.Ifc2x3,
-                "Ifc4" => IfcSchemaVersions.Ifc4,
-                "Ifc4x3" => IfcSchemaVersions.Ifc4x3,
+				IfcSchema2x3String => IfcSchemaVersions.Ifc2x3,
+				IfcSchema4String => IfcSchemaVersions.Ifc4,
+				IfcSchema4x3String => IfcSchemaVersions.Ifc4x3,
                 _ => IfcSchemaVersions.IfcNoVersion,
             };
             if (v == IfcSchemaVersions.IfcNoVersion)
@@ -33,12 +48,40 @@ public static IfcSchemaVersions GetSchema(IEnumerable<string> schemasStrings)
         return ret;
     }
 
-    /// <summary>
-    /// Makes it easy to use the <see cref="SchemaInfo.TryGetSchemaInformation(IfcSchemaVersions, out IEnumerable{SchemaInfo})"/> directly from a schema enum.
-    /// </summary>
-    /// <param name="schemas">the enum to evaluate</param>
-    /// <param name="schemaInfo">the identified schema infos</param>
-    /// <returns>true if the values are matched</returns>
+	/// <summary>
+	/// Converts a set of IFC schema strings, concatenated in a single space separated string (useful for XML attribute reading).
+	/// </summary>
+	/// <param name="spaceSeparatedSchemaStrings">A single string possibly containing multiple space separated values to be evaluated</param>
+	/// <returns>A single enumeration value representing all the <paramref name="spaceSeparatedSchemaStrings"/></returns>
+	public static IfcSchemaVersions ParseXmlSchemasFromAttribute(this string spaceSeparatedSchemaStrings)
+	{
+		var tmp = spaceSeparatedSchemaStrings.Split(new[] { " " }, StringSplitOptions.RemoveEmptyEntries);
+		return GetSchema(tmp);
+	}
+
+	/// <summary>
+	/// Encodes a schemas enum to a string formatted as an enumerable XML attribute.
+	/// </summary>
+	/// <param name="versions">The versions enum to convert to XML attribute encoding</param>
+	/// <returns>the encoded string</returns>
+	public static string EncodeAsXmlSchemasAttribute(this IfcSchemaVersions versions)
+	{
+		List<string> schemas = new();
+		if (versions.HasFlag(IfcSchemaVersions.Ifc2x3))
+			schemas.Add(IfcSchema2x3String);
+		if (versions.HasFlag(IfcSchemaVersions.Ifc4))
+			schemas.Add(IfcSchema4String);
+		if (versions.HasFlag(IfcSchemaVersions.Ifc4x3))
+			schemas.Add(IfcSchema4x3String);
+		return string.Join(" ", schemas);
+	}
+
+	/// <summary>
+	/// Makes it easy to use the <see cref="SchemaInfo.TryGetSchemaInformation(IfcSchemaVersions, out IEnumerable{SchemaInfo})"/> directly from a schema enum.
+	/// </summary>
+	/// <param name="schemas">the enum to evaluate</param>
+	/// <param name="schemaInfo">the identified schema infos</param>
+	/// <returns>true if the values are matched</returns>
 	public static bool TryGetSchemaInformation(this IfcSchemaVersions schemas, out IEnumerable<SchemaInfo> schemaInfo)
     {
 		return SchemaInfo.TryGetSchemaInformation(schemas, out schemaInfo);

diff --git a/ids-lib/LibraryInformation.cs b/ids-lib/LibraryInformation.cs
@@ -32,6 +32,6 @@ public static class LibraryInformation
 		/// <summary>
 		/// Static field with hardcoded DLL version number. 
 		/// </summary>
-		public static string AssemblyVersion => "1.0.48";
+		public static string AssemblyVersion => "1.0.49";
 	}
 }
diff --git a/ids-lib/ids-lib.csproj b/ids-lib/ids-lib.csproj
@@ -20,7 +20,7 @@
 		<PackageReleaseNotes>First implementation.</PackageReleaseNotes>
 		<PackageReadmeFile>README.md</PackageReadmeFile>
 		<!-- Github actions are setup so that when this version is bumped the nuget package is uploaded -->
-		<AssemblyVersion>1.0.48</AssemblyVersion>
+		<AssemblyVersion>1.0.49</AssemblyVersion>
 		<FileVersion>$(AssemblyVersion)</FileVersion>
 		<Version>$(AssemblyVersion)</Version>
 		<GenerateDocumentationFile>true</GenerateDocumentationFile>

diff --git a/ids-tool/ids-tool.csproj b/ids-tool/ids-tool.csproj
@@ -16,7 +16,7 @@
 		<PackageIcon>icon.png</PackageIcon>
 		<PackageTags>IDS, buildingSmart</PackageTags>
 		<!-- Github actions are setup so that when this version is bumped the nuget package is uploaded -->
-		<AssemblyVersion>1.0.48</AssemblyVersion>
+		<AssemblyVersion>1.0.49</AssemblyVersion>
 		<FileVersion>$(AssemblyVersion)</FileVersion>
 		<Version>$(AssemblyVersion)</Version>
 		<RepositoryUrl>https://github.com/buildingSMART/IDS-Audit-tool.git</RepositoryUrl>