Interface ISimulatorClient<T, V>

Namespace

Cognite.Simulator.Utils

Assembly

Cognite.Simulator.Utils.dll

Interface to be implemented by simulator integration clients that can execute simulation configuration of the type V

public interface ISimulatorClient<T, V> where T : ModelStateBase where V : SimulatorRoutineRevision

Type Parameters

T

Type of the model state object

V

Type of the simulation configuration object

Methods

ExtractModelInformation(T, CancellationToken)

Task ExtractModelInformation(T state, CancellationToken _token)

Parameters

state T

_token CancellationToken

Returns

Task

GetConnectorVersion()

string GetConnectorVersion()

Returns

string

GetSimulatorVersion()

string GetSimulatorVersion()

Returns

string

RunSimulation(T, V, Dictionary<string, SimulatorValueItem>)

Run a simulation by executing the routine passed as parameter with the given input data

Task<Dictionary<string, SimulatorValueItem>> RunSimulation(T modelState, V simulationConfiguration, Dictionary<string, SimulatorValueItem> inputData)

Parameters

modelState T

Model state object

simulationConfiguration V

Simulation configuration object

inputData Dictionary<string, SimulatorValueItem>

Input data

Returns

Task<Dictionary<string, SimulatorValueItem>>