Class Context
A context is a key-value store that defines the basis on which configurations are interpreted. The Configurator project usually contains a complete dataset (150% model) for each Product, which includes variants available under very different conditions. and in different markets (e.g. a right-hand drive steering wheel and a left-hand drive steering wheel). It may even cover multiple product lines (e.g. sedan and convertible). The initial state of the product (the default) cannot therefore be unique under all circumstances, being influenced by several factors, such as the product market, the product line and other features (engine type, transmission, fuel type, etc.) The context is a selection of such features (e.g. active line, 5 doors, 1.3cc engine, petrol, manual transmission) that uniquely identifies a subset of the product. It then becomes possible to create multiple default configurations by linking them to different contexts.
Inherited Members
Namespace: UnityEngine.Industrial.Configuring.Core
Syntax
[ExecuteInEditMode]
public class Context : MonoBehaviourProperties
contextCollection
Context collection which contains this context.
Declaration
public ContextCollection contextCollection { get; }Property Value
| Type | Description |
|---|---|
| ContextCollection | The context collection. |
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | The context is not part of a context collection: it is not child of a game object with a ContextCollection component. |
entries
Key-value entries of this context.
Declaration
public IReadOnlyDictionary<string, string> entries { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyDictionary<String, String> | The entries. |
Methods
AddValue(String, String)
Sets the value for the given key.
Declaration
public void AddValue(string key, string value)Parameters
| Type | Name | Description |
|---|---|---|
| String | key | The key. |
| String | value | The value. |
Remarks
The key must be part of keys. The value must not be
nullExceptions
| Type | Condition |
|---|---|
| ArgumentException | The key must not be null or only contain whitespaces. |
| ArgumentException | The value must not be empty. |
| ArgumentException | The key {key} is not part of the key set of the context collection. |
| ArgumentNullException | The value must not be null. Use RemoveValue to remove the value. |
| ArgumentException | The key must not be null or only contain whitespaces. |
| ArgumentException | The value must not be empty. |
| ArgumentException | The key {key} is not part of the key set of the context collection. |
| ArgumentException | The value must not be null. Use RemoveValue to remove the value. |
Awake()
Awakes this instance.
Declaration
public void Awake()RemoveValue(String)
Removes the value from the context.
Declaration
public void RemoveValue(string key)Parameters
| Type | Name | Description |
|---|---|---|
| String | key | The key. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The key must not be null or only contain whitespaces. |
| ArgumentException | The key {key} is not part of the key set of the context collection. |
| ArgumentException | The key {key} is not set in the context. |
| ArgumentException | The key must not be null or only contain whitespaces. |
| ArgumentException | The key {key} is not part of the key set of the context collection. |
| ArgumentException | The key {key} is not set in the context. |
| ArgumentException | The key must not be null or only contain whitespaces. |
Events
contextChanged
Occurs when [context changed].
Declaration
public event ContextChangedHandler contextChangedEvent Type
| Type | Description |
|---|---|
| ContextChangedHandler |