SimulationClient

Namespace: AVEVA.IntegrationService.DataAPI.SDK.ApiClient

Interface: ISimulationClient

Description

SimulationClient is used to communicate with Simulation ProductCategory products, supporting both SimCentral and ProII simulations.

Methods

GetSimCentralSimulations

Retrieves list of simulations (metadata only, not entire data).

Signature:

Task<List<Simulation>> GetSimCentralSimulations(string dataSourceName)

Example:

using AVEVA.IntegrationService.DataAPI.SDK.ApiClient;

using AVEVA.IntegrationService.DataAPI.SDK.Models.SimulationData;

// Create the Simulation client

string host = "https://your-server/integration/v1";

string token = "your-access-token";

var simulationClient = DataApiClientFactory.CreateDataApiClient<SimulationClient>(

host: host,

authType: AuthenticationType.Connect,

waitingTimeInMinutesForLiveData: 60,

token: token,

hubCancellationToken: null

);

// Get all simulations

List<Simulation> simulations = await simulationClient.GetSimCentralSimulations(

"MySimulationDataSource"

);

foreach (var sim in simulations)

{

Console.WriteLine($"Simulation: {sim.Name}, ID: {sim.Id}");

}

GetSimCentralSnapshots

Retrieves list of snapshot names under a specific simulation.

Signature:

Task<List<string>> GetSimCentralSnapshots(string dataSourceName, string simulationName)

Example:

List<string> snapshots = await simulationClient.GetSimCentralSnapshots(

"MySimulationDataSource",

"ProcessSimulation1"

);

foreach (string snapshot in snapshots)

{

Console.WriteLine($"Snapshot: {snapshot}");

}

GetSimCentralSchema

Retrieves schema of a given simulation snapshot.

Signature:

Task<DataSet> GetSimCentralSchema(string dataSourceName, string simulationName, string snapshotName)

Example:

DataSet schema = await simulationClient.GetSimCentralSchema(

"MySimulationDataSource",

"ProcessSimulation1",

"Snapshot_2024_01_15"

);

// Examine schema structure

foreach (DataTable table in schema.Tables)

{

Console.WriteLine($"Table: {table.TableName}");

foreach (DataColumn col in table.Columns)

{

Console.WriteLine($" Column: {col.ColumnName} ({col.DataType})");

}

}

GetSimCentralData

Retrieves data for a given snapshot and simulation.

Signature:

Task<DataSet> GetSimCentralData(string dataSourceName, string simulationName, string snapshotName)

Example:

DataSet simulationData = await simulationClient.GetSimCentralData(

"MySimulationDataSource",

"ProcessSimulation1",

"Snapshot_2024_01_15"

);

// Process simulation data

foreach (DataTable table in simulationData.Tables)

{

Console.WriteLine($"Processing table: {table.TableName}");

Console.WriteLine($"Row count: {table.Rows.Count}");

}

GetProIISimulations

Retrieves ProII simulations data.

Signature:

Task<List<Simulation>> GetProIISimulations(string dataSourceName)

Example:

List<Simulation> proIISimulations = await simulationClient.GetProIISimulations(

"MyProIIDataSource"

);

foreach (var sim in proIISimulations)

{

Console.WriteLine($"ProII Simulation: {sim.Name}");

}

GetProIISnapshots

Retrieves ProII snapshot names.

Signature:

Task<List<string>> GetProIISnapshots(string dataSourceName, string simulationName)

Example:

List<string> proIISnapshots = await simulationClient.GetProIISnapshots(

"MyProIIDataSource",

"ProIISimulation1"

);

GetProIISchema

Retrieves ProII simulation schema.

Signature:

Task<DataSet> GetProIISchema(string dataSourceName, string simulationName, string snapshotName)

Example:

DataSet proIISchema = await simulationClient.GetProIISchema(

"MyProIIDataSource",

"ProIISimulation1",

"Snapshot1"

);

GetProIIData

Retrieves ProII simulation data.

Signature:

Task<DataSet> GetProIIData(string dataSourceName, string simulationName, string snapshotName)

Example:

DataSet proIIData = await simulationClient.GetProIIData(

"MyProIIDataSource",

"ProIISimulation1",

"Snapshot1"

);