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

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

無線法規設定資訊的容器。

摘要

公開屬性
NumSupportedRegDomains
uint16_t
SupportedRegDomains 陣列的長度。
OpLocation
uint8_t
有效營業位置值 0 表示不存在。
RegDomain
「\0」的有效無線法規網域值「\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」的有效無線法規網域值「\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 或平台專屬錯誤代碼，用於表示解碼資料時發生錯誤。

編碼

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 欄位。