LC.Runtime 0.1.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package LC.Runtime --version 0.1.1                
NuGet\Install-Package LC.Runtime -Version 0.1.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="LC.Runtime" Version="0.1.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add LC.Runtime --version 0.1.1                
#r "nuget: LC.Runtime, 0.1.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install LC.Runtime as a Cake Addin
#addin nuget:?package=LC.Runtime&version=0.1.1

// Install LC.Runtime as a Cake Tool
#tool nuget:?package=LC.Runtime&version=0.1.1                

What is LC.Runtime?

LC.Runtime is a .NET Standard 2.0 (C#) utility to programmatically create an instance of a software backend class from a C# software executable or DLL implementing a desired public class or interface.

Previous Versions

LabCognition.Interface 1.2.0

LC.Runtime superseeds parts of LabCognition.Interface. Interfaces and methods used in LabCognition.Interface have been revised, renamed and extracted into LC.Runtime.

Here is a matrix depicting the changes:

LabCognition.Interface (1.2.0) LC.Runtime (0.1.0) Action
IPredictionEngineFactory IPredictorFactory interface renamed and enhanced
InstanceFactory class InstanceFactory class moved
MsiApi class MsiApi class moved
MsiConfig class MsiConfig class moved and enhanced to support external configuration file
Plugin class Plugin class moved
KnownMsi list KnownMsi list Change handling by reading list from json MsiConfig.config file

Why using LC.Runtime?

Using the LabCognition software suite in 3rd party applications, you must create an instance of the software or one of its public classes to programatically access its features. The utility features provided herein allow to create such instance.

Available Features for the Client Software

Available methods either work on a C# DLL or a C# application executable file implementing the desired public class or interface.

An instance of the class implementing the interface in the backend software is created and returned during runtime of a client software.

How is the Instance created?

The instance of the class containing the desired interface is created using the Create method. Depending on the input string the instance is created using the options below in the given order. In case an option fails, the next in the list is applied.

By a given application executable path

Call the Create method with a fully qualified path to the predictor software executable file

Example:

ITargetInterface softwareInterface = Create(@"c:\Program Files (x86)\Software\MySoftware.exe");

TargetClass softwareClass = Create(@"c:\Program Files (x86)\Software\MySoftware.exe");

By Software Upgrade Code

Product code and upgrade code are GUIDs typically used when installing software on a Windows computer. The upgrade code and the executable file name are used to lookup in the Windows registry for matching installed applications. Both can be handled by the Create method. The input string in this case consists of both in formation using the pipe ('|') symbol as separator.

Example: Using LabCognition's Panorama software

ITargetInterface softwareInterface = Create(@"{89774630-f0ed-4e55-a49c-0fc148754ac5}|Panorama.exe");

TargetClass softwareClass = Create(@"{89774630-f0ed-4e55-a49c-0fc148754ac5}|Panorama.exe");

By an external MsiConfig.Config File

Alternatively, pairs consisting of upgrade code and software executable name formatted as described above can be provided in a file named MsiConfig.config. Such file is assumed to be located in the calling software executable's folder by default.

Example: MsiConfig.config file

[
    { "ProductCode":"productCode A", "ExecutableFileName":"executable A"},
    { "ProductCode":"productCode B", "ExecutableFileName":"executable B"}
]

You may also define a custom location by changing the ConfigPath property. Use the Create method with empty string input to force this option to be used.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.1.2 141 7/24/2024
0.1.1 161 3/7/2024
0.1.0 389 8/11/2021

ReleaseNotes.md