nl::Weave::Profiles::DataManagement_Legacy::ProfileDatabase::ProfileData

这是一个抽象类。

#include <src/lib/profiles/data-management/Legacy/ProfileDatabase.h>

抽象 ProfileData 辅助内部类。

摘要

ProfileDatabase 子类实现者还应实现此辅助内部类的子类。ProfileData 对象的功能是提供钩子，以便存储具体数据（给定数据表示为 TLV），并在给定以 TLV 编码的路径列表的情况下检索为 TLV 表示。

构造函数和析构函数
ProfileData(void)
ProfileData 的默认构造函数。
~ProfileData(void)
ProfileData 的析构函数。

公共属性
mVersion
uint64_t
个人资料数据版本。

公共函数
Retrieve(nl::Weave::TLV::TLVReader & aPathReader, nl::Weave::TLV::TLVWriter & aDataWriter)=0
virtual WEAVE_ERROR
根据残余 WDM 路径写出数据项。
Store(nl::Weave::TLV::TLVReader & aPathReader, uint64_t aVersion, nl::Weave::TLV::TLVReader & aDataReader)
virtual WEAVE_ERROR
存储正在读取的数据列表项。
StoreItem(const uint64_t & aTag, nl::Weave::TLV::TLVReader & aDataReader)=0
virtual WEAVE_ERROR
根据标记存储数据项。

公共属性

mVersion

uint64_t mVersion

个人资料数据版本。

ProfileData 对象中给定的版本适用于特定实例的整个配置文件数据集。

公共函数

ProfileData

 ProfileData(
  void
)

ProfileData 的默认构造函数。

通过将新的 ProfileData 项的版本设置为 0 来初始化该项。

检索

virtual WEAVE_ERROR Retrieve(
  nl::Weave::TLV::TLVReader & aPathReader,
  nl::Weave::TLV::TLVWriter & aDataWriter
)=0

根据残余 WDM 路径写出数据项。

只要可在特定标记下访问 ProfileData 子类对象的各个元素，ProfileDatabase 子类实现者就必须为此方法提供具体实现。

具体说明
参数
[in] aPathReader
对位于 WDM 路径中的 TLV 读取器的引用，位于配置文件信息之后，即位于“残差”路径元素（如果有）的位置。
[in] aDataWriter
对 TLV 写入器的引用，用于写出残差路径所指示的数据。
返回值
WEAVE_NO_ERROR。成功时。否则，返回 WEAVE_ERROR，表示无法识别残差标记或写入相应数据。

存储

virtual WEAVE_ERROR Store(
  nl::Weave::TLV::TLVReader & aPathReader,
  uint64_t aVersion,
  nl::Weave::TLV::TLVReader & aDataReader
)

存储正在读取的数据列表项。

此虚拟方法用于将特定的数据列表项存储在具体 ProfileData 子类的对象中。如果对象是简单且“浅层”的对象，且只有路径包含一个元素，则可以使用父类中的实现。对于更复杂的架构，实现人员应替换此方法。

具体说明
参数
[in] aPathReader
对位于数据列表项的路径组件处的 TLV 读取器的引用。
[in] aVersion
数据列表项的 64 位版本组件。
[in] aDataReader
对位于数据列表项的数据组件的 TLV 读取器的引用。
返回值
WEAVE_NO_ERROR。成功时。否则，返回 WEAVE_ERROR，表示未能存储相关数据。

StoreItem

virtual WEAVE_ERROR StoreItem(
  const uint64_t & aTag,
  nl::Weave::TLV::TLVReader & aDataReader
)=0

根据标记存储数据项。

具体说明
参数
[in] aTag
对应在其中存储数据的完全限定 64 位 TLV 标记的引用。
[in] aDataReader
位于要存储的数据项的 TLV 读取器。
返回值
如果成功，则返回 WEAVE_NO_ERROR；否则，返回 WEAVE_ERROR，表示无法识别标记或存储数据。

~ProfileData

virtual  ~ProfileData(
  void
)

ProfileData 的析构函数。

与构造函数一样，这只是将数据版本清除为 0。