Class ReportProperty

Namespace

Cryville.EEW.Report

Assembly

Cryville.EEW.dll

Represents a report property.

public sealed record ReportProperty : TaggedProperty, IEquatable<TaggedProperty>, IEquatable<ReportProperty>

Inheritance

object

TaggedProperty

ReportProperty

Implements

IEquatable<TaggedProperty>

IEquatable<ReportProperty>

Inherited Members

TaggedProperty.Tag

TaggedProperty.Key

TaggedProperty.Value

TaggedProperty.IsUncomparable

TaggedProperty.Type

TaggedProperty.RawValue

TaggedProperty.Condition

TaggedProperty.Culture

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Consider use the ReportProperty(TagTypeKey, string?, string, ISeverityScheme, object?) constructor if Type is well-known, so that the Severity property is determined by the severity scheme specified by the user.

Constructors

ReportProperty(TagTypeKey, object?, string?, string, float)

Represents a report property.

public ReportProperty(TagTypeKey Type, object? RawValue, string? Key, string Value, float Severity)

Parameters

Type TagTypeKey

The type.

RawValue object

The raw value.

Key string

The name.

Value string

The value.

Severity float

The severity. See ISeverityScheme for the definition.

Remarks

Consider use the ReportProperty(TagTypeKey, string?, string, ISeverityScheme, object?) constructor if Type is well-known, so that the Severity property is determined by the severity scheme specified by the user.

ReportProperty(TagTypeKey, string?, string, ISeverityScheme, object?)

Creates an instance of the ReportProperty class.

public ReportProperty(TagTypeKey Type, string? Key, string Value, ISeverityScheme severityScheme, object? rawValue)

Parameters

Type TagTypeKey

The type.

Key string

The name.

Value string

The value.

severityScheme ISeverityScheme

The severity scheme.

rawValue object

The raw value.

Remarks

In a report generator, severityScheme can be found in SeverityScheme.

ReportProperty(TagTypeKey, string?, string, float)

Creates an instance of the ReportProperty class.

public ReportProperty(TagTypeKey Type, string? Key, string Value, float Severity)

Parameters

Type TagTypeKey

The type.

Key string

The name.

Value string

The value.

Severity float

The severity. See ISeverityScheme for the definition.

Remarks

Consider use the ReportProperty(TagTypeKey, string?, string, ISeverityScheme, object?) constructor if Type is well-known, so that the Severity property is determined by the severity scheme specified by the user.

Properties

AccuracyOrder

The accuracy of the value.

public int AccuracyOrder { get; init; }

Property Value

int

Remarks

This value conforms to the following definitions.

0~19 (10 by default)	Strict (observed or derived from observed data strictly based on the definition), reviewed
20~39 (30 by default)	Strict (observed or derived from observed data strictly based on the definition), automatic
40~59 (50 by default)	Estimated (estimated from observed data of the same type)
60~79 (70 by default)	Forecast (estimated from observed data of different types)
80~99 (90 by default)	Unofficial
100	Unknown

The default value is 10.

Severity

The severity. See ISeverityScheme for the definition.

public float Severity { get; init; }

Property Value

float

Methods

GetTagForColorHint()

Gets a tag as a hint to color mapping for the property.

public override KeyValuePair<TagTypeKey, object?>? GetTagForColorHint()

Returns

KeyValuePair<TagTypeKey, object>?

A tag as a hint to color mapping for the property.