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