Class SimulatorsExtensions

Namespace

Cognite.Simulator.Extensions

Assembly

Cognite.Simulator.Extensions.dll

Class containing extensions to the CDF Simulators resource with utility methods

public static class SimulatorsExtensions

Inheritance

object

SimulatorsExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

UpdateLogsBatch(SimulatorsResource, long, List<SimulatorLogDataEntry>, CancellationToken)

Updates the logs in chunks for a simulator resource.

public static Task UpdateLogsBatch(this SimulatorsResource cdfSimulators, long id, List<SimulatorLogDataEntry> items, CancellationToken token = default)

Parameters

cdfSimulators SimulatorsResource

The SimulatorsResource instance.

id long

The ID of the simulator log.

items List<SimulatorLogDataEntry>

The list of log data entries.

token CancellationToken

The cancellation token.

Returns

Task

The updated SimulatorsResource instance.

UpdateSimulatorModelRevisionData(SimulatorsResource, string, SimulatorModelRevisionDataFlowsheet, Dictionary<string, string>, CancellationToken)

Updates the simulation model revision data (general information, flowsheet) in CDF.

public static Task<SimulatorModelRevisionData> UpdateSimulatorModelRevisionData(this SimulatorsResource cdfSimulators, string modelRevisionExternalId, SimulatorModelRevisionDataFlowsheet flowsheet = null, Dictionary<string, string> info = null, CancellationToken token = default)

Parameters

cdfSimulators SimulatorsResource

The SimulatorsResource instance.

modelRevisionExternalId string

The externalId of the simulator model revision.

flowsheet SimulatorModelRevisionDataFlowsheet

Flowsheet.

info Dictionary<string, string>

Model revision information.

token CancellationToken

Cancellation token.

Returns

Task<SimulatorModelRevisionData>

The updated SimulatorModelRevisionData instance.

UpdateSimulatorModelRevisionParsingStatus(SimulatorsResource, long, SimulatorModelRevisionStatus, string, CancellationToken)

Updates the simulation model revision status and status message in CDF.

public static Task<SimulatorModelRevision> UpdateSimulatorModelRevisionParsingStatus(this SimulatorsResource cdfSimulators, long id, SimulatorModelRevisionStatus status, string statusMessage = null, CancellationToken token = default)

Parameters

cdfSimulators SimulatorsResource

The SimulatorsResource instance.

id long

The ID of the simulator model revision.

status SimulatorModelRevisionStatus

The status of the model revision.

statusMessage string

The status message.

token CancellationToken

The cancellation token.

Returns

Task<SimulatorModelRevision>

The updated SimulatorsResource instance.