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

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

Die Schema-Engine nimmt Schemainformationen, die mit einem bestimmten Merkmal verknüpft sind, und bietet Funktionen zum Parsen und Übersetzen dieser Informationen in ein Formular, das von der WDM-Maschine verwendet werden kann.

Zusammenfassung

Dazu gehören das Konvertieren von PathHandles- in WDM-Pfaden (und umgekehrt), Methoden zum Interpretieren/Abfragen des Schemas selbst und Methoden zum Lesen/Schreiben von Daten in TLV mit einem Handle.

Das Schema selbst wird in tabellarischer Form gespeichert und ausreichend beschrieben, um ein generisches Parsen/Zusammensetzen von WDM-Pfaden und ‐Daten für ein bestimmtes Merkmal zu ermöglichen. Diese Tabellen sind die letztendliche Ausgabe von "code-gen" (der Begriff selbst ist etwas irreführend, da kein generierter Code vorhanden ist :P).

Öffentliche statische Attribute
kHandleTableOffset = 2
const uint32_t

Öffentliche Attribute
mSchema
const Schema

Öffentliche Funktionen
FindLowestCommonAncestor(PropertyPathHandle aHandle1, PropertyPathHandle aHandle2, PropertyPathHandle *aHandle1BranchChild, PropertyPathHandle *aHandle2BranchChild) const
Berechne bei zwei Property-Handles den niedrigsten Handle, der beiden Aliassen als übergeordnetes Element dient.
GetChildHandle(PropertyPathHandle aParentHandle, uint8_t aContextTag) const
GetDepth(PropertyPathHandle aHandle) const
int32_t
Berechnet die Tiefe im Schemabaum für einen bestimmten Handle.
GetDictionaryItemHandle(PropertyPathHandle aParentHandle, uint16_t aDictionaryKey) const
GetFirstChild(PropertyPathHandle aParentHandle) const
Gibt den ersten untergeordneten Handle zurück, der mit einem bestimmten übergeordneten Element verknüpft ist.
GetHighestForwardVersion(SchemaVersion aVersion) const
SchemaVersion
Bei einer bereitgestellten Datenschemaversion wird die höchste aufwärtskompatible Schemaversion zurückgegeben.
GetLowestCompatibleVersion(SchemaVersion aVersion) const
SchemaVersion
Bei einer angegebenen Datenschemaversion wird die niedrigste kompatible Schemaversion zurückgegeben.
GetMap(PropertyPathHandle aHandle) const
const PropertyInfo *
Gibt einen Verweis auf die PropertyInfo-Struktur zurück, die ein bestimmtes Pfad-Handle beschreibt.
GetMaxVersion() const
SchemaVersion
GetMinVersion() const
SchemaVersion
GetNextChild(PropertyPathHandle aParentId, PropertyPathHandle aChildHandle) const
Gibt bei einem Handle auf ein vorhandenes untergeordnetes Element das nächste untergeordnete Handle zurück, das mit einem bestimmten übergeordneten Element verknüpft ist.
GetParent(PropertyPathHandle aHandle) const
Gibt das übergeordnete Handle eines bestimmten untergeordneten Pfad-Handles zurück
GetProfileId(void) const
uint32_t
Gibt die Profil-ID des verknüpften Merkmals zurück
GetRelativePathTags(const PropertyPathHandle aCandidateHandle, uint64_t *aTags, const uint32_t aTagsSize, uint32_t & aNumTags) const
Wandelt einen PropertyPathHandle in ein Array von Kontexttags um.
GetTag(PropertyPathHandle aHandle) const
uint64_t
Gibt das Tag zurück, das mit einem Pfad-Handle verknüpft ist.
GetVersionIntersection(SchemaVersionRange & aVersion, SchemaVersionRange & aIntersection) const
bool
Bei einem bestimmten Versionsbereich prüft diese Funktion, ob es einen Kompatibilitätsüberschneidungstyp zwischen dem Versionsbereich und dem gibt, was von dem Schema unterstützt wird, das diese Schema-Engine unterstützt.
IsDictionary(PropertyPathHandle aHandle) const
bool
Gibt „true“ zurück, wenn der Handle ein Wörterbuch ist (und nicht in einem Wörterbuch). Siehe Methode unten.
IsEphemeral(PropertyPathHandle aHandle) const
bool
IsInDictionary(PropertyPathHandle aHandle, PropertyPathHandle & aDictionaryItemHandle) const
bool
Gibt „true“ zurück, wenn sich der Handle in einem Wörterbuch (einem Wörterbuchelement) befindet.
IsLeaf(PropertyPathHandle aPropertyHandle) const
bool
Gibt „true“ zurück, wenn der Handle auf einen Blattknoten im Schemabaum verweist.
IsNullable(PropertyPathHandle aHandle) const
bool
IsOptional(PropertyPathHandle aHandle) const
bool
IsParent(PropertyPathHandle aChildHandle, PropertyPathHandle aParentHandle) const
bool
Überprüft, ob ein bestimmter Alias einem anderen untergeordnet ist.
MapHandleToPath(PropertyPathHandle aHandle, nl::Weave::TLV::TLVWriter & aPathWriter) const
Wandeln Sie das Pfad-Handle in einen TLV-Pfad um.
MapPathToHandle(nl::Weave::TLV::TLVReader & aPathReader, PropertyPathHandle & aHandle) const
Wenn sich ein Reader im Stamm eines WDM-Pfadelements befindet, lesen Sie die relevanten Tags aus und geben Sie den entsprechenden Pfad-Handle an.
MapPathToHandle(const char *aPathString, PropertyPathHandle & aHandle) const
Bei der Darstellung eines WDM-Pfads als String werden die relevanten Tags ausgelesen und der entsprechende Pfad-Handle bereitgestellt.
MatchesProfileId(uint32_t aProfileId) const
bool
Gibt "true" zurück, wenn die in der Funktion "profileId" übergebene ID mit der im Schema gespeicherten übereinstimmt.
RetrieveData(PropertyPathHandle aHandle, uint64_t aTagToWrite, nl::Weave::TLV::TLVWriter & aWriter, IGetDataDelegate *aDelegate, IDirtyPathCut *apDirtyPathCut) const
Rufen Sie mit einem Pfad-Handle und einer Schreibposition im entsprechenden Datenelement Blattdaten aus der Quelle ab und schreiben Sie sie schematisch in den Zwischenspeicher, auf den der Schreiber verweist.
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
Bei einem Pfad-Handle und einem Reader, der auf dem entsprechenden Datenelement positioniert ist, wird der Datenpuffer, auf den der Leser zeigt, verarbeitet und in der Senke gespeichert, indem der SetLeafData-Aufruf immer dann aufgerufen wird, wenn ein Blatt-Datenelement gefunden wird.

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

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

Die Hauptschemastruktur, die die Schemainformationen enthält.

Öffentliche statische Attribute

kHandleTableOffset

const uint32_t kHandleTableOffset = 2

Öffentliche Attribute

mSchema

const Schema mSchema

Öffentliche Funktionen

FindLowestCommonAncestor

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

Berechne bei zwei Property-Handles den niedrigsten Handle, der beiden Aliassen als übergeordnetes Element dient.

Geben Sie außerdem die beiden untergeordneten Zweige zurück, die beide Ziehpunkte enthalten (auch wenn sie identisch sind).

Details
Rückgabewerte
PropertyPathHandle
Handle mit dem niedrigsten übergeordneten Element.

GetChildHandle

PropertyPathHandle GetChildHandle(
  PropertyPathHandle aParentHandle,
  uint8_t aContextTag
) const

GetDepth

int32_t GetDepth(
  PropertyPathHandle aHandle
) const

Berechnet die Tiefe im Schemabaum für einen bestimmten Handle.

Details
Rückgabewerte
int32_t
Die Tiefe des Baums

GetDictionaryItemHandle

PropertyPathHandle GetDictionaryItemHandle(
  PropertyPathHandle aParentHandle,
  uint16_t aDictionaryKey
) const

GetFirstChild

PropertyPathHandle GetFirstChild(
  PropertyPathHandle aParentHandle
) const

Gibt den ersten untergeordneten Handle zurück, der mit einem bestimmten übergeordneten Element verknüpft ist.

Details
Rückgabewerte
PropertyPathHandle
Zugriffsnummer des ersten untergeordneten Elements.

GetHighestForwardVersion

SchemaVersion GetHighestForwardVersion(
  SchemaVersion aVersion
) const

Bei einer bereitgestellten Datenschemaversion wird die höchste aufwärtskompatible Schemaversion zurückgegeben.

GetLowestCompatibleVersion

SchemaVersion GetLowestCompatibleVersion(
  SchemaVersion aVersion
) const

Bei einer angegebenen Datenschemaversion wird die niedrigste kompatible Schemaversion zurückgegeben.

GetMap

const PropertyInfo * GetMap(
  PropertyPathHandle aHandle
) const

Gibt einen Verweis auf die PropertyInfo-Struktur zurück, die ein bestimmtes Pfad-Handle beschreibt.

Details
Rückgabewerte
PropertyInfo*

GetMaxVersion

SchemaVersion GetMaxVersion() const

GetMinVersion

SchemaVersion GetMinVersion() const

GetNextChild

PropertyPathHandle GetNextChild(
  PropertyPathHandle aParentId,
  PropertyPathHandle aChildHandle
) const

Gibt bei einem Handle auf ein vorhandenes untergeordnetes Element das nächste untergeordnete Handle zurück, das mit einem bestimmten übergeordneten Element verknüpft ist.

Details
Rückgabewerte
PropertyPathHandle
Zugriffsnummer des nächsten untergeordneten Elements.

GetParent

PropertyPathHandle GetParent(
  PropertyPathHandle aHandle
) const

Gibt das übergeordnete Handle eines bestimmten untergeordneten Pfad-Handles zurück

Die Wörterbuchschlüssel im Handle bleiben erhalten, wenn das übergeordnete Handle auch ein Wörterbuchelement ist.

Details
Rückgabewerte
PropertyPathHandle
Alias des übergeordneten Elements.

GetProfileId

uint32_t GetProfileId(
  void
) const

Gibt die Profil-ID des verknüpften Merkmals zurück

Details
Rückgabewerte
Trait
Profil-ID

GetRelativePathTags

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

Wandelt einen PropertyPathHandle in ein Array von Kontexttags um.

Details
Parameter
[in] aCandidateHandle
Das zu konvertierende PropertyPathHandle-Element.
[in] aTags
Zeiger auf das Ausgabearray.
[in] aTagsSize
Größe des aTags-Arrays als Anzahl der Elemente.
[out] aNumTags
Die Anzahl der in aTags geschriebenen Tags
Rückgabe
WEAVE_NO_ERROR bei Erfolg; WEAVE_ERROR_NO_MEMORY wenn aTags zu klein ist, um den vollständigen Pfad zu speichern.

GetTag

uint64_t GetTag(
  PropertyPathHandle aHandle
) const

Gibt das Tag zurück, das mit einem Pfad-Handle verknüpft ist.

Wenn es sich um ein Dictionary-Element handelt, gibt diese Funktion das ProfileTag zurück. Andernfalls werden Kontext-Tags zurückgegeben.

Details
Rückgabewerte
uint64_t

GetVersionIntersection

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

Bei einem bestimmten Versionsbereich prüft diese Funktion, ob es einen Kompatibilitätsüberschneidungstyp zwischen dem Versionsbereich und dem gibt, was von dem Schema unterstützt wird, das diese Schema-Engine unterstützt.

Wenn es eine Schnittmenge gibt, gibt die Funktion "true" zurück und aktualisiert das übergebene Argument aIntersection entsprechend.

IsDictionary

bool IsDictionary(
  PropertyPathHandle aHandle
) const

Gibt „true“ zurück, wenn der Handle ein Wörterbuch ist (und nicht in einem Wörterbuch). Siehe Methode unten.

Details
Rückgabewerte
bool

IsEphemeral

bool IsEphemeral(
  PropertyPathHandle aHandle
) const

IsInDictionary

bool IsInDictionary(
  PropertyPathHandle aHandle,
  PropertyPathHandle & aDictionaryItemHandle
) const

Gibt „true“ zurück, wenn sich der Handle in einem Wörterbuch (einem Wörterbuchelement) befindet.

Ein von einem Nutzer übergebener Handle (aDictionaryItemHandle) wird so aktualisiert, dass er auf den obersten Handle des Wörterbuchelements im Wörterbuch verweist.

Details
Rückgabewerte
bool

IsLeaf

bool IsLeaf(
  PropertyPathHandle aPropertyHandle
) const

Gibt „true“ zurück, wenn der Handle auf einen Blattknoten im Schemabaum verweist.

Details
Rückgabewerte
bool

IsNullable

bool IsNullable(
  PropertyPathHandle aHandle
) const

IsOptional

bool IsOptional(
  PropertyPathHandle aHandle
) const

IsParent

bool IsParent(
  PropertyPathHandle aChildHandle,
  PropertyPathHandle aParentHandle
) const

Überprüft, ob ein bestimmter Alias einem anderen untergeordnet ist.

Das kann eine indirekte übergeordnete Rolle sein.

Details
Rückgabewerte
bool

MapHandleToPath

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

Wandeln Sie das Pfad-Handle in einen TLV-Pfad um.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Der Handle konnte nicht in einen TLV-Pfad konvertiert werden

MapPathToHandle

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

Wenn sich ein Reader im Stamm eines WDM-Pfadelements befindet, lesen Sie die relevanten Tags aus und geben Sie den entsprechenden Pfad-Handle an.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Wenn aufgrund eines falsch formatierten/falsch angegebenen Pfads kein übereinstimmender Alias gefunden wurde.

MapPathToHandle

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

Bei der Darstellung eines WDM-Pfads als String werden die relevanten Tags ausgelesen und der entsprechende Pfad-Handle bereitgestellt.

Der WDM-Pfad wird als String mit den folgenden Regeln dargestellt:

  • Tags werden durch / getrennt
  • Der Pfad MUSS mit einem vorangestellten / beginnen und DARF KEINEN Schrägstrich enthalten
  • Numerische Tags im WDM-Pfad MÜSSEN mit der Standard-C-Bibliothek für die Ganzzahl-zu-String-Codierung codiert werden. Das heißt, die Dezimal-Codierung (Standardeinstellung) DARF KEINE führende 0 enthalten, eine hexadezimale Codierung MUSS mit 0x beginnen und die Oktal-Codierung MUSS einen führenden 0 enthalten.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Wenn kein übereinstimmender Alias gefunden wurde.
WEAVE_ERROR_INVALID_ARGUMENT
Wenn ein Pfadstring fehlerhaft ist

MatchesProfileId

bool MatchesProfileId(
  uint32_t aProfileId
) const

Gibt "true" zurück, wenn die in der Funktion "profileId" übergebene ID mit der im Schema gespeicherten übereinstimmt.

Details
Rückgabewerte
bool

RetrieveData

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

Rufen Sie mit einem Pfad-Handle und einer Schreibposition im entsprechenden Datenelement Blattdaten aus der Quelle ab und schreiben Sie sie schematisch in den Zwischenspeicher, auf den der Schreiber verweist.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Beim Schreiben der Daten sind Fehler aufgetreten.

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

Bei einem Pfad-Handle und einem Reader, der auf dem entsprechenden Datenelement positioniert ist, wird der Datenpuffer, auf den der Leser zeigt, verarbeitet und in der Senke gespeichert, indem der SetLeafData-Aufruf immer dann aufgerufen wird, wenn ein Blatt-Datenelement gefunden wird.

Details
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
other
Beim Parsen/Verarbeiten der Daten sind Fehler aufgetreten.