本頁面由 Cloud Translation API 翻譯而成。

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

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

結構定義引擎會採用與特定特徵相關聯的結構定義資訊，並提供可剖析及轉譯成 WDM 機制可用的格式的設施。

摘要

這包括從 PathHandle 轉換為 WDM 路徑 (反之亦然)、解讀/查詢結構定義本身的方法，以及在提供句柄時，協助讀取/寫入 TLV 資料的方法。

結構定義本身會以表格形式儲存，並提供充分描述，讓您針對任何給定特徵，執行 WDM 路徑/資料的一般剖析/組合作業。這些資料表是「code-gen」的最終輸出內容 (由於沒有任何產生的程式碼，這個詞本身有點誤導性 :P)

公開的靜態屬性
`kHandleTableOffset = 2`	`const uint32_t`

公開屬性
`mSchema`	`const Schema`

公開函式
`FindLowestCommonAncestor(PropertyPathHandle aHandle1, PropertyPathHandle aHandle2, PropertyPathHandle aHandle1BranchChild, PropertyPathHandle aHandle2BranchChild) const`	`PropertyPathHandle` 指定兩個屬性控點，計算做為兩個控制站的父項最低控制代碼。
`GetChildHandle(PropertyPathHandle aParentHandle, uint8_t aContextTag) const`	`PropertyPathHandle`
`GetDepth(PropertyPathHandle aHandle) const`	`int32_t` 計算特定句柄在結構樹中的深度。
`GetDictionaryItemHandle(PropertyPathHandle aParentHandle, uint16_t aDictionaryKey) const`	`PropertyPathHandle`
`GetFirstChild(PropertyPathHandle aParentHandle) const`	`PropertyPathHandle` 傳回與特定父項相關聯的第一個子項句柄。
`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`	`PropertyPathHandle` 為現有子項的控制代碼傳回與特定父項相關聯的下一個子項控制代碼。
`GetParent(PropertyPathHandle aHandle) const`	`PropertyPathHandle` 傳回指定子路徑句柄的父項句柄。
`GetProfileId(void) const`	`uint32_t` 傳回關聯特徵的設定檔 ID。
`GetRelativePathTags(const PropertyPathHandle aCandidateHandle, uint64_t *aTags, const uint32_t aTagsSize, uint32_t & aNumTags) const`	`WEAVE_ERROR` 將 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` 如果句柄「位於」字典 (字典元素) 中，則傳回「是」。
`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`	`WEAVE_ERROR` 將路徑控點轉換為 TLV 路徑。
`MapPathToHandle(nl::Weave::TLV::TLVReader & aPathReader, PropertyPathHandle & aHandle) const`	`WEAVE_ERROR` 假設讀取器位於 WDM 路徑元素的根目錄，請讀取相關標記，並提供等效的路徑句柄。
`MapPathToHandle(const char *aPathString, PropertyPathHandle & aHandle) const`	`WEAVE_ERROR` 提供 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`	`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`	`WEAVE_ERROR` 在路徑句柄和位於對應資料元素上的讀取器的情況下，請處理讀取器所指向的資料緩衝區，並在遇到葉節資料項目時，透過呼叫 SetLeafData 呼叫將資料緩衝區儲存到接收器。

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

Structs
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

指定兩個屬性控點，計算做為兩個控制站的父項最低控制代碼。

此外，請傳回包含這兩個句柄的兩個子項 (即使兩者相同)。

詳細資料

傳回值

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`	寫入標記的標記數量

傳回

如果成功，則為 WEAVE_NO_ERROR；如果 aTags 太小，無法儲存完整路徑，則為 WEAVE_ERROR_NO_MEMORY。

GetTag

uint64_t GetTag(
  PropertyPathHandle aHandle
) const

傳回與路徑句柄相關聯的標記。

如果是字典元素，這個函式會傳回 ProfileTag。否則會傳回內容代碼。

詳細資料

傳回值

uint64_t

GetVersionIntersection

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

在指定版本範圍後，這個函式會檢查該範圍與此結構定義引擎所支援的結構定義之間是否有相容性交集。

如果有交集，函式會傳回 true，並更新傳入的 aIntersection 引數，以反映交集測試的結果。

IsDictionary

bool IsDictionary(
  PropertyPathHandle aHandle
) const

如果句柄是字典 (且不在字典中，請參閱下方方法)，則傳回 true。

詳細資料

傳回值

bool

IsEphemeral

bool IsEphemeral(
  PropertyPathHandle aHandle
) const

IsInDictionary

bool IsInDictionary(
  PropertyPathHandle aHandle,
  PropertyPathHandle & aDictionaryItemHandle
) const

如果句柄「位於」字典 (字典元素) 中，則傳回「是」。

傳入控點 (aDictionaryItemHandle) 的使用者會更新為指向字典內最頂層的字典元素控制代碼。

詳細資料

傳回值

bool

IsLeaf

bool IsLeaf(
  PropertyPathHandle aPropertyHandle
) const

如果句柄參照的是結構定義樹狀結構中的葉結點，則傳回「是」。

詳細資料

傳回值

bool

IsNullable

bool IsNullable(
  PropertyPathHandle aHandle
) const

IsOptional

bool IsOptional(
  PropertyPathHandle aHandle
) const

IsParent

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 路徑元素的根目錄，請讀取相關標記，並提供等效的路徑句柄。

詳細資料

傳回值

`WEAVE_NO_ERROR`	成功時。
`WEAVE_ERROR_TLV_TAG_NOT_FOUND`	如果因路徑格式不正確/指定錯誤而無法找到相符的句柄，

MapPathToHandle

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

提供 WDM 路徑的字串表示法，讀出相關標記，並提供等效的路徑句柄。

WDM 路徑會以字串表示，並遵循下列規則：

標記以 / 分隔
路徑「必須」以開頭的 / 為開頭，且結尾不得為斜線
WDM 路徑中的數字標記必須使用標準 C 程式庫進行整數至字串的編碼，也就是說，十進制編碼 (預設) 不得包含開頭 0，十六進制編碼必須以 0x 開頭，而八進制編碼則必須包含開頭 0。

詳細資料

傳回值

`WEAVE_NO_ERROR`	成功時。
`WEAVE_ERROR_TLV_TAG_NOT_FOUND`	如果找不到相符的句柄，
`WEAVE_ERROR_INVALID_ARGUMENT`	如果路徑字串格式錯誤

MatchesProfileId

bool MatchesProfileId(
  uint32_t aProfileId
) const

如果傳入的 profileId 與儲存在結構定義中的相符，則傳回 true。

詳細資料

傳回值

bool

RetrieveData

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

StoreData

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

在路徑句柄和位於對應資料元素上的讀取器的情況下，請處理讀取器所指向的資料緩衝區，並在遇到葉節資料項目時，透過呼叫 SetLeafData 呼叫將資料緩衝區儲存到接收器。

詳細資料

傳回值

`WEAVE_NO_ERROR`	成功時。
`other`	剖析/處理資料時發生錯誤。

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

摘要

公開的靜態屬性

公開屬性

公開函式

類別

Structs

公開靜態屬性

kHandleTableOffset

公開屬性

mSchema

公開函式

FindLowestCommonAncestor

GetChildHandle

GetDepth

GetDictionaryItemHandle

GetFirstChild

GetHighestForwardVersion

GetLowestCompatibleVersion

GetMap

GetMaxVersion

GetMinVersion

GetNextChild

GetParent

GetProfileId

GetRelativePathTags

GetTag

GetVersionIntersection

IsDictionary

IsEphemeral

IsInDictionary

IsLeaf

IsNullable

IsOptional

IsParent

MapHandleToPath

MapPathToHandle

MapPathToHandle

MatchesProfileId

RetrieveData

RetrieveUpdatableDictionaryData

StoreData