PDComm.GemDataDefinition

Class

Represents the definition of one data variable in an equipment's data variable store.

public sealed record GemDataDefinition

Parameters

Name	Description
`Id`	The data variable ID. Report bindings refer to it with `GemDataSourceKind.Data`.
`Name`	The ASCII name. The equipment reports it as DVVALNAME in S1F22 for VIDs bound to this variable.
`Units`	The ASCII units (UNITS); may be empty.
`Format`	The SECS-II format that every value of the variable must have at the top level.
`MinCount`	The minimum top-level count (`SecsInfo.Count`) of a value.
`MaxCount`	The maximum top-level count (`SecsInfo.Count`) of a value; must not be less than `MinCount`.
`Cached`	The initial cached value, or `null` for no value. An absent value differs from an empty one. The configuring call copies the item; the caller keeps ownership.

Members

`GemDataDefinition`

Constructor

Represents the definition of one data variable in an equipment's data variable store.

public GemDataDefinition(uint Id, string Name, string Units, SecsFormat Format, nuint MinCount, nuint MaxCount, SecsItem? Cached)

Parameters

Name	Description
`Id`	The data variable ID. Report bindings refer to it with `GemDataSourceKind.Data`.
`Name`	The ASCII name. The equipment reports it as DVVALNAME in S1F22 for VIDs bound to this variable.
`Units`	The ASCII units (UNITS); may be empty.
`Format`	The SECS-II format that every value of the variable must have at the top level.
`MinCount`	The minimum top-level count (`SecsInfo.Count`) of a value.
`MaxCount`	The maximum top-level count (`SecsInfo.Count`) of a value; must not be less than `MinCount`.
`Cached`	The initial cached value, or `null` for no value. An absent value differs from an empty one. The configuring call copies the item; the caller keeps ownership.

`Cached`

Property

The initial cached value, or null for no value. An absent value differs from an empty one. The configuring call copies the item; the caller keeps ownership.

public SecsItem? Cached { get; init; }

`Format`

Property

The SECS-II format that every value of the variable must have at the top level.

public SecsFormat Format { get; init; }

`Id`

Property

The data variable ID. Report bindings refer to it with GemDataSourceKind.Data.

public uint Id { get; init; }

`MaxCount`

Property

The maximum top-level count (SecsInfo.Count) of a value; must not be less than MinCount.

public nuint MaxCount { get; init; }

`MinCount`

Property

The minimum top-level count (SecsInfo.Count) of a value.

public nuint MinCount { get; init; }

`Name`

Property

The ASCII name. The equipment reports it as DVVALNAME in S1F22 for VIDs bound to this variable.

public string Name { get; init; }

`Units`

Property

The ASCII units (UNITS); may be empty.

public string Units { get; init; }