Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

nl::Weave::Profiles::DataManagement_Current::TraitSchemaEngine

#include <src/lib/profiles/data-management/Current/TraitData.h>

スキーマ エンジンは、特定のトレイトに関連付けられているスキーマ情報を取得し、それを解析して WDM マシンで使用できる形式に変換する機能を提供します。

まとめ

これには、PathHandles から WDM パス(またはその逆)への変換、スキーマ自体の解釈とクエリを行うためのメソッド、ハンドルを指定して TLV との間でデータを読み書きするためのメソッドが含まれます。

スキーマ自体は表形式で保存されており、任意のトレイトの WDM パス/データを汎用的に解析/コンポーズできるようになっています。以下の表は、'code-gen&#39 の最終的な出力です。(生成されたコードが存在しないことから、この用語自体は多少誤解を招く可能性があります)

公開静的属性

kHandleTableOffset = 2
const uint32_t

パブリック属性

mSchema
const Schema

パブリック関数

FindLowestCommonAncestor(PropertyPathHandle aHandle1, PropertyPathHandle aHandle2, PropertyPathHandle *aHandle1BranchChild, PropertyPathHandle *aHandle2BranchChild) const
2 つのプロパティ ハンドルを指定して、この両方のハンドルの親として機能する最も低いハンドルを計算します。
GetChildHandle(PropertyPathHandle aParentHandle, uint8_t aContextTag) const
GetDepth(PropertyPathHandle aHandle) const
int32_t
特定のハンドルのスキーマ ツリーの深さを計算します。
GetDictionaryItemHandle(PropertyPathHandle aParentHandle, uint16_t aDictionaryKey) const
GetFirstChild(PropertyPathHandle aParentHandle) const
特定の親に関連付けられた最初の子ハンドルを返します。
GetHighestForwardVersion(SchemaVersion aVersion) const
SchemaVersion
指定されたデータスキーマ バージョンに対応すると、上位互換性があるスキーマ バージョンが返されます。
GetLowestCompatibleVersion(SchemaVersion aVersion) const
SchemaVersion
指定されたデータスキーマ バージョンの場合、互換性のある最小スキーマ バージョンが返されます。
GetMap(PropertyPathHandle aHandle) const
const PropertyInfo *
特定のパスハンドルを記述する PropertyInfo 構造体へのポインタを返します。
GetMaxVersion() const
SchemaVersion
GetMinVersion() const
SchemaVersion
GetNextChild(PropertyPathHandle aParentId, PropertyPathHandle aChildHandle) const
既存の子に対するハンドルを指定すると、特定の親に関連付けられた次の子ハンドルを返します。
GetParent(PropertyPathHandle aHandle) const
指定した子パスのハンドルの親ハンドルを返します。
GetProfileId(void) const
uint32_t
関連するトレイトのプロファイル ID を返します。
GetRelativePathTags(const PropertyPathHandle aCandidateHandle, uint64_t *aTags, const uint32_t aTagsSize, uint32_t & aNumTags) const
PropertyPathHandle をコンテキスト タグの配列に変換します。
GetTag(PropertyPathHandle aHandle) const
uint64_t
パスハンドルに関連付けられたタグを返します。
GetVersionIntersection(SchemaVersionRange & aVersion, SchemaVersionRange & aIntersection) const
bool
バージョンの範囲が指定されると、この関数は、このスキーマ エンジンを支えるスキーマでサポートされているバージョンと、このバージョンとの間に互換性があるかどうかを検証します。
IsDictionary(PropertyPathHandle aHandle) const
bool
ハンドルが辞書である(辞書ではなく)場合は、true を返します。以下のメソッドを参照してください。
IsEphemeral(PropertyPathHandle aHandle) const
bool
IsInDictionary(PropertyPathHandle aHandle, PropertyPathHandle & aDictionaryItemHandle) const
bool
ハンドルが辞書(辞書要素)の内側の場合、true を返します。
IsLeaf(PropertyPathHandle aPropertyHandle) const
bool
ハンドルがスキーマツリーのリーフノードを参照している場合、true を返します。
IsNullable(PropertyPathHandle aHandle) const
bool
IsOptional(PropertyPathHandle aHandle) const
bool
IsParent(PropertyPathHandle aChildHandle, PropertyPathHandle aParentHandle) const
bool
指定されたハンドルが別のハンドルの子かどうかを確認します。
MapHandleToPath(PropertyPathHandle aHandle, nl::Weave::TLV::TLVWriter & aPathWriter) const
パスハンドルを TLV パスに変換します。
MapPathToHandle(nl::Weave::TLV::TLVReader & aPathReader, PropertyPathHandle & aHandle) const
リーダーを WDM パス要素のルートに配置したら、関連するタグを読み取って、同等のパスハンドルを指定します。
MapPathToHandle(const char *aPathString, PropertyPathHandle & aHandle) const
WDM パスの文字列表現に応じて、関連するタグを読み取って、同等のパスハンドルを指定します。
MatchesProfileId(uint32_t aProfileId) const
bool
渡された profileId がスキーマに保存されているものと一致する場合に true を返します。
RetrieveData(PropertyPathHandle aHandle, uint64_t aTagToWrite, nl::Weave::TLV::TLVWriter & aWriter, IGetDataDelegate *aDelegate, IDirtyPathCut *apDirtyPathCut) const
対応するデータ要素に対するパスハンドルとライター位置を考慮して、ソースからリーフデータを取得し、スキーマを遵守する方法でライターが参照するバッファに書き込みます。
RetrieveUpdatableDictionaryData(PropertyPathHandle aHandle, uint64_t aTagToWrite, nl::Weave::TLV::TLVWriter & aWriter, IGetDataDelegate *aDelegate, PropertyPathHandle & aPropertyPathHandleOfDictItemToStartFrom) const
StoreData(PropertyPathHandle aHandle, nl::Weave::TLV::TLVReader & aReader, ISetDataDelegate *aDelegate, IPathFilter *aPathFilter) const
パスハンドルと、対応するデータ要素に配置されたリーダーが設定されたら、リーダーが指すデータバッファを処理し、リーフデータ アイテムが見つかるたびに SetLeafData 呼び出しを行ってシンクに格納します。

クラス

nl::Weave::Profiles::DataManagement_Current::TraitSchemaEngine::IGetDataDelegate
nl::Weave::Profiles::DataManagement_Current::TraitSchemaEngine::ISetDataDelegate

構造体

nl::Weave::Profiles::DataManagement_Current::TraitSchemaEngine::PropertyInfo
nl::Weave::Profiles::DataManagement_Current::TraitSchemaEngine::Schema

スキーマ情報を格納する主なスキーマ構造。

公開静的属性

kHandleTableOffset

const uint32_t kHandleTableOffset = 2

パブリック属性

mSchema

const Schema mSchema

パブリック関数

FindLowestCommonAncestor

PropertyPathHandle FindLowestCommonAncestor(
  PropertyPathHandle aHandle1,
  PropertyPathHandle aHandle2,
  PropertyPathHandle *aHandle1BranchChild,
  PropertyPathHandle *aHandle2BranchChild
) const 

2 つのプロパティ ハンドルを指定して、この両方のハンドルの親として機能する最も低いハンドルを計算します。

さらに、同じハンドルであっても、2 つのハンドルのそれぞれを含む 2 つの子ブランチを返します。

詳細
戻り値
PropertyPathHandle
一番下の親(親)に対応してください。

GetChildHandle

PropertyPathHandle GetChildHandle(
  PropertyPathHandle aParentHandle,
  uint8_t aContextTag
) const 

GetDepth

int32_t GetDepth(
  PropertyPathHandle aHandle
) const 

特定のハンドルのスキーマ ツリーの深さを計算します。

詳細
戻り値
int32_t
木の深さ

GetDictionaryItemHandle

PropertyPathHandle GetDictionaryItemHandle(
  PropertyPathHandle aParentHandle,
  uint16_t aDictionaryKey
) const 

GetFirstChild に対するリクエスト メッセージ

PropertyPathHandle GetFirstChild(
  PropertyPathHandle aParentHandle
) const 

特定の親に関連付けられた最初の子ハンドルを返します。

詳細
戻り値
PropertyPathHandle
最初の子のハンドル。

GetHighestForwardVersion

SchemaVersion GetHighestForwardVersion(
  SchemaVersion aVersion
) const 

指定されたデータスキーマ バージョンに対応すると、上位互換性があるスキーマ バージョンが返されます。

GetLowestCompatibleVersion

SchemaVersion GetLowestCompatibleVersion(
  SchemaVersion aVersion
) const 

指定されたデータスキーマ バージョンの場合、互換性のある最小スキーマ バージョンが返されます。

GetMap

const PropertyInfo * GetMap(
  PropertyPathHandle aHandle
) const 

特定のパスハンドルを記述する PropertyInfo 構造体へのポインタを返します。

詳細
戻り値
PropertyInfo*

GetMaxVersion

SchemaVersion GetMaxVersion() const 

GetMinVersion

SchemaVersion GetMinVersion() const 

GetNextChild:

PropertyPathHandle GetNextChild(
  PropertyPathHandle aParentId,
  PropertyPathHandle aChildHandle
) const 

既存の子に対するハンドルを指定すると、特定の親に関連付けられた次の子ハンドルを返します。

詳細
戻り値
PropertyPathHandle
次の子のハンドル。

GetParent

PropertyPathHandle GetParent(
  PropertyPathHandle aHandle
) const 

指定した子パスのハンドルの親ハンドルを返します。

親ハンドルが辞書要素の場合、ハンドルの辞書キーが保持されます。

詳細
戻り値
PropertyPathHandle
親のハンドル。

GetProfileId

uint32_t GetProfileId(
  void
) const 

関連するトレイトのプロファイル ID を返します。

詳細
戻り値
Trait
プロフィール ID

GetRelativePathTags

WEAVE_ERROR GetRelativePathTags(
  const PropertyPathHandle aCandidateHandle,
  uint64_t *aTags,
  const uint32_t aTagsSize,
  uint32_t & aNumTags
) const 

PropertyPathHandle をコンテキスト タグの配列に変換します。

詳細
パラメータ
[in] aCandidateHandle
変換される PropertyPathHandle。
[in] aTags
出力配列へのポインタ。
[in] aTagsSize
aTags 配列のサイズ(要素数)。
[out] aNumTags
aTag に書き込まれるタグの数
戻り値
成功した場合は WEAVE_NO_ERROR。aTag が小さすぎてフルパスを保存できない場合は WEAVE_ERROR_NO_MEMORY。

GetTag

uint64_t GetTag(
  PropertyPathHandle aHandle
) const 

パスハンドルに関連付けられたタグを返します。

辞書要素の場合、この関数は ProfileTag を返します。それ以外の場合は、コンテキスト タグを返します。

詳細
戻り値
uint64_t

GetVersionIntersection

bool GetVersionIntersection(
  SchemaVersionRange & aVersion,
  SchemaVersionRange & aIntersection
) const 

バージョンの範囲が指定されると、この関数は、このスキーマ エンジンを支えるスキーマでサポートされているバージョンと、このバージョンとの間に互換性があるかどうかを検証します。

交差点がある場合、この関数は true を返し、渡された aIntersection 引数を更新して、その交差点テストの結果を反映したものになります。

辞書

bool IsDictionary(
  PropertyPathHandle aHandle
) const 

ハンドルが辞書である(辞書ではなく)場合は、true を返します。以下のメソッドを参照してください。

詳細
戻り値
bool

IsEphemeral

bool IsEphemeral(
  PropertyPathHandle aHandle
) const 

IsInDictionary

bool IsInDictionary(
  PropertyPathHandle aHandle,
  PropertyPathHandle & aDictionaryItemHandle
) const 

ハンドルが辞書(辞書要素)の内側の場合、true を返します。

ハンドル(aDictionaryItemHandle)で渡されたユーザーが、辞書の一番上にある辞書要素ハンドルを指すように更新されます。

詳細
戻り値
bool

リーフ

bool IsLeaf(
  PropertyPathHandle aPropertyHandle
) const 

ハンドルがスキーマツリーのリーフノードを参照している場合、true を返します。

詳細
戻り値
bool

IsNullable

bool IsNullable(
  PropertyPathHandle aHandle
) const 

任意

bool IsOptional(
  PropertyPathHandle aHandle
) const 

bool IsParent(
  PropertyPathHandle aChildHandle,
  PropertyPathHandle aParentHandle
) const 

指定されたハンドルが別のハンドルの子かどうかを確認します。

間接的な親になる場合もあります。

詳細
戻り値
bool

MapHandleToPath

WEAVE_ERROR MapHandleToPath(
  PropertyPathHandle aHandle,
  nl::Weave::TLV::TLVWriter & aPathWriter
) const 

パスハンドルを TLV パスに変換します。

詳細
戻り値
WEAVE_NO_ERROR
成功
other
ハンドルを TLV パスに変換できなかった

MapPathToHandle

WEAVE_ERROR MapPathToHandle(
  nl::Weave::TLV::TLVReader & aPathReader,
  PropertyPathHandle & aHandle
) const 

リーダーを WDM パス要素のルートに配置したら、関連するタグを読み取って、同等のパスハンドルを指定します。

Details
戻り値
WEAVE_NO_ERROR
成功
WEAVE_ERROR_TLV_TAG_NOT_FOUND
パスの形式が正しくないか正しくないため、一致するハンドルが見つからなかった。

MapPathToHandle

WEAVE_ERROR MapPathToHandle(
  const char *aPathString,
  PropertyPathHandle & aHandle
) const 

WDM パスの文字列表現に応じて、関連するタグを読み取って、同等のパスハンドルを指定します。

WDM パスは、次のルールを使用して文字列として表されます。

  • タグは / で区切ります
  • パスは、先頭の / で始まり、末尾のスラッシュを含んではなりません。
  • WDM パスの数値タグは、整数から文字列へのエンコードに、標準の C ライブラリを使用してエンコードしなければなりません。つまり、10 進数のエンコード(デフォルト)には 0 を含まず、16 進数のエンコードは 0x で始まり、8 進数のエンコードは先頭の 0 を含まなければなりません。

詳細
戻り値
WEAVE_NO_ERROR
成功
WEAVE_ERROR_TLV_TAG_NOT_FOUND
一致するハンドルが見つからなかった場合。
WEAVE_ERROR_INVALID_ARGUMENT
パス文字列の形式が正しくない

MATCHS プロファイル ID

bool MatchesProfileId(
  uint32_t aProfileId
) const 

渡された profileId がスキーマに保存されているものと一致する場合に true を返します。

詳細
戻り値
bool

データの取得

WEAVE_ERROR RetrieveData(
  PropertyPathHandle aHandle,
  uint64_t aTagToWrite,
  nl::Weave::TLV::TLVWriter & aWriter,
  IGetDataDelegate *aDelegate,
  IDirtyPathCut *apDirtyPathCut
) const 

対応するデータ要素に対するパスハンドルとライター位置を考慮して、ソースからリーフデータを取得し、スキーマを遵守する方法でライターが参照するバッファに書き込みます。

詳細
戻り値
WEAVE_NO_ERROR
成功
other
データの書き込み中にエラーが発生しました。

RetrieveUpdatableDictionaryData

WEAVE_ERROR RetrieveUpdatableDictionaryData(
  PropertyPathHandle aHandle,
  uint64_t aTagToWrite,
  nl::Weave::TLV::TLVWriter & aWriter,
  IGetDataDelegate *aDelegate,
  PropertyPathHandle & aPropertyPathHandleOfDictItemToStartFrom
) const 

データ保存

WEAVE_ERROR StoreData(
  PropertyPathHandle aHandle,
  nl::Weave::TLV::TLVReader & aReader,
  ISetDataDelegate *aDelegate,
  IPathFilter *aPathFilter
) const 

パスハンドルと、対応するデータ要素に配置されたリーダーが設定されたら、リーダーが指すデータバッファを処理し、リーフデータ アイテムが見つかるたびに SetLeafData 呼び出しを行ってシンクに格納します。

詳細
戻り値
WEAVE_NO_ERROR
成功
other
データの解析/処理中にエラーが発生しました。