AxelSemrau.Chronos.Plugin.Helpers Class Reference

Static instance for access to utility functions and resources. More...

Properties
static Version	ApiVersion = new(1,5,0) [get]
	From Chronos 5.2 on: A plugin API version you can check if you want to give understandable error messages in case of mismatch. This is NOT the Chronos version, and it is incremented in the sense of semantic versioning:
static IGuiHelper	Gui [get, set]
	Utility functions for window handling.
static IDebugHelper	Debug [get, set]
	Utility functions for debugging.
static IConfigInfo	Config [get, set]
	Information about general program configuration, standard folders and similar.
static IEnumerable< IDeviceInfo >	Devices [get, set]
static IUtilityFactories	UtilityFactories [get, set]
	Helper class factories, see the members for details.
static IStorageInspector	Storage [get, set]
	Inspect stored data like methods...
static IConsumables	Consumables [get, set]
	Access to consumables managers, if they are present.
static ILicenseChecker	LicenseChecker [get, set]
	Helps optional Chronos components understand their environment.
static ResourceDictionary	WpfResources = new ChronosResources() [get]
	Resources for WPF controls that should make it easier to keep a common look and feel.
static IEnumerable< IAcquisitionServiceBase >	AcquisitionServices [get, set]
	Available acquisition service instances.
static ILoadPathExtender	LoadPathExtender [get, set]
	Helps to deal with assemblies in different locations.
static ISecurity	Security [get, set]
	Gives access to security related functions.

Detailed Description

Static instance for access to utility functions and resources.

Definition at line 78 of file Helpers.cs.

Property Documentation

AcquisitionServices

IEnumerable<IAcquisitionServiceBase> AxelSemrau.Chronos.Plugin.Helpers.AcquisitionServices

staticgetset

Available acquisition service instances.

Definition at line 145 of file Helpers.cs.

{ get; internal set; }

ApiVersion

Version AxelSemrau.Chronos.Plugin.Helpers.ApiVersion = new(1,5,0)

staticget

From Chronos 5.2 on: A plugin API version you can check if you want to give understandable error messages in case of mismatch. This is NOT the Chronos version, and it is incremented in the sense of semantic versioning:

• Major = Breaking changes
• Minor = New feature
• Build = Only bugfixes, no API change.

Definition at line 88 of file Helpers.cs.

{ get; } = new(1,5,0);

Config

IConfigInfo AxelSemrau.Chronos.Plugin.Helpers.Config

staticgetset

Information about general program configuration, standard folders and similar.

summary> Information about configured devices and their states /summary>

Definition at line 103 of file Helpers.cs.

{ get; internal set; }

Referenced by MockPlugin.Tasks.DumpConfigInfo.Execute().

Consumables

IConsumables AxelSemrau.Chronos.Plugin.Helpers.Consumables

staticgetset

Access to consumables managers, if they are present.

Definition at line 126 of file Helpers.cs.

{ get; internal set; }

Debug

IDebugHelper AxelSemrau.Chronos.Plugin.Helpers.Debug

staticgetset

Utility functions for debugging.

Definition at line 98 of file Helpers.cs.

{ get; internal set; }

Referenced by MockPlugin.Misc.MockLicenseCheckAttribute.CheckLicense(), MockPlugin.Consumables.CoffeeConsumableManager.CoffeeConsumableManager(), and MockPlugin.SampleList.MockSampleListWorker.DoYourJob().

Devices

IEnumerable<IDeviceInfo> AxelSemrau.Chronos.Plugin.Helpers.Devices

staticgetset

Definition at line 108 of file Helpers.cs.

{ get; internal set; }

Gui

IGuiHelper AxelSemrau.Chronos.Plugin.Helpers.Gui

staticgetset

Utility functions for window handling.

Definition at line 93 of file Helpers.cs.

{ get; internal set; }

Referenced by MockPlugin.Tasks.ShowSomeGreeting.DemoExecute(), MockPlugin.SampleList.MockSampleListWorker.DoYourJob(), MockPlugin.Tasks.JobInspectionDemo.Execute(), MockPlugin.Tasks.ShowSomeGreeting.Execute(), MockPlugin.SampleList.MockSampleListWorker.HandleAbortButton(), MockPlugin.SampleList.MockSampleListWorker.HandleStopButton(), MockPlugin.SampleList.MockSampleListWorker.MockSampleListWorker(), MockPlugin.Tasks.ShowSomeGreeting.PostValidate(), MockPlugin.Tasks.JobInspectionDemo.PreValidate(), and MockPlugin.Tasks.ShowSomeGreeting.PreValidate().

LicenseChecker

ILicenseChecker AxelSemrau.Chronos.Plugin.Helpers.LicenseChecker

staticgetset

Helps optional Chronos components understand their environment.

Definition at line 131 of file Helpers.cs.

{ get; internal set; }

LoadPathExtender

ILoadPathExtender AxelSemrau.Chronos.Plugin.Helpers.LoadPathExtender

staticgetset

Helps to deal with assemblies in different locations.

Definition at line 149 of file Helpers.cs.

{ get; internal set; }

Security

ISecurity AxelSemrau.Chronos.Plugin.Helpers.Security

staticgetset

Gives access to security related functions.

Definition at line 153 of file Helpers.cs.

{ get; internal set; }

Storage

IStorageInspector AxelSemrau.Chronos.Plugin.Helpers.Storage

staticgetset

Inspect stored data like methods...

To be extended on demand.

Definition at line 121 of file Helpers.cs.

{ get; internal set; }

UtilityFactories

IUtilityFactories AxelSemrau.Chronos.Plugin.Helpers.UtilityFactories

staticgetset

Helper class factories, see the members for details.

Definition at line 113 of file Helpers.cs.

{ get; internal set; }

Referenced by MockPlugin.Misc.MockLicenseCheckAttribute.CheckLicense().

WpfResources

ResourceDictionary AxelSemrau.Chronos.Plugin.Helpers.WpfResources = new ChronosResources()

staticget

Resources for WPF controls that should make it easier to keep a common look and feel.

You should add this in the constructor of your WPF elements to the Resources.MergedDictionaries. Do not refer to this using a pack:// URI, this can cause problems during debugging and will miss runtime updates.

Definition at line 139 of file Helpers.cs.

{ get; } = new ChronosResources();

---

The documentation for this class was generated from the following file:

• Helpers.cs