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 パスが与えられたときに、データアイテムを書き出します。

ProfileDatabase サブクラスの実装者は、ProfileData サブクラス オブジェクトの個々の要素に特定のタグでアクセスできる常にこのメソッドの具体的な実装を提供する必要があります。

詳細
パラメータ
[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 サブクラスのオブジェクトに格納するために使用されます。このスーパークラスの実装は、オブジェクトがシンプルで「浅い」場合、要素の長さが 1 つのパスのみである場合に使用できます。より複雑なスキーマの場合、実装者はこのメソッドをオーバーライドする必要があります。

詳細
パラメータ
[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 にクリアされるだけです。