Skip to content

Commit

Permalink
change the type/member name for EDATA types to 'EData'
Browse files Browse the repository at this point in the history
  • Loading branch information
@smdn
smdn committed Mar 31, 2024
1 parent 08a8f9b commit f9d600d
Show file tree
Hide file tree
Showing 10 changed files with 111 additions and 111 deletions.
10 changes: 5 additions & 5 deletions src/Smdn.Net.EchonetLite/Smdn.Net.EchonetLite.Protocol/EData1.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ namespace Smdn.Net.EchonetLite.Protocol
/// <summary>
/// 電文形式 1（規定電文形式）
/// </summary>
public sealed class EDATA1 : IEDATA
public sealed class EData1 : IEData
{
/// <summary>
/// ECHONET Liteフレームの電文形式 1（規定電文形式）の電文を記述する<see cref="EDATA1"/>を作成します。
/// ECHONET Liteフレームの電文形式 1（規定電文形式）の電文を記述する<see cref="EData1"/>を作成します。
/// </summary>
/// <remarks>
/// このオーバーロードでは、<see cref="OPCGetList"/>および<see cref="OPCSetList"/>に<see langword="null"/>を設定します。
Expand All @@ -33,7 +33,7 @@ public sealed class EDATA1 : IEDATA
/// この場合、<see cref="OPCSetList"/>および<see cref="OPCGetList"/>を指定する必要があります。
/// </exception>
/// <exception cref="ArgumentNullException"><paramref name="opcList"/>が<see langword="null"/>です。</exception>
public EDATA1(EOJ seoj, EOJ deoj, ESV esv, IReadOnlyCollection<PropertyRequest> opcList)
public EData1(EOJ seoj, EOJ deoj, ESV esv, IReadOnlyCollection<PropertyRequest> opcList)
{
if (FrameSerializer.IsESVWriteOrReadService(esv))
throw new ArgumentException(message: $"ESV must be other than {nameof(ESV.SetGet)}, {nameof(ESV.SetGet_Res)}, or {nameof(ESV.SetGet_SNA)}.", paramName: nameof(esv));
Expand All @@ -45,7 +45,7 @@ public EDATA1(EOJ seoj, EOJ deoj, ESV esv, IReadOnlyCollection<PropertyRequest>
}

/// <summary>
/// ECHONET Liteフレームの電文形式 1（規定電文形式）の電文を記述する<see cref="EDATA1"/>を作成します。
/// ECHONET Liteフレームの電文形式 1（規定電文形式）の電文を記述する<see cref="EData1"/>を作成します。
/// </summary>
/// <remarks>
/// このオーバーロードでは、<see cref="OPCList"/>に<see langword="null"/>を設定します。
Expand All @@ -60,7 +60,7 @@ public EDATA1(EOJ seoj, EOJ deoj, ESV esv, IReadOnlyCollection<PropertyRequest>
/// この場合、<see cref="OPCList"/>のみを指定する必要があります。
/// </exception>
/// <exception cref="ArgumentNullException"><paramref name="opcSetList"/>もしくは<paramref name="opcGetList"/>が<see langword="null"/>です。</exception>
public EDATA1(EOJ seoj, EOJ deoj, ESV esv, IReadOnlyCollection<PropertyRequest> opcSetList, IReadOnlyCollection<PropertyRequest> opcGetList)
public EData1(EOJ seoj, EOJ deoj, ESV esv, IReadOnlyCollection<PropertyRequest> opcSetList, IReadOnlyCollection<PropertyRequest> opcGetList)
{
if (!FrameSerializer.IsESVWriteOrReadService(esv))
throw new ArgumentException(message: $"ESV must be {nameof(ESV.SetGet)}, {nameof(ESV.SetGet_Res)}, or {nameof(ESV.SetGet_SNA)}.", paramName: nameof(esv));
Expand Down
6 changes: 3 additions & 3 deletions src/Smdn.Net.EchonetLite/Smdn.Net.EchonetLite.Protocol/EData2.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ namespace Smdn.Net.EchonetLite.Protocol
/// <summary>
/// 電文形式２（任意電文形式）
/// </summary>
public sealed class EDATA2 : IEDATA
public sealed class EData2 : IEData
{
/// <summary>
/// ECHONET Liteフレームの電文形式２（任意電文形式）の電文を記述する<see cref="EDATA2"/>を作成します。
/// ECHONET Liteフレームの電文形式２（任意電文形式）の電文を記述する<see cref="EData2"/>を作成します。
/// </summary>
/// <param name="message"><see cref="Message"/>に指定する値。</param>
public EDATA2(ReadOnlyMemory<byte> message)
public EData2(ReadOnlyMemory<byte> message)
{
Message = message;
}
Expand Down
12 changes: 6 additions & 6 deletions src/Smdn.Net.EchonetLite/Smdn.Net.EchonetLite.Protocol/Frame.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,26 +19,26 @@ namespace Smdn.Net.EchonetLite.Protocol
/// <param name="ehd1"><see cref="EHD1"/>に指定する値。</param>
/// <param name="ehd2"><see cref="EHD2"/>に指定する値。</param>
/// <param name="tid"><see cref="TID"/>に指定する値。</param>
/// <param name="edata"><see cref="EDATA"/>に指定する値。</param>
/// <param name="edata"><see cref="EData"/>に指定する値。</param>
/// <exception cref="ArgumentNullException"><paramref name="edata"/>が<see langword="null"/>です。</exception>
/// <exception cref="ArgumentException">
/// <paramref name="edata"/>の型が<paramref name="ehd2"/>と矛盾しています。
/// または<paramref name="ehd2"/>に不正な値が指定されています。
/// </exception>
public Frame(EHD1 ehd1, EHD2 ehd2, ushort tid, IEDATA edata)
public Frame(EHD1 ehd1, EHD2 ehd2, ushort tid, IEData edata)
{
if (edata is null)
throw new ArgumentNullException(nameof(edata));

switch (ehd2)
{
case EHD2.Type1:
if (edata is not EDATA1)
if (edata is not EData1)
throw new ArgumentException(message: "type mismatch", paramName: nameof(edata));
break;

case EHD2.Type2:
if (edata is not EDATA2)
if (edata is not EData2)
throw new ArgumentException(message: "type mismatch", paramName: nameof(edata));
break;

Expand All @@ -49,7 +49,7 @@ public Frame(EHD1 ehd1, EHD2 ehd2, ushort tid, IEDATA edata)
EHD1 = ehd1;
EHD2 = ehd2;
TID = tid;
EDATA = edata;
EData = edata;
}

/// <summary>
Expand All @@ -73,6 +73,6 @@ public Frame(EHD1 ehd1, EHD2 ehd2, ushort tid, IEDATA edata)
/// ECHONET Liteデータ
/// ECHONET Lite 通信ミドルウェアにてやり取りされる電文のデータ領域。
/// </summary>
public IEDATA? EDATA { get; }
public IEData? EData { get; }
}
}
38 changes: 19 additions & 19 deletions src/Smdn.Net.EchonetLite/Smdn.Net.EchonetLite.Protocol/FrameSerializer.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ public static void Serialize(Frame frame, IBufferWriter<byte> buffer)
switch (frame.EHD2)
{
case EHD2.Type1:
if (frame.EDATA is not EDATA1 edata1)
throw new ArgumentException($"{nameof(EDATA1)} must be set to {nameof(Frame)}.{nameof(Frame.EDATA)}.", paramName: nameof(frame));
if (frame.EData is not EData1 edata1)
throw new ArgumentException($"{nameof(EData1)} must be set to {nameof(Frame)}.{nameof(Frame.EData)}.", paramName: nameof(frame));

#if !NET5_0_OR_GREATER // NotNullWhenAttribute
#pragma warning disable CS8604
Expand All @@ -43,8 +43,8 @@ public static void Serialize(Frame frame, IBufferWriter<byte> buffer)
break;

case EHD2.Type2:
if (frame.EDATA is not EDATA2 edata2)
throw new ArgumentException($"{nameof(EDATA2)} must be set to {nameof(Frame)}.{nameof(Frame.EDATA)}.", paramName: nameof(frame));
if (frame.EData is not EData2 edata2)
throw new ArgumentException($"{nameof(EData2)} must be set to {nameof(Frame)}.{nameof(Frame.EData)}.", paramName: nameof(frame));

SerializeEchonetLiteFrameFormat2(buffer, frame.TID, edata2.Message.Span);

Expand Down Expand Up @@ -88,7 +88,7 @@ public static void Serialize(Frame frame, IBufferWriter<byte> buffer)
// プロパティ値データ(PDCで指定)
var failIfOpcSetOrOpcGetIsZero = IsESVWriteOrReadService(esv) && esv != ESV.SetGet_SNA;

if (!TryWriteEDATAType1ProcessingTargetProperties(buffer, opcListOrOpcSetList, failIfEmpty: failIfOpcSetOrOpcGetIsZero))
if (!TryWriteEDataType1ProcessingTargetProperties(buffer, opcListOrOpcSetList, failIfEmpty: failIfOpcSetOrOpcGetIsZero))
throw new InvalidOperationException("OPCSet can not be zero when ESV is other than SetGet_SNA.");

if (IsESVWriteOrReadService(esv))
Expand All @@ -100,7 +100,7 @@ public static void Serialize(Frame frame, IBufferWriter<byte> buffer)
// ECHONET Liteプロパティ(1B)
// EDTのバイト数(1B)
// プロパティ値データ(PDCで指定)
if (!TryWriteEDATAType1ProcessingTargetProperties(buffer, opcGetList, failIfEmpty: failIfOpcSetOrOpcGetIsZero))
if (!TryWriteEDataType1ProcessingTargetProperties(buffer, opcGetList, failIfEmpty: failIfOpcSetOrOpcGetIsZero))
throw new InvalidOperationException("OPCGet can not be zero when ESV is other than SetGet_SNA.");
}
}
Expand All @@ -116,9 +116,9 @@ ReadOnlySpan<byte> edata

WriteEchonetLiteEHDAndTID(buffer, EHD1.ECHONETLite, EHD2.Type2, tid);

var bufferEDATASpan = buffer.GetSpan(edata.Length);
var bufferEDataSpan = buffer.GetSpan(edata.Length);

edata.CopyTo(bufferEDATASpan);
edata.CopyTo(bufferEDataSpan);

buffer.Advance(edata.Length);
}
Expand Down Expand Up @@ -149,7 +149,7 @@ public static bool TryDeserialize(ReadOnlySpan<byte> bytes, out Frame frame)
switch (ehd2)
{
case EHD2.Type1:
if (TryReadEDATAType1(edataSpan, out var edata))
if (TryReadEDataType1(edataSpan, out var edata))
{
frame = new Frame(ehd1, ehd2, tid, edata);
return true;
Expand All @@ -162,7 +162,7 @@ public static bool TryDeserialize(ReadOnlySpan<byte> bytes, out Frame frame)
ehd1,
ehd2,
tid,
new EDATA2
new EData2
(
edataSpan.ToArray() // TODO: reduce allocation
)
Expand All @@ -181,15 +181,15 @@ internal static bool IsESVWriteOrReadService(ESV esv)
_ => false,
};

private static bool TryReadEDATAType1(ReadOnlySpan<byte> bytes, [NotNullWhen(true)] out EDATA1? edata)
private static bool TryReadEDataType1(ReadOnlySpan<byte> bytes, [NotNullWhen(true)] out EData1? edata)
{
edata = null;

if (bytes.Length < 7)
return false;

var seoj = ReadEDATA1EOJ(bytes.Slice(0, 3));
var deoj = ReadEDATA1EOJ(bytes.Slice(3, 3));
var seoj = ReadEData1EOJ(bytes.Slice(0, 3));
var deoj = ReadEData1EOJ(bytes.Slice(3, 3));
var esv = (ESV)bytes[6];

bytes = bytes.Slice(7);
Expand All @@ -201,7 +201,7 @@ private static bool TryReadEDATAType1(ReadOnlySpan<byte> bytes, [NotNullWhen(tru
// ECHONET Liteプロパティ(1B)
// EDTのバイト数(1B)
// プロパティ値データ(PDCで指定)
if (!TryReadEDATA1ProcessingTargetProperties(bytes, out var opcSetList, out var bytesReadForOPCSetList))
if (!TryReadEData1ProcessingTargetProperties(bytes, out var opcSetList, out var bytesReadForOPCSetList))
return false;

bytes = bytes.Slice(bytesReadForOPCSetList);
Expand All @@ -210,7 +210,7 @@ private static bool TryReadEDATAType1(ReadOnlySpan<byte> bytes, [NotNullWhen(tru
// ECHONET Liteプロパティ(1B)
// EDTのバイト数(1B)
// プロパティ値データ(PDCで指定)
if (!TryReadEDATA1ProcessingTargetProperties(bytes, out var opcGetList, out _ /* var bytesReadForOPCGetList */))
if (!TryReadEData1ProcessingTargetProperties(bytes, out var opcGetList, out _ /* var bytesReadForOPCGetList */))
return false;

edata = new
Expand All @@ -230,7 +230,7 @@ private static bool TryReadEDATAType1(ReadOnlySpan<byte> bytes, [NotNullWhen(tru
// ECHONET Liteプロパティ(1B)
// EDTのバイト数(1B)
// プロパティ値データ(PDCで指定)
if (!TryReadEDATA1ProcessingTargetProperties(bytes, out var opcList, out _ /* var bytesRead */))
if (!TryReadEData1ProcessingTargetProperties(bytes, out var opcList, out _ /* var bytesRead */))
return false;

// bytes = bytes.Slice(bytesRead);
Expand All @@ -247,7 +247,7 @@ private static bool TryReadEDATAType1(ReadOnlySpan<byte> bytes, [NotNullWhen(tru
return true;
}

private static EOJ ReadEDATA1EOJ(ReadOnlySpan<byte> bytes)
private static EOJ ReadEData1EOJ(ReadOnlySpan<byte> bytes)
{
#if DEBUG
if (bytes.Length < 3)
Expand All @@ -262,7 +262,7 @@ private static EOJ ReadEDATA1EOJ(ReadOnlySpan<byte> bytes)
);
}

private static bool TryReadEDATA1ProcessingTargetProperties(
private static bool TryReadEData1ProcessingTargetProperties(
ReadOnlySpan<byte> bytes,
[NotNullWhen(true)] out IReadOnlyCollection<PropertyRequest>? processingTargetProperties,
out int bytesRead
Expand Down Expand Up @@ -356,7 +356,7 @@ private static void WriteEOJ(IBufferWriter<byte> buffer, EOJ eoj)
buffer.Advance(3);
}

private static bool TryWriteEDATAType1ProcessingTargetProperties(
private static bool TryWriteEDataType1ProcessingTargetProperties(
IBufferWriter<byte> buffer,
IEnumerable<PropertyRequest> opcList,
bool failIfEmpty
Expand Down
2 changes: 1 addition & 1 deletion src/Smdn.Net.EchonetLite/Smdn.Net.EchonetLite.Protocol/IEData.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// SPDX-License-Identifier: MIT
namespace Smdn.Net.EchonetLite.Protocol
{
public interface IEDATA
public interface IEData
{
}
}
Loading

0 comments on commit f9d600d

Please sign in to comment.