nl:: Weave:: Profiles:: DataManagement_Current:: TraitSchemaEngine
#include <src/lib/profiles/data-management/Current/TraitData.h>
Mesin skema mengambil informasi skema yang terkait dengan ciri tertentu dan menyediakan fasilitas untuk mengurai dan menerjemahkannya ke dalam bentuk yang dapat digunakan oleh mesin WDM.
Ringkasan
Hal ini termasuk mengonversi dari PathHandles ke jalur WDM (dan sebaliknya), metode untuk menafsirkan/menjalankan kueri skema itu sendiri dan metode untuk membantu membaca/menulis data ke/dari TLV dengan handle.
Skema itu sendiri disimpan dalam bentuk tabel, yang dijelaskan secara memadai untuk memungkinkan penguraian/komposisi umum jalur/data WDM untuk karakteristik tertentu. Tabel ini akan menjadi hasil akhir dari 'code-gen' (Istilah itu sendiri agak menyesatkan mengingat tidak adanya kode yang dihasilkan :P)
Atribut statis publik |
|
---|---|
kHandleTableOffset = 2
|
const uint32_t
|
Atribut publik |
|
---|---|
mSchema
|
const Schema
|
Fungsi publik |
|
---|---|
FindLowestCommonAncestor(PropertyPathHandle aHandle1, PropertyPathHandle aHandle2, PropertyPathHandle *aHandle1BranchChild, PropertyPathHandle *aHandle2BranchChild) const
|
Dengan mempertimbangkan dua handle properti, hitung handle terendah yang berfungsi sebagai induk dari kedua handle tersebut.
|
GetChildHandle(PropertyPathHandle aParentHandle, uint8_t aContextTag) const
|
|
GetDepth(PropertyPathHandle aHandle) const
|
int32_t
Hitung kedalaman dalam hierarki skema untuk handle tertentu.
|
GetDictionaryItemHandle(PropertyPathHandle aParentHandle, uint16_t aDictionaryKey) const
|
|
GetFirstChild(PropertyPathHandle aParentHandle) const
|
Menampilkan handle turunan pertama yang terkait dengan induk tertentu.
|
GetHighestForwardVersion(SchemaVersion aVersion) const
|
SchemaVersion
Dengan mempertimbangkan versi skema data yang disediakan, versi ini akan menampilkan versi skema kompatibilitas dengan penerusan tertinggi.
|
GetLowestCompatibleVersion(SchemaVersion aVersion) const
|
SchemaVersion
Dengan mempertimbangkan versi skema data yang disediakan, versi ini akan menampilkan versi skema minimum yang kompatibel.
|
GetMap(PropertyPathHandle aHandle) const
|
const PropertyInfo *
Menampilkan pointer ke struktur PropertyInfo yang menjelaskan handle jalur tertentu.
|
GetMaxVersion() const
|
SchemaVersion
|
GetMinVersion() const
|
SchemaVersion
|
GetNextChild(PropertyPathHandle aParentId, PropertyPathHandle aChildHandle) const
|
Dengan mempertimbangkan handle untuk turunan yang ada, menampilkan handle turunan berikutnya yang terkait dengan induk tertentu.
|
GetParent(PropertyPathHandle aHandle) const
|
Menampilkan handle induk untuk handle jalur turunan yang ditentukan.
|
GetProfileId(void) const
|
uint32_t
Menampilkan ID profil dari trait yang terkait.
|
GetRelativePathTags(const PropertyPathHandle aCandidateHandle, uint64_t *aTags, const uint32_t aTagsSize, uint32_t & aNumTags) const
|
Mengonversi PropertyPathHandle ke array tag konteks.
|
GetTag(PropertyPathHandle aHandle) const
|
uint64_t
Menampilkan tag yang terkait dengan handle jalur.
|
GetVersionIntersection(SchemaVersionRange & aVersion, SchemaVersionRange & aIntersection) const
|
bool
Dengan mempertimbangkan rentang versi, fungsi ini memeriksa apakah ada persimpangan kompatibilitas antara keduanya dan apa yang didukung oleh skema yang mendukung mesin skema ini.
|
IsDictionary(PropertyPathHandle aHandle) const
|
bool
Menampilkan true jika handle adalah kamus (dan bukan dalam kamus - lihat metode di bawah).
|
IsEphemeral(PropertyPathHandle aHandle) const
|
bool
|
IsInDictionary(PropertyPathHandle aHandle, PropertyPathHandle & aDictionaryItemHandle) const
|
bool
Menampilkan true jika handle berada di dalam kamus (elemen kamus).
|
IsLeaf(PropertyPathHandle aPropertyHandle) const
|
bool
Menampilkan true jika handle merujuk ke node daun pada hierarki skema.
|
IsNullable(PropertyPathHandle aHandle) const
|
bool
|
IsOptional(PropertyPathHandle aHandle) const
|
bool
|
IsParent(PropertyPathHandle aChildHandle, PropertyPathHandle aParentHandle) const
|
bool
Memeriksa apakah nama sebutan channel tertentu adalah turunan dari nama sebutan channel lainnya.
|
MapHandleToPath(PropertyPathHandle aHandle, nl::Weave::TLV::TLVWriter & aPathWriter) const
|
Konversikan handle jalur ke jalur TLV.
|
MapPathToHandle(nl::Weave::TLV::TLVReader & aPathReader, PropertyPathHandle & aHandle) const
|
Dengan pembaca yang diposisikan di root elemen jalur WDM, baca tag yang relevan dan berikan handle jalur yang setara.
|
MapPathToHandle(const char *aPathString, PropertyPathHandle & aHandle) const
|
Dengan mempertimbangkan representasi string dari jalur WDM, baca tag yang relevan dan berikan handle jalur yang setara.
|
MatchesProfileId(uint32_t aProfileId) const
|
bool
Menampilkan true (benar) jika profileId yang diteruskan cocok dengan yang tersimpan di skema.
|
RetrieveData(PropertyPathHandle aHandle, uint64_t aTagToWrite, nl::Weave::TLV::TLVWriter & aWriter, IGetDataDelegate *aDelegate, IDirtyPathCut *apDirtyPathCut) const
|
Dengan mempertimbangkan handle jalur dan posisi penulis pada elemen data yang sesuai, ambil data daun dari sumber dan tulis ke dalam buffer yang ditunjuk oleh penulis dengan cara yang sesuai dengan skema.
|
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
|
Dengan mempertimbangkan handle jalur dan pembaca yang diposisikan pada elemen data yang sesuai, proses buffering data yang ditunjuk oleh pembaca dan simpan ke dalam sink dengan memanggil panggilan SetLeafData setiap kali item data leaf ditemukan.
|
Class |
|
---|---|
nl:: |
|
nl:: |
Struct |
|
---|---|
nl:: |
|
nl:: |
Struktur skema utama yang menampung informasi skema. |
Atribut statis publik
kHandleTableOffset
const uint32_t kHandleTableOffset = 2
Atribut publik
mSchema
const Schema mSchema
Fungsi publik
FindLowestCommonAncestor
PropertyPathHandle FindLowestCommonAncestor( PropertyPathHandle aHandle1, PropertyPathHandle aHandle2, PropertyPathHandle *aHandle1BranchChild, PropertyPathHandle *aHandle2BranchChild ) const
Dengan mempertimbangkan dua handle properti, hitung handle terendah yang berfungsi sebagai induk dari kedua handle tersebut.
Selain itu, tampilkan dua cabang turunan yang berisi masing-masing dari dua tuas (meskipun keduanya sama).
Detail | |||
---|---|---|---|
Nilai Pengembalian |
|
GetChildHandle
PropertyPathHandle GetChildHandle( PropertyPathHandle aParentHandle, uint8_t aContextTag ) const
GetDepth
int32_t GetDepth( PropertyPathHandle aHandle ) const
Hitung kedalaman dalam hierarki skema untuk handle tertentu.
Detail | |||
---|---|---|---|
Nilai Pengembalian |
|
GetDictionaryItemHandle
PropertyPathHandle GetDictionaryItemHandle( PropertyPathHandle aParentHandle, uint16_t aDictionaryKey ) const
GetFirstChild
PropertyPathHandle GetFirstChild( PropertyPathHandle aParentHandle ) const
Menampilkan handle turunan pertama yang terkait dengan induk tertentu.
Detail | |||
---|---|---|---|
Nilai Pengembalian |
|
GetHighestForwardVersion
SchemaVersion GetHighestForwardVersion( SchemaVersion aVersion ) const
Dengan mempertimbangkan versi skema data yang disediakan, versi ini akan menampilkan versi skema kompatibilitas dengan penerusan tertinggi.
GetLowestCompatibleVersion
SchemaVersion GetLowestCompatibleVersion( SchemaVersion aVersion ) const
Dengan mempertimbangkan versi skema data yang disediakan, versi ini akan menampilkan versi skema minimum yang kompatibel.
GetMap
const PropertyInfo * GetMap( PropertyPathHandle aHandle ) const
Menampilkan pointer ke struktur PropertyInfo yang menjelaskan handle jalur tertentu.
Detail | |||
---|---|---|---|
Nilai Pengembalian |
|
GetMaxVersion
SchemaVersion GetMaxVersion() const
GetMinVersion
SchemaVersion GetMinVersion() const
GetNextChild
PropertyPathHandle GetNextChild( PropertyPathHandle aParentId, PropertyPathHandle aChildHandle ) const
Dengan mempertimbangkan handle untuk turunan yang ada, menampilkan handle turunan berikutnya yang terkait dengan induk tertentu.
Detail | |||
---|---|---|---|
Nilai Pengembalian |
|
GetParent
PropertyPathHandle GetParent( PropertyPathHandle aHandle ) const
Menampilkan handle induk untuk handle jalur turunan yang ditentukan.
Kunci kamus dalam handle dipertahankan jika handle induk juga merupakan elemen kamus.
Detail | |||
---|---|---|---|
Nilai Pengembalian |
|
GetProfileId
uint32_t GetProfileId( void ) const
Menampilkan ID profil dari trait yang terkait.
Detail | |||
---|---|---|---|
Nilai Pengembalian |
|
GetRelativePathTags
WEAVE_ERROR GetRelativePathTags( const PropertyPathHandle aCandidateHandle, uint64_t *aTags, const uint32_t aTagsSize, uint32_t & aNumTags ) const
Mengonversi PropertyPathHandle ke array tag konteks.
Detail | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Hasil |
WEAVE_NO_ERROR jika berhasil; WEAVE_ERROR_NO_MEMORY jika aTags terlalu kecil untuk menyimpan jalur lengkap.
|
GetTag
uint64_t GetTag( PropertyPathHandle aHandle ) const
Menampilkan tag yang terkait dengan handle jalur.
Jika berupa elemen kamus, fungsi ini akan menampilkan ProfileTag. Jika tidak, class ini akan menampilkan tag konteks.
Detail | |||
---|---|---|---|
Nilai Pengembalian |
|
GetVersionIntersection
bool GetVersionIntersection( SchemaVersionRange & aVersion, SchemaVersionRange & aIntersection ) const
Dengan mempertimbangkan rentang versi, fungsi ini memeriksa apakah ada persimpangan kompatibilitas antara keduanya dan apa yang didukung oleh skema yang mendukung mesin skema ini.
Jika ada persimpangan, fungsi akan menampilkan nilai benar dan memperbarui argumen Intersection yang diteruskan untuk mencerminkan hasil pengujian persimpangan tersebut.
IsDictionary
bool IsDictionary( PropertyPathHandle aHandle ) const
Menampilkan true jika handle adalah kamus (dan bukan dalam kamus - lihat metode di bawah).
Detail | |||
---|---|---|---|
Nilai Pengembalian |
|
IsEphemeral
bool IsEphemeral( PropertyPathHandle aHandle ) const
IsInDictionary
bool IsInDictionary( PropertyPathHandle aHandle, PropertyPathHandle & aDictionaryItemHandle ) const
Menampilkan true jika handle berada di dalam kamus (elemen kamus).
Pengguna yang diteruskan dalam handle (aDictionaryItemHandle) diupdate untuk mengarah ke handle elemen kamus paling atas dalam kamus.
Detail | |||
---|---|---|---|
Nilai Pengembalian |
|
IsLeaf
bool IsLeaf( PropertyPathHandle aPropertyHandle ) const
Menampilkan true jika handle merujuk ke node daun pada hierarki skema.
Detail | |||
---|---|---|---|
Nilai Pengembalian |
|
IsNullable
bool IsNullable( PropertyPathHandle aHandle ) const
IsOptional
bool IsOptional( PropertyPathHandle aHandle ) const
IsParent
bool IsParent( PropertyPathHandle aChildHandle, PropertyPathHandle aParentHandle ) const
Memeriksa apakah nama sebutan channel tertentu adalah turunan dari nama sebutan channel lainnya.
Ini dapat berupa induk tidak langsung.
Detail | |||
---|---|---|---|
Nilai Pengembalian |
|
MapHandleToPath
WEAVE_ERROR MapHandleToPath( PropertyPathHandle aHandle, nl::Weave::TLV::TLVWriter & aPathWriter ) const
MapPathToHandle
WEAVE_ERROR MapPathToHandle( nl::Weave::TLV::TLVReader & aPathReader, PropertyPathHandle & aHandle ) const
Dengan pembaca yang diposisikan di root elemen jalur WDM, baca tag yang relevan dan berikan handle jalur yang setara.
Detail | |||||
---|---|---|---|---|---|
Nilai Pengembalian |
|
MapPathToHandle
WEAVE_ERROR MapPathToHandle( const char *aPathString, PropertyPathHandle & aHandle ) const
Dengan mempertimbangkan representasi string dari jalur WDM, baca tag yang relevan dan berikan handle jalur yang setara.
Jalur WDM direpresentasikan sebagai string menggunakan aturan berikut:
- tag dipisahkan dengan
/
- jalur HARUS diawali dengan
/
di depan dan TIDAK BOLEH berisi garis miring di akhir - tag numerik di jalur WDM HARUS dienkode menggunakan library C standar untuk encoding bilangan bulat ke string, yaitu encoding desimal (default) TIDAK BOLEH berisi 0 di depan, encoding heksadesimal HARUS diawali dengan
0x
, dan encoding oktal HARUS berisi0
awal.
Detail | |||||||
---|---|---|---|---|---|---|---|
Nilai Pengembalian |
|
MatchesProfileId
bool MatchesProfileId( uint32_t aProfileId ) const
Menampilkan true (benar) jika profileId yang diteruskan cocok dengan yang tersimpan di skema.
Detail | |||
---|---|---|---|
Nilai Pengembalian |
|
RetrieveData
WEAVE_ERROR RetrieveData( PropertyPathHandle aHandle, uint64_t aTagToWrite, nl::Weave::TLV::TLVWriter & aWriter, IGetDataDelegate *aDelegate, IDirtyPathCut *apDirtyPathCut ) const
Dengan mempertimbangkan handle jalur dan posisi penulis pada elemen data yang sesuai, ambil data daun dari sumber dan tulis ke dalam buffer yang ditunjuk oleh penulis dengan cara yang sesuai dengan skema.
Detail | |||||
---|---|---|---|---|---|
Nilai Pengembalian |
|
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
Dengan mempertimbangkan handle jalur dan pembaca yang diposisikan pada elemen data yang sesuai, proses buffering data yang ditunjuk oleh pembaca dan simpan ke dalam sink dengan memanggil panggilan SetLeafData setiap kali item data leaf ditemukan.
Detail | |||||
---|---|---|---|---|---|
Nilai Pengembalian |
|