Release 05/03/2024

Author: martin1cerny

.gitignore

@@ -2,6 +2,40 @@
 
 All notable changes to this project should be documented in this file
 
+## [v6.0] Pending Release
+
+This is the 6.0 release of XBIM Toolkit
+### Added
+
+- Added net6.0 support to all Essentials components (including Esent) [#432](https://github.com/xBimTeam/XbimEssentials/issues/432) [#451](https://github.com/xBimTeam/XbimEssentials/issues/451)
+- Added Common units to new projects
+- Docs are automatically generated with each build [#449](https://github.com/xBimTeam/XbimEssentials/issues/449) [#457](https://github.com/xBimTeam/XbimEssentials/issues/457)
+- Support for IFC 4x3 schema [#450](https://github.com/xBimTeam/XbimEssentials/issues/450)
+- Added support for Dependency Injection of services, with internal services provider [#455](https://github.com/xBimTeam/XbimEssentials/issues/455)
+	- See [Tests for examples](https://github.com/xBimTeam/XbimEssentials/blob/develop/Tests/DependencyInjectionTests.cs)
+- Optimisation to Esent SaveAs
+
+### Fixed
+- Fixed Instances Count on Esent Models
+- Fix in Parser for G17 formatatting on Double values
+- Fix incorrect Application Developer Name [#466]
+- Fix Memory leak in SI Units [#361](https://github.com/xBimTeam/XbimEssentials/issues/361)
+
+### Changed
+- Removed need to call `IfcStore.ModelProviderFactory.UseHeuristicModelProvider();` before using IfcStore. 
+	- Replaced with optional call to `XbimServices.ConfigureServices(s => s.AddXbimToolkit(opt => opt.AddHeuristicModel()));` ... and equivalent.
+- ModelProviderFactory replaced by standard DI / service Provider. 
+- IfcStore.ModelProvider deprecated
+- Methods accepting ILogger parameters deprecated - Loggers can be injected (if using DI) or are provided by the XbimServices ServiceProvider
+
+### Removed
+
+- Removed static Xbim.Commom.XbimLogger - replaced with a DI friendly internal service provide Logger functionality when needed [#455](https://github.com/xBimTeam/XbimEssentials/issues/455)
+- Removed support for .NET Framework targets prior to net472 - now out of support by Microsoft
+- Removed targeting of .NET 3.1 (Out of support, but can still be used via netstandard2.0)
+- Removed Default Microsoft.Extensions.Logging implementation - now requires explicit setup via Xbim.Common.Configuration.XbimServices
+
+
 ## [v5.1.527] 2019-05-30
 
 This is the 5.1 release of XBIM

CHANGELOG.md

@@ -6,24 +6,24 @@
     <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
     <GenerateDocumentationFile Condition=" '$(IsTestProject)' != 'true' ">true</GenerateDocumentationFile>
     <NoWarn>CS1591</NoWarn>
+    <LangVersion>latest</LangVersion>
   </PropertyGroup>
 
   <PropertyGroup>
-    <Version>5.1.0.0</Version>
+    <Version>6.0.0.0</Version>
     <Copyright>Copyright © XBIM Ltd</Copyright>
     <Company>Xbim Ltd.</Company>
     <Authors>Steve Lockley, Martin Cerny and XBIMTeam Contributors</Authors>
     <Product>XBIM Essentials</Product>
 	  <PackageLicenseExpression>CDDL-1.0</PackageLicenseExpression>
     <PackageProjectUrl>https://github.com/xBimTeam/XbimEssentials</PackageProjectUrl>
 	  <PackageIcon>xbim-toolkit-icon.png</PackageIcon>
-    <PackageReleaseNotes>Version 5.1 update. See https://github.com/xBimTeam/XbimEssentials/blob/master/CHANGELOG.md
+    <PackageReleaseNotes>Version 6.0 update. See https://github.com/xBimTeam/XbimEssentials/blob/master/CHANGELOG.md
     </PackageReleaseNotes>
     <PackageTags>BIM, IFC, IfcXml, IfcZip, Ifc4, COBie, BuildingSmart</PackageTags>
     <RepositoryUrl>https://github.com/xBimTeam/XbimEssentials/tree/master</RepositoryUrl>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-    <SuppressNETCoreSdkPreviewMessage>true</SuppressNETCoreSdkPreviewMessage>
     <SignAssembly>true</SignAssembly>   
     <AssemblyOriginatorKeyFile>..\XbimOpenSourceKeyFile.snk</AssemblyOriginatorKeyFile>   
     <DelaySign>false</DelaySign>

Directory.Build.props

@@ -20,16 +20,10 @@ _[**B**uilding **I**nformation **M**odelling](https://en.wikipedia.org/wiki/Buil
 the .NET platform. This library enables software developers to easily read, write, validate and interrogate data in 
 the buildingSmart [IFC formats](https://en.wikipedia.org/wiki/Industry_Foundation_Classes), using any .NET language. 
 
-As of version 5.0 XbimEssentials includes elementary support for .NET Core 2.0 in addition .NET Framework.
-Support for Net Core 3.1 is added
-## Updating from prior versions
+As of version 6.0 XbimEssentials includes support for `.netstandard2.0`, `.netstandard2.1` and `.net6.0`. Supporting `netstandard2.0` provides support .NET Framework 4.7.2 upwards. 
+Earlier .NET Framewaork versions may work, but we can't provide any support for them.
 
-Please see our [ChangeLog](CHANGELOG.md) for details on what's new and what you need to upgrade. 
-In particular, please **note the following section copied here:**
 
-> **BREAKING CHANGE**: Windows forms and Console apps using *IfcStore* must now call `IfcStore.ModelProviderFactory.UseHeuristicModelProvider();` at application startup
->
-> [failure to do so] will likely result in use of the very basic `MemoryModel` implementation which does not support *.xbim* files
 
 ## Background / Motivation ##
 
@@ -46,9 +40,25 @@ The wider XBIM toolkit contains additional repositories with libraries to read a
 In order to visualise 3D Geometries you will need to include the [Xbim.Geometry](https://github.com/xBimTeam/XbimGeometry) 
 package which provides full support for geometric, topological operations and visualisation.
 
-The motivation behind XbimEssentials is to take away much of the complexity and 'heavy lifting' required to work 
-with Open BIM file formats, so you can focus on creating software solutions without needing deep understanding 
-of STEP/Express parsing, 3D graphics, allowing you to work at a higher level than the buildingSmart [data model](http://www.buildingsmart-tech.org/ifc/IFC4/Add2/html/link/introduction.htm). 
+The motivation behind XbimEssentials is to take away much of the complexity and 'heavy lifting' required to read and write 
+OpenBIM file formats, so you can focus on creating software solutions without needing deep understanding 
+of STEP/Express parsing, 3D graphics - enabling you to work at a higher level than the buildingSmart [data model](http://www.buildingsmart-tech.org/ifc/IFC4/Add2/html/link/introduction.htm). 
+
+
+## Updating from prior versions
+
+Please see our [ChangeLog](CHANGELOG.md) for details on what's new and what you need to upgrade. 
+In particular, please **note the following section copied here:**
+
+> **BREAKING CHANGE**: V6 implements a new mechanism for discovering internal resources and uses standard (.net Dependency Injection patterns)[https://learn.microsoft.com/en-us/dotnet/core/extensions/dependency-injection] for managing services internally.
+> `Xbim.Common` now introduces an internal DI service that you can optionally integrate with your own DI implementation, for providing Logging services, and configuring xbim service behaviour. E.g. Invoking:
+> ` XbimServices.Current.ConfigureServices(s => s.AddXbimToolkit(opt => opt.UseMemoryModel().UseLoggerFactory(yourloggerFactory)));
+> registers the Toolkit internal dependencies, uses an In-memory model and inserts your configured ILoggerFactory into the service in place of our default one.
+> `IfcStore.ModelProviderFactory` has been deprecated as this is provided for by the above mechanism
+> The persistent EsentModel is now available automatically through IfcStore (on Windows) so there is no need for the `UseHeuristicModelProvider()` 'ceremony' to ensure Esent is used.
+> Note: The default Logging implementation has been removed from Toolkit to reduce the amount of dependencies. To enable is a simple matter of adding logging to the Xbim Services. 
+> See (Example)[https://github.com/xBimTeam/XbimEssentials/blob/b3fce6f40a31fb87a75b24888a4e20740a378e31/Tests/DependencyInjectionTests.cs#L96]
+
 
 ## Code Examples
 
@@ -179,9 +189,6 @@ using [Xbim.WebUI](http://docs.xbim.net/XbimWebUI/)
 const string fileName = @"SampleHouse4.ifc";
 var wexBimFilename = Path.ChangeExtension(fileName, "wexBIM");
 var xbimDbFilename = Path.ChangeExtension(fileName, "xBIM");
-
-// Make sure we are using an IModel implementation that supports saving of '.xbim' files
-IfcStore.ModelProviderFactory.UseHeuristicModelProvider();
 
 using (var model = IfcStore.Open(fileName))
 {