Interface IInfoEngine

Interface IInfoEngine

Namespace: Unity.Industrial.Forma.Core.Info

Syntax

[MovedFrom(true, "UnityEngine.Industrial.Configuring.Providers", "Unity.Industrial.Configurator", null)]
public interface IInfoEngine

Methods

Initialize(Configurator)

Initializes the InfoEngine

Declaration

void Initialize(Configurator configurator)

Parameters

Type	Name	Description
Configurator	configurator	The configurator.

OnContextModified(Context, InfoEngineOperation)

Handles modification to Context

Declaration

SynchronousProviderOperation<InfoEngineReply> OnContextModified(Context context, InfoEngineOperation operation)

Parameters

Type	Name	Description
Context	context	The context.
InfoEngineOperation	operation	The operation.

Returns

Type	Description
SynchronousProviderOperation<InfoEngineReply>	SynchronousProviderOperation<InfoEngineReply>.

Remarks

This is an asynchronous call that returns a handle of type ProviderOperation{InfoEngineReply}. For some implementations, it may be that the call is effectively synchronous and the handle already contains the result. Check if ProviderOperation{T}.isDone is

true

after calling this method if this is the case. Note that in the synchronous case the event ProviderOperation{T}.Completed is not raised.

OnFeatureModified(Feature, InfoEngineOperation)

Handles modification to Feature

Declaration

SynchronousProviderOperation<InfoEngineReply> OnFeatureModified(Feature feature, InfoEngineOperation operation)

Parameters

Type	Name	Description
Feature	feature	The feature.
InfoEngineOperation	operation	The operation.

Returns

Type	Description
SynchronousProviderOperation<InfoEngineReply>	SynchronousProviderOperation<InfoEngineReply>.

Remarks

This is an asynchronous call that returns a handle of type ProviderOperation{InfoEngineReply}. For some implementations, it may be that the call is effectively synchronous and the handle already contains the result. Check if ProviderOperation{T}.isDone is

true

after calling this method if this is the case. Note that in the synchronous case the event ProviderOperation{T}.Completed is not raised.

OnFeatureSetModified(FeatureSet, InfoEngineOperation)

Handles modification to FeatureSet

Declaration

SynchronousProviderOperation<InfoEngineReply> OnFeatureSetModified(FeatureSet featureSet, InfoEngineOperation operation)

Parameters

Type	Name	Description
FeatureSet	featureSet	The feature set.
InfoEngineOperation	operation	The operation.

Returns

Type	Description
SynchronousProviderOperation<InfoEngineReply>	SynchronousProviderOperation<InfoEngineReply>.

Remarks

This is an asynchronous call that returns a handle of type ProviderOperation{InfoEngineReply}. For some implementations, it may be that the call is effectively synchronous and the handle already contains the result. Check if ProviderOperation{T}.isDone is

true

after calling this method if this is the case. Note that in the synchronous case the event ProviderOperation{T}.Completed is not raised.

OnProductModified(Product, InfoEngineOperation)

Handles modification to Product

Declaration

SynchronousProviderOperation<InfoEngineReply> OnProductModified(Product product, InfoEngineOperation operation)

Parameters

Type	Name	Description
Product	product	The product.
InfoEngineOperation	operation	The operation.

Returns

Type	Description
SynchronousProviderOperation<InfoEngineReply>	SynchronousProviderOperation<InfoEngineReply>.

Remarks

This is an asynchronous call that returns a handle of type ProviderOperation{InfoEngineReply}. For some implementations, it may be that the call is effectively synchronous and the handle already contains the result. Check if ProviderOperation{T}.isDone is

true

after calling this method if this is the case. Note that in the synchronous case the event ProviderOperation{T}.Completed is not raised.

QueryContextCollectionDisplayInfo(Context, ContextCollection)

Queries display information of a context collection.

Declaration

ProviderOperation<InfoEngineReply<ContextCollection, ContextCollectionDisplayInfo>> QueryContextCollectionDisplayInfo(Context currentContext, ContextCollection contextCollection)

Parameters

Type	Name	Description
Context	currentContext	currently selected context
ContextCollection	contextCollection	The context collection.

Returns

Type	Description
ProviderOperation<InfoEngineReply<ContextCollection, ContextCollectionDisplayInfo>>	ProviderOperation<InfoEngineReply<ContextCollection, ContextCollectionDisplayInfo>>.

Remarks

This is an asynchronous call that returns a handle of type ProviderOperation{InfoEngineReply{ContextCollection, ContextCollectionDisplayInfo}}. For some implementations, it may be that the call is effectively synchronous and the handle already contains the result. Check if isDone is

true

after calling this method if this is the case. Note that in the synchronous case the event ProviderOperation{T}.Completed is not raised.

QueryFeatureDisplayInfo(Context, Feature)

Queries display information of a feature.

Declaration

ProviderOperation<InfoEngineReply<Feature, FeatureDisplayInfo>> QueryFeatureDisplayInfo(Context currentContext, Feature feature)

Parameters

Type	Name	Description
Context	currentContext	currently selected context
Feature	feature	The feature.

Returns

Type	Description
ProviderOperation<InfoEngineReply<Feature, FeatureDisplayInfo>>	ProviderOperation<InfoEngineReply<Feature, FeatureDisplayInfo>>.

Remarks

This is an asynchronous call that returns a handle of type ProviderOperation{InfoEngineReply{Feature, FeatureDisplayInfo}}. For some implementations, it may be that the call is effectively synchronous and the handle already contains the result. Check if ProviderOperation{T}.isDone is

true

after calling this method if this is the case. Note that in the synchronous case the event ProviderOperation{T}.Completed is not raised.

QueryFeatureSetDisplayInfo(Context, FeatureSet)

Queries display information of a feature set.

Declaration

ProviderOperation<InfoEngineReply<FeatureSet, FeatureSetDisplayInfo>> QueryFeatureSetDisplayInfo(Context currentContext, FeatureSet featureSet)

Parameters

Type	Name	Description
Context	currentContext	currently selected context
FeatureSet	featureSet	The feature set.

Returns

Type	Description
ProviderOperation<InfoEngineReply<FeatureSet, FeatureSetDisplayInfo>>	ProviderOperation<InfoEngineReply<FeatureSet, FeatureSetDisplayInfo>>.

Remarks

This is an asynchronous call that returns a handle of type ProviderOperation{InfoEngineReply{FeatureSet, FeatureSetDisplayInfo}}. For some implementations, it may be that the call is effectively synchronous and the handle already contains the result. Check if ProviderOperation{T}.isDone is

true

after calling this method if this is the case. Note that in the synchronous case the event ProviderOperation{T}.Completed is not raised.

QueryProductInfo(Product)

Queries display information of the product

Declaration

ProviderOperation<InfoEngineReply<Product, ProductDisplayInfo>> QueryProductInfo(Product product)

Parameters

Type	Name	Description
Product	product	The product.

Returns

Type	Description
ProviderOperation<InfoEngineReply<Product, ProductDisplayInfo>>	ProviderOperation<InfoEngineReply<Product, ProductDisplayInfo>>.

Remarks

This is an asynchronous call that returns a handle of type ProviderOperation{InfoEngineReply}. For some implementations, it may be that the call is effectively synchronous and the handle already contains the result. Check if ProviderOperation{T}.isDone is

true

after calling this method if this is the case. Note that in the synchronous case the event ProviderOperation{T}.Completed is not raised.

RecordUndo(String)

Records undo information

Declaration

void RecordUndo(string change)

Parameters

Type	Name	Description
String	change	The change.

SaveData()

Tells IInfoEngine to save the data.

Declaration

void SaveData()

Extension Methods

InfoEngineExtensions.GetProductInfo(IInfoEngine, Product, Action<ProductDisplayInfo>)

InfoEngineExtensions.GetContextCollectionInfo(IInfoEngine, Context, ContextCollection, Action<ContextCollectionDisplayInfo>)

InfoEngineExtensions.GetContextCollectionOptionValues(IInfoEngine, String, ContextCollection, Action<ContextCollectionDisplayInfo.ContextCollectionKeyDisplayInfo>)

InfoEngineExtensions.GetFeatureSetInfo(IInfoEngine, Context, FeatureSet, Action<FeatureSetDisplayInfo>)

InfoEngineExtensions.GetFeatureInfo(IInfoEngine, Context, Feature, Action<FeatureDisplayInfo>)