Joseph Doherty
eabf270d71
Resolve all 622 issues flagged by the enhanced CommentChecker: add missing <returns> tags (incl. the standard phrasing on non-generic Task methods), add missing <summary> tags, and replace misused/redundant <inheritdoc/> on members that override or implement nothing with real documentation. Documentation-only — no behavior change; solution builds clean.
26 lines
1.4 KiB
C#
26 lines
1.4 KiB
C#
using ZB.MOM.WW.ScadaBridge.Commons.Types.Enums;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.Communication.Grpc;
|
|
|
|
/// <summary>
|
|
/// Maps <see cref="AlarmShelveState"/> to/from the wire string carried in the
|
|
/// <c>AlarmStateUpdate.shelve_state</c> proto field. The wire form is the enum
|
|
/// member name; an empty or unrecognized string parses back to
|
|
/// <see cref="AlarmShelveState.Unshelved"/> (the safe default).
|
|
/// </summary>
|
|
public static class AlarmShelveStateCodec
|
|
{
|
|
/// <summary>Returns the wire string for a shelve state (the enum member name).</summary>
|
|
/// <param name="state">The shelve state to encode as a wire string.</param>
|
|
/// <returns>The enum member name as a string (e.g., "Unshelved", "OneShotShelved").</returns>
|
|
public static string ToWire(AlarmShelveState state) => state.ToString();
|
|
|
|
/// <summary>Parses a wire string back to a shelve state; defaults to <see cref="AlarmShelveState.Unshelved"/>.</summary>
|
|
/// <param name="wire">The wire string to parse; empty or unrecognized values return <see cref="AlarmShelveState.Unshelved"/>.</param>
|
|
/// <returns>The matching <see cref="AlarmShelveState"/>, or <see cref="AlarmShelveState.Unshelved"/> for unrecognized input.</returns>
|
|
public static AlarmShelveState Parse(string? wire) =>
|
|
Enum.TryParse<AlarmShelveState>(wire, ignoreCase: true, out var state)
|
|
? state
|
|
: AlarmShelveState.Unshelved;
|
|
}
|