nl::Weave::Profiles::NetworkProvisioning::WirelessRegConfig

#include <src/lib/profiles/network-provisioning/WirelessRegConfig.h>

無線通信規則の設定情報のコンテナ。

概要

パブリック属性

NumSupportedRegDomains
uint16_t
SupportedRegDomains 配列の長さ。
OpLocation
uint8_t
アクティブな営業拠点: 値 0 は存在しないことを示します。
RegDomain
有効な無線通信規制ドメインの値「\0」は存在しないことを示します。
SupportedRegDomains
サポートされている規制ドメイン構造の配列。

パブリック関数

Decode(nl::Weave::TLV::TLVReader & reader)
Weave TLV 形式でエンコードされた情報からオブジェクトを入力します。
DecodeInPlace(PacketBuffer *buf)
再利用して、エンコードされた PacketBuffer からオブジェクトにデータを入力します。
Encode(nl::Weave::TLV::TLVWriter & writer) const
オブジェクトを Weave の TLV 形式でエンコードします。
Init(void)
void
WirelessRegConfig オブジェクトを空の状態にリセットします。
IsOpLocationPresent(void) const
bool
WirelessRegConfig オブジェクトに OpLocation フィールドが存在するか。
IsRegDomainPresent(void) const
bool
WirelessRegConfig オブジェクトに RegDomain フィールドが存在するかどうか。

パブリック属性

NumSupportedRegDomains

uint16_t NumSupportedRegDomains

SupportedRegDomains 配列の長さ。

OpLocation

uint8_t OpLocation

アクティブな営業拠点: 値 0 は存在しないことを示します。

RegDomain

WirelessRegDomain RegDomain

有効な無線通信規制ドメインの値「\0」は存在しないことを示します。

SupportedRegDomains

WirelessRegDomain * SupportedRegDomains

サポートされている規制ドメイン構造の配列。

パブリック関数

Decode

WEAVE_ERROR Decode(
  nl::Weave::TLV::TLVReader & reader
)

Weave TLV 形式でエンコードされた情報からオブジェクトを入力します。

指定する TVLReader オブジェクトは、デコードする情報を含む TLV 構造体上またはその直前に配置する必要があります。

このメソッドを呼び出す前に、呼び出し元は、デコードされた値を保持するのに十分な大きさの配列に SupportedRegDomains メンバーを初期化し、要素単位で NumSupportedRegDomains メンバーをその配列のサイズに設定する必要があります。

詳細
パラメータ
[in] reader
オブジェクト情報のデコードに使用する TVLReader オブジェクト。
戻り値
WEAVE_NO_ERROR
成功時。
other
エンコードされたデータのデコード中にエラーが発生したことを示す、その他の Weave またはプラットフォーム固有のエラーコード。

DecodeInPlace

WEAVE_ERROR DecodeInPlace(
  PacketBuffer *buf
)

再利用して、エンコードされた PacketBuffer からオブジェクトにデータを入力します。

メソッドが完了すると、指定された PacketBuffer の内容は、サポートされている規制ドメインを含む配列で上書きされます。SupportedRegDomains メンバーはこの配列の先頭をポイントするように設定され、NumSupportedRegDomains メンバーには配列内のアイテム数が含まれます。

詳細
パラメータ
[in] buf
デコードする情報を含む PacketBuffer オブジェクト。
戻り値
WEAVE_NO_ERROR
成功時。
other
エンコードされたデータのデコード中にエラーが発生したことを示す、その他の Weave またはプラットフォーム固有のエラーコード。

Encode

WEAVE_ERROR Encode(
  nl::Weave::TLV::TLVWriter & writer
) const 

オブジェクトを Weave の TLV 形式でエンコードします。

詳細
パラメータ
[in] writer
エンコードされたデータの書き込み先となる TLVWriter オブジェクト。
戻り値
WEAVE_NO_ERROR
成功時。
other
データのエンコード中にエラーが発生したことを示す、その他の Weave またはプラットフォーム固有のエラーコード。

init

void Init(
  void
)

WirelessRegConfig オブジェクトを空の状態にリセットします。

IsOpLocationPresent

bool IsOpLocationPresent(
  void
) const 

WirelessRegConfig オブジェクトに OpLocation フィールドが存在するか。

IsRegDomainPresent

bool IsRegDomainPresent(
  void
) const 

WirelessRegConfig オブジェクトに RegDomain フィールドが存在するかどうか。