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 陣列的長度。

運算位置

uint8_t OpLocation

運作中地點值 0 表示不存在。

註冊網域

WirelessRegDomain RegDomain

活動無線監管域的 '\0'表示不存在。

支援的規則運算式網域

WirelessRegDomain * SupportedRegDomains

支援的法規網域結構陣列。

公開函式

解碼

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

從採用 Weave TLV 格式編碼的資訊中填入物件。

提供的 TVLReader 物件必須位在含有待解碼資訊的 TLV 結構前面或前面。

在呼叫方法之前，呼叫端必須將 SupportedRegDomains 成員初始化為包含夠大的陣列，以保存已解碼的值，並將 NumSupportedRegDomains 成員設定為該陣列中的陣列大小。

詳細資料
參數
[in] reader
TVLReader 物件，用來對物件資訊進行解碼。
傳回值
WEAVE_NO_ERROR
成功。
other
其他與 Weave 或平台相關的錯誤代碼，表示在對經過編碼的資料進行解碼時發生錯誤。

解碼

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 物件重設為空白狀態。

位置位置存在

bool IsOpLocationPresent(
  void
) const

WirelessRegConfig 物件中是否有 OpLocation 欄位。

是採用的網域格式

bool IsRegDomainPresent(
  void
) const

WirelessRegConfig 物件中是否存在 RegDomain 欄位。