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 にクリアされるだけです。