Class Representation

Namespace

Nexus.DataModel

Assembly

Nexus.Extensibility.dll

A representation is part of a resource.

public record Representation : IEquatable<Representation>

Inheritance

object

Representation

Implements

IEquatable<Representation>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Representation(NexusDataType, TimeSpan, IReadOnlyDictionary<string, JsonElement>?)

Initializes a new instance of the Representation.

public Representation(NexusDataType dataType, TimeSpan samplePeriod, IReadOnlyDictionary<string, JsonElement>? parameters = null)

Parameters

dataType NexusDataType

The NexusDataType.

samplePeriod TimeSpan

The sample period.

parameters IReadOnlyDictionary<string, JsonElement>

An optional list of representation parameters.

Exceptions

ArgumentException

Thrown when the resource identifier, the sample period or the detail values are not valid.

Properties

DataType

The data type.

public NexusDataType DataType { get; }

Property Value

NexusDataType

ElementSize

The number of bits per element.

[JsonIgnore]
public int ElementSize { get; }

Property Value

int

Id

The identifer of the representation. It is constructed using the sample period.

[JsonIgnore]
public string Id { get; }

Property Value

string

Parameters

The optional list of parameters.

public IReadOnlyDictionary<string, JsonElement>? Parameters { get; init; }

Property Value

IReadOnlyDictionary<string, JsonElement>

SamplePeriod

The sample period.

public TimeSpan SamplePeriod { get; }

Property Value

TimeSpan