Skip to content

Commit

Permalink
improve documents
Browse files Browse the repository at this point in the history
  • Loading branch information
smdn committed Apr 1, 2024
1 parent ba704aa commit 2e333ea
Showing 1 changed file with 48 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,18 @@ namespace Smdn.Net.EchonetLite.Appendix
{

/// <summary>
/// ECHONET Lite オブジェクトプロパティ
/// ECHONET プロパティの詳細規定を表すクラスです。
/// <see href="https://echonet.jp/spec_g/">機器オブジェクト詳細規定</see>で規定される各プロパティの定義を参照します。
/// </summary>
/// <seealso href="https://echonet.jp/spec_v114_lite/">
/// ECHONET Lite規格書 Ver.1.14 第2部 ECHONET Lite 通信ミドルウェア仕様 3.2.7 ECHONET プロパティ(EPC)
/// </seealso>
/// <seealso href="https://echonet.jp/spec_v114_lite/">
/// ECHONET Lite規格書 Ver.1.14 第2部 ECHONET Lite 通信ミドルウェア仕様 6.2 ECHONET プロパティ基本規定
/// </seealso>
/// <seealso href="https://echonet.jp/spec_g/">
/// APPENDIX ECHONET 機器オブジェクト詳細規定 第2章 機器オブジェクトスーパークラス規定
/// </seealso>
public sealed class EchonetPropertySpecification
{
/// <summary>
Expand Down Expand Up @@ -118,7 +128,7 @@ public EchonetPropertySpecification
/// </summary>
public string Name { get; }
/// <summary>
/// EPC プロパティコード
/// EPC(ECHONET プロパティコード)
/// </summary>
[JsonConverter(typeof(SingleByteHexStringJsonConverter))]
public byte Code { get; }
Expand Down Expand Up @@ -147,32 +157,62 @@ public EchonetPropertySpecification
/// 最大サイズ
/// </summary>
public int? MaxSize { get; }

/// <summary>
/// アクセスルールに"Get"が規定されているかどうかを表す値を取得します。
/// </summary>
/// <remarks>
/// プロパティ値の読み出し・通知要求のサービスを処理する。
/// プロパティ値読み出し要求(0x62)、プロパティ値書き込み・読み出し要求(0x6E)、プロパティ値通知要求(0x63)の要求受付処理を実施する。
/// </summary>
/// </remarks>
/// <seealso href="https://echonet.jp/spec_v114_lite/">
/// ECHONET Lite規格書 Ver.1.14 第2部 ECHONET Lite 通信ミドルウェア仕様 6.2.5 アクセスルール
/// </seealso>
/// <seealso cref="GetRequired"/>
public bool Get { get; }

/// <summary>
/// Get必須
/// このプロパティとアクセスルール"Get"のサービスの実装が必須であるかどうかを表す値を取得します。
/// </summary>
/// <seealso cref="Get"/>
public bool GetRequired { get; }

/// <summary>
/// アクセスルールに"Set"が規定されているかどうかを表す値を取得します。
/// </summary>
/// <remarks>
/// プロパティ値の書き込み要求のサービスを処理する。
/// プロパティ値書き込み要求(応答不要)(0x60)、プロパティ値書き込み要求(応答要)(0x61)、プロパティ値書き込み・読み出し要求(0x6E)の要求受付処理を実施する。
/// </summary>
/// </remarks>
/// <seealso href="https://echonet.jp/spec_v114_lite/">
/// ECHONET Lite規格書 Ver.1.14 第2部 ECHONET Lite 通信ミドルウェア仕様 6.2.5 アクセスルール
/// </seealso>
/// <seealso cref="SetRequired"/>
public bool Set { get; }

/// <summary>
/// Set必須
/// このプロパティとアクセスルール"Set"のサービスの実装が必須であるかどうかを表す値を取得します。
/// </summary>
/// <seealso cref="Set"/>
public bool SetRequired { get; }

/// <summary>
/// アクセスルールに"Anno"が規定されているかどうかを表す値を取得します。
/// </summary>
/// <remarks>
/// プロパティ値の通知要求のサービスを処理する。
/// プロパティ値通知要求(0x63)の要求受付処理を実施する。
/// </summary>
/// </remarks>
/// <seealso href="https://echonet.jp/spec_v114_lite/">
/// ECHONET Lite規格書 Ver.1.14 第2部 ECHONET Lite 通信ミドルウェア仕様 6.2.5 アクセスルール
/// </seealso>
/// <seealso cref="AnnoRequired"/>
public bool Anno { get; }

/// <summary>
/// Anno必須
/// このプロパティとアクセスルール"Anno"のサービスの実装が必須であるかどうかを表す値を取得します。
/// </summary>
/// <seealso cref="Anno"/>
public bool AnnoRequired { get; }

/// <summary>
Expand Down

0 comments on commit 2e333ea

Please sign in to comment.