ContainerExtensions Class
Defines extension methods on IContainer for registering services used to work with Flags which describe the quality of data along a time series.
public static class ContainerExtensionsInheritance System.Object 🡒 ContainerExtensions
Methods
Section titled “Methods”ContainerExtensions.UseCustomFlag(this IContainer, byte, int, string) Method
Section titled “ContainerExtensions.UseCustomFlag(this IContainer, byte, int, string) Method”Registers additional information that is mapped to all Flags with the specified flagValue. This allows for flags with that value to have their priority be respected properly during calculations and aggregations. Whenever possible Flags with that value will also be displayed using the given name instead of just its value.
public static HAKOM.DependencyInjection.Core.Net.Api.IContainer UseCustomFlag(this HAKOM.DependencyInjection.Core.Net.Api.IContainer container, byte flagValue, int priority, string name);Parameters
Section titled “Parameters”container IContainer
The container to register custom flag information with.
flagValue System.Byte
The value to register.
priority System.Int32
The priority to assign to the Flag with value flagValue.
name System.String
The friendly name to assign to the Flag with value flagValue.
Returns
Section titled “Returns”IContainer
The container itself for chaining.
ContainerExtensions.UseCustomFlag(this IContainer, Flag, int, string) Method
Section titled “ContainerExtensions.UseCustomFlag(this IContainer, Flag, int, string) Method”Registers a custom Flag which allows for its priority to be respected during calculations and aggregations. Whenever possible it will also be displayed using the given name instead of just its value.
public static HAKOM.DependencyInjection.Core.Net.Api.IContainer UseCustomFlag(this HAKOM.DependencyInjection.Core.Net.Api.IContainer container, HAKOM.TSM.Net.Api.Flags.Flag flag, int priority, string name);Parameters
Section titled “Parameters”container IContainer
The container to register the custom Flag with.
flag Flag
The Flag to register.
priority System.Int32
The priority to assign to the flag.
name System.String
The friendly name to assign to the flag.
Returns
Section titled “Returns”IContainer
The container itself for chaining.
ContainerExtensions.UseDefaultFlags(this IContainer) Method
Section titled “ContainerExtensions.UseDefaultFlags(this IContainer) Method”Registers priorities and names of flags commonly used by HAKOM.
public static HAKOM.DependencyInjection.Core.Net.Api.IContainer UseDefaultFlags(this HAKOM.DependencyInjection.Core.Net.Api.IContainer container);Parameters
Section titled “Parameters”container IContainer
The container to register the IFlagPriorityProvider with.
Returns
Section titled “Returns”IContainer
The container itself for chaining.
Remarks
Section titled “Remarks”The following flags are commonly used by HAKOM:
| Flag Value | Flag Priority | Flag Name (Locale: en) |
|---|---|---|
| 0 | 0 | Ignore |
| 5 | 20 | ManuallyReplaced |
| 7 | 60 | Faulty |
| 9 | 30 | Valid |
| 12 | 40 | Scheduled |
| 19 | 80 | Missing |
| 20 | 10 | Accounted |
| 21 | 50 | Estimated |
| 22 | 70 | Interpolated |
ContainerExtensions.UseFlagNames(this IContainer) Method
Section titled “ContainerExtensions.UseFlagNames(this IContainer) Method”Registers the default IFlagNameProvider with the container. This allows components to display a friendly name for Flags.
public static HAKOM.DependencyInjection.Core.Net.Api.IContainer UseFlagNames(this HAKOM.DependencyInjection.Core.Net.Api.IContainer container);Parameters
Section titled “Parameters”container IContainer
Returns
Section titled “Returns”IContainer
The container for chaining.
Exceptions
Section titled “Exceptions”System.ArgumentNullException
Thrown if container is null.
ContainerExtensions.UseFlagPriorities(this IContainer) Method
Section titled “ContainerExtensions.UseFlagPriorities(this IContainer) Method”Registers the default IFlagPriorityProvider with the container. This allows components to correctly rank and aggregate ITimeSeriesData<TValue> instances.
public static HAKOM.DependencyInjection.Core.Net.Api.IContainer UseFlagPriorities(this HAKOM.DependencyInjection.Core.Net.Api.IContainer container);Parameters
Section titled “Parameters”container IContainer
Returns
Section titled “Returns”IContainer
The container for chaining.
Exceptions
Section titled “Exceptions”System.ArgumentNullException
Thrown if container is null.