Struct ReadingValue

Namespace

Acuit.Pinpoint.IO.Testing

Assembly

Acuit.Pinpoint.IO.Testing.Abstractions.dll

A reading value for a non-numeric value.

public readonly struct ReadingValue : IReadingValue, IDataValue, IFormattable, IEquatable<ReadingValue>

Implements

IReadingValue

IDataValue

IFormattable

IEquatable<ReadingValue>

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Extension Methods

DataValueExtensions.ToNullableDouble(IDataValue)

TimestampedDataValueExtensions.TryGetTimestamp(IDataValue, out DateTimeOffset)

Constructors

ReadingValue(object, IReadingDescriptor)

Initializes a new instance of the ReadingValue class.

public ReadingValue(object value, IReadingDescriptor descriptor)

Parameters

value object

The value.

descriptor IReadingDescriptor

The reading descriptor.

Exceptions

ArgumentNullException

descriptor is null.

Properties

Descriptor

Gets the reading value descriptor.

public IReadingDescriptor Descriptor { get; }

Property Value

IReadingDescriptor

Inner

Gets the inner data value, or null if there is none.

public IDataValue Inner { get; }

Property Value

IDataValue

Remarks

This allows additional data to be added to data values, such as timestamps or validation results.

When this is set for a data value, Value and Descriptor must return the same values as those of Inner.

Value

Gets the value.

public object Value { get; }

Property Value

object

Methods

Equals(ReadingValue)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(ReadingValue other)

Parameters

other ReadingValue

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.

ToString(string, IFormatProvider)

Formats the value of the current instance using the specified format.

public string ToString(string format, IFormatProvider formatProvider)

Parameters

format string

The format to use, or null to use the default format defined for the type of the IFormattable implementation.

formatProvider IFormatProvider

The provider to use to format the value, or null to obtain the numeric format information from the current locale setting of the operating system.

Returns

string

The value of the current instance in the specified format.

Remarks

See Format(object, string, IFormatProvider) for a description of the supported formats.

Operators

operator ==(ReadingValue, ReadingValue)

Returns a value that indicates whether two specified ReadingValue values are equal.

public static bool operator ==(ReadingValue left, ReadingValue right)

Parameters

left ReadingValue

The first value to compare.

right ReadingValue

The second value to compare.

Returns

bool

true if left and right are equal; otherwise, false.

operator !=(ReadingValue, ReadingValue)

Returns a value that indicates whether two specified ReadingValue values are not equal.

public static bool operator !=(ReadingValue left, ReadingValue right)

Parameters

left ReadingValue

The first value to compare.

right ReadingValue

The second value to compare.

Returns

bool

true if left and right are not equal; otherwise, false.