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
RegDomain フィールドが WirelessRegConfig オブジェクトに存在するかどうか。

パブリック属性

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 

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