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 字段。

公共属性

NumRegDomains

uint16_t NumSupportedRegDomains

SupportedRegDomains 数组的长度。

OpLocation

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 字段。