Class SimulationTimeSeries

Namespace

Cognite.Simulator.Extensions

Assembly

Cognite.Simulator.Extensions.dll

Represents a simulation variable associated with a simulation run. For instance, simulation sampled inputs and result outputs

public abstract class SimulationTimeSeries

Inheritance

object

SimulationTimeSeries

Derived

SimulationInput

SimulationOutput

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Metadata

Any other metadata related to this variable

public Dictionary<string, string> Metadata { get; set; }

Property Value

Dictionary<string, string>

Name

Variable name

public string Name { get; set; }

Property Value

string

ReferenceId

Unique identifier in a given routine

public string ReferenceId { get; set; }

Property Value

string

RoutineRevisionInfo

Routine revision associated with this variable

public SimulatorRoutineRevisionInfo RoutineRevisionInfo { get; set; }

Property Value

SimulatorRoutineRevisionInfo

SaveTimeseriesExternalId

Allows saving the time series value back to CDF with the one provided by the user

public string SaveTimeseriesExternalId { get; set; }

Property Value

string

Unit

Variable unit

public string Unit { get; set; }

Property Value

string

Methods

AddMetadata(string, string)

Add a (key, value) pair as metadata

public void AddMetadata(string key, string value)

Parameters

key string

Key

value string

Value

GetMetadata(string)

Get the metadata value associated with the given key, if any

public string GetMetadata(string key)

Parameters

key string

Key

Returns

string

Metadata value, if key exists. Else, null