PDComm.GemFormattedProgramStoreInfo

Class

Describes the equipment's formatted process program store.

public sealed record GemFormattedProgramStoreInfo

Returned by GemFormattedPrograms.GetStoreInfo and GemFormattedProgramStoreSnapshot.GetSnapshotInfo. The limits come from GemFormattedProgramQueryOptions.

Parameters

Name	Description
`Revision`	The store revision; it increases when the stored programs change.
`EntryCount`	The number of stored process programs.
`IdentifierBytes`	The total length, in bytes, of the PPIDs of the stored programs.
`EncodedBytes`	The total encoded size, in bytes, of the stored programs, each counted as its S7F23 body.
`MaxEntries`	The largest number of stored programs, `GemFormattedProgramQueryOptions.MaxCatalogEntries`.
`MaxIdentifierBytes`	The largest total PPID length, in bytes, `GemFormattedProgramQueryOptions.MaxCatalogIdentifierBytes`.
`MaxEncodedBytes`	The largest total encoded size, in bytes: `GemFormattedProgramStoreInfo.MaxEntries` times `SecsLimits.MessageBytes` of the equipment's item limits.

Members

`GemFormattedProgramStoreInfo`

Constructor

Describes the equipment's formatted process program store.

public GemFormattedProgramStoreInfo(ulong Revision, nuint EntryCount, nuint IdentifierBytes, nuint EncodedBytes, nuint MaxEntries, nuint MaxIdentifierBytes, nuint MaxEncodedBytes)

Returned by GemFormattedPrograms.GetStoreInfo and GemFormattedProgramStoreSnapshot.GetSnapshotInfo. The limits come from GemFormattedProgramQueryOptions.

Parameters

Name	Description
`Revision`	The store revision; it increases when the stored programs change.
`EntryCount`	The number of stored process programs.
`IdentifierBytes`	The total length, in bytes, of the PPIDs of the stored programs.
`EncodedBytes`	The total encoded size, in bytes, of the stored programs, each counted as its S7F23 body.
`MaxEntries`	The largest number of stored programs, `GemFormattedProgramQueryOptions.MaxCatalogEntries`.
`MaxIdentifierBytes`	The largest total PPID length, in bytes, `GemFormattedProgramQueryOptions.MaxCatalogIdentifierBytes`.
`MaxEncodedBytes`	The largest total encoded size, in bytes: `GemFormattedProgramStoreInfo.MaxEntries` times `SecsLimits.MessageBytes` of the equipment's item limits.

`EncodedBytes`

Property

The total encoded size, in bytes, of the stored programs, each counted as its S7F23 body.

public nuint EncodedBytes { get; init; }

`EntryCount`

Property

The number of stored process programs.

public nuint EntryCount { get; init; }

`IdentifierBytes`

Property

The total length, in bytes, of the PPIDs of the stored programs.

public nuint IdentifierBytes { get; init; }

`MaxEncodedBytes`

Property

The largest total encoded size, in bytes: GemFormattedProgramStoreInfo.MaxEntries times SecsLimits.MessageBytes of the equipment's item limits.

public nuint MaxEncodedBytes { get; init; }

`MaxEntries`

Property

The largest number of stored programs, GemFormattedProgramQueryOptions.MaxCatalogEntries.

public nuint MaxEntries { get; init; }

`MaxIdentifierBytes`

Property

The largest total PPID length, in bytes, GemFormattedProgramQueryOptions.MaxCatalogIdentifierBytes.

public nuint MaxIdentifierBytes { get; init; }

`Revision`

Property

The store revision; it increases when the stored programs change.

public ulong Revision { get; init; }