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 或平台特定错误代码，表示在解码已编码数据时出错。

编码

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