Class TimeSeriesExtensions

Namespace

Cognite.Simulator.Extensions

Assembly

Cognite.Simulator.Extensions.dll

Class containing extensions to the CDF Time Series resource with utility methods for simulator integrations

public static class TimeSeriesExtensions

Inheritance

object

TimeSeriesExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

GetOrCreateSimulationInputs(TimeSeriesResource, IEnumerable<SimulationInput>, long?, CancellationToken)

Creates time series in CDF that represent sampled simulation inputs. Creates the ones not found in CDF, and returns the ones that already exist. Data points in this time series should contain the sampled input as value, and the simulation time as timestamp.

public static Task<IEnumerable<TimeSeries>> GetOrCreateSimulationInputs(this TimeSeriesResource timeSeries, IEnumerable<SimulationInput> inputs, long? dataSetId, CancellationToken token)

Parameters

timeSeries TimeSeriesResource

CDF time series resource

inputs IEnumerable<SimulationInput>

List of simulation inputs

dataSetId long?

Data set id

token CancellationToken

Cancellation token

Returns

Task<IEnumerable<TimeSeries>>

Created or existing time series

Exceptions

ArgumentNullException

Thrown when the list of inputs is null

SimulationTimeSeriesCreationException

Thrown when it was not possible to create the time series

GetOrCreateSimulationOutputs(TimeSeriesResource, IEnumerable<SimulationOutput>, long?, CancellationToken)

Creates time series in CDF that represent simulation results. Creates the ones not found in CDF, and returns the ones that already exist. Data points in this time series should contain the simulation result as value, and the simulation time as timestamp.

public static Task<IEnumerable<TimeSeries>> GetOrCreateSimulationOutputs(this TimeSeriesResource timeSeries, IEnumerable<SimulationOutput> outputs, long? dataSetId, CancellationToken token)

Parameters

timeSeries TimeSeriesResource

outputs IEnumerable<SimulationOutput>

dataSetId long?

Data set id

token CancellationToken

Cancellation token

Returns

Task<IEnumerable<TimeSeries>>

Created or existing time series

Exceptions

ArgumentNullException

Thrown when the list of outputs is null

SimulationTimeSeriesCreationException

Thrown when it was not possible to create the time series