Questa pagina è stata tradotta dall'API Cloud Translation.

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

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

Il motore dello schema prende le informazioni sullo schema associate a un particolare tratto e fornisce servizi per analizzarle e tradurle in un modulo utilizzabile dai macchinari WDM.

Riepilogo

Ciò include la conversione da PathHandles a percorsi WDM (e viceversa), metodi per interpretare/eseguire query sullo schema stesso e metodi per semplificare la lettura/scrittura di dati da/verso TLV in base a un handle.

Lo schema stesso è archiviato in formato tabulare, sufficientemente descritto da consentire l'analisi/composizione generica di percorsi/dati WDM per ogni tratto. Queste tabelle sono ciò che sarà l'output finale di "code-gen" (il termine stesso è in qualche modo fuorviante data l'assenza di qualsiasi codice generato :P)

Attributi statici pubblici
`kHandleTableOffset = 2`	`const uint32_t`

Attributi pubblici
`mSchema`	`const Schema`

Funzioni pubbliche
`FindLowestCommonAncestor(PropertyPathHandle aHandle1, PropertyPathHandle aHandle2, PropertyPathHandle aHandle1BranchChild, PropertyPathHandle aHandle2BranchChild) const`	`PropertyPathHandle` Dati due handle di proprietà, calcola l'handle più basso che funge da padre per entrambi.
`GetChildHandle(PropertyPathHandle aParentHandle, uint8_t aContextTag) const`	`PropertyPathHandle`
`GetDepth(PropertyPathHandle aHandle) const`	`int32_t` Calcola la profondità nella struttura dello schema per un determinato handle.
`GetDictionaryItemHandle(PropertyPathHandle aParentHandle, uint16_t aDictionaryKey) const`	`PropertyPathHandle`
`GetFirstChild(PropertyPathHandle aParentHandle) const`	`PropertyPathHandle` Restituisce il primo handle secondario associato a un determinato elemento padre.
`GetHighestForwardVersion(SchemaVersion aVersion) const`	`SchemaVersion` Data una versione dello schema di dati fornita, verrà restituita la versione dello schema compatibile con l'inoltro più recente.
`GetLowestCompatibleVersion(SchemaVersion aVersion) const`	`SchemaVersion` Data una versione dello schema di dati fornita, verrà restituita la versione minima compatibile dello schema.
`GetMap(PropertyPathHandle aHandle) const`	`const PropertyInfo *` Restituisce un puntatore alla struttura PropertyInfo che descrive un determinato handle del percorso.
`GetMaxVersion() const`	`SchemaVersion`
`GetMinVersion() const`	`SchemaVersion`
`GetNextChild(PropertyPathHandle aParentId, PropertyPathHandle aChildHandle) const`	`PropertyPathHandle` Se viene assegnato un handle a un elemento secondario esistente, restituisce l'handle secondario successivo associato a un determinato elemento padre.
`GetParent(PropertyPathHandle aHandle) const`	`PropertyPathHandle` Restituisce l'handle principale di un determinato handle del percorso figlio.
`GetProfileId(void) const`	`uint32_t` Restituisce l'ID profilo del trait associato.
`GetRelativePathTags(const PropertyPathHandle aCandidateHandle, uint64_t *aTags, const uint32_t aTagsSize, uint32_t & aNumTags) const`	`WEAVE_ERROR` Converte un PropertyPathHandle in un array di tag di contesto.
`GetTag(PropertyPathHandle aHandle) const`	`uint64_t` Restituisce il tag associato a un handle del percorso.
`GetVersionIntersection(SchemaVersionRange & aVersion, SchemaVersionRange & aIntersection) const`	`bool` Dato un intervallo di versioni, questa funzione controlla se esiste un'intersezione di compatibilità tra questo e ciò che è supportato dallo schema che supporta questo motore dello schema.
`IsDictionary(PropertyPathHandle aHandle) const`	`bool` Restituisce true se l'handle è un dizionario (e non in un dizionario; vedi il metodo di seguito).
`IsEphemeral(PropertyPathHandle aHandle) const`	`bool`
`IsInDictionary(PropertyPathHandle aHandle, PropertyPathHandle & aDictionaryItemHandle) const`	`bool` Restituisce true se l'handle è all'interno di un dizionario (un elemento del dizionario).
`IsLeaf(PropertyPathHandle aPropertyHandle) const`	`bool` Restituisce true se l'handle fa riferimento a un nodo foglia nell'albero dello schema.
`IsNullable(PropertyPathHandle aHandle) const`	`bool`
`IsOptional(PropertyPathHandle aHandle) const`	`bool`
`IsParent(PropertyPathHandle aChildHandle, PropertyPathHandle aParentHandle) const`	`bool` Verifica se un determinato handle è un handle secondario rispetto a un altro.
`MapHandleToPath(PropertyPathHandle aHandle, nl::Weave::TLV::TLVWriter & aPathWriter) const`	`WEAVE_ERROR` Converti l'handle del percorso in un percorso TLV.
`MapPathToHandle(nl::Weave::TLV::TLVReader & aPathReader, PropertyPathHandle & aHandle) const`	`WEAVE_ERROR` Dato un lettore posizionato alla radice di un elemento del percorso WDM, leggi i tag pertinenti e fornisci l'handle del percorso equivalente.
`MapPathToHandle(const char *aPathString, PropertyPathHandle & aHandle) const`	`WEAVE_ERROR` Data la rappresentazione stringa di un percorso WDM, leggi ad alta voce i tag pertinenti e fornisci l'handle del percorso equivalente.
`MatchesProfileId(uint32_t aProfileId) const`	`bool` Restituisce true se il valore trasmesso in profileId corrisponde a quello archiviato nello schema.
`RetrieveData(PropertyPathHandle aHandle, uint64_t aTagToWrite, nl::Weave::TLV::TLVWriter & aWriter, IGetDataDelegate aDelegate, IDirtyPathCut apDirtyPathCut) const`	`WEAVE_ERROR` Data un handle del percorso e una posizione del writer nell'elemento di dati corrispondente, recupera i dati leaf dall'origine e scrivili nel buffer a cui il writer rimanda in modo conforme allo schema.
`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` Data un handle del percorso e un lettore posizionato sull'elemento di dati corrispondente, elabora il buffer di dati a cui punta il lettore e archivialo nel sink richiamando la chiamata SetLeafData ogni volta che viene rilevato un elemento dati foglia.

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

Strutture
nl::Weave::Profiles::DataManagement_Current::TraitSchemaEngine::PropertyInfo
nl::Weave::Profiles::DataManagement_Current::TraitSchemaEngine::Schema	La struttura principale dello schema che ospita le informazioni sullo schema.

Attributi statici pubblici

kHandleTableOffset

const uint32_t kHandleTableOffset = 2

Attributi pubblici

mSchema

const Schema mSchema

Funzioni pubbliche

FindLowestCommonAncestor

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

Dati due handle di proprietà, calcola l'handle più basso che funge da padre per entrambi.

Inoltre, restituisci i due rami secondari che contengono ciascuno dei due handle, anche se sono uguali.

Dettagli

Valori restituiti

PropertyPathHandle

Assegna l'handle all'elemento padre di livello inferiore.

GetChildHandle

PropertyPathHandle GetChildHandle(
  PropertyPathHandle aParentHandle,
  uint8_t aContextTag
) const

GetDepth

int32_t GetDepth(
  PropertyPathHandle aHandle
) const

Calcola la profondità nella struttura dello schema per un determinato handle.

Dettagli

Valori restituiti

int32_t

La profondità dell'albero

GetDictionaryItemHandle

PropertyPathHandle GetDictionaryItemHandle(
  PropertyPathHandle aParentHandle,
  uint16_t aDictionaryKey
) const

GetFirstChild

PropertyPathHandle GetFirstChild(
  PropertyPathHandle aParentHandle
) const

Restituisce il primo handle secondario associato a un determinato elemento padre.

Dettagli

Valori restituiti

PropertyPathHandle

Handle del primo figlio.

GetHighestForwardVersion

SchemaVersion GetHighestForwardVersion(
  SchemaVersion aVersion
) const

Data una versione dello schema di dati fornita, verrà restituita la versione dello schema compatibile con l'inoltro più recente.

GetLowestCompatibleVersion

SchemaVersion GetLowestCompatibleVersion(
  SchemaVersion aVersion
) const

Data una versione dello schema di dati fornita, verrà restituita la versione minima compatibile dello schema.

GetMap

const PropertyInfo * GetMap(
  PropertyPathHandle aHandle
) const

Restituisce un puntatore alla struttura PropertyInfo che descrive un determinato handle del percorso.

Dettagli

Valori restituiti

PropertyInfo*

GetMaxVersion

SchemaVersion GetMaxVersion() const

GetMinVersion

SchemaVersion GetMinVersion() const

GetNextChild

PropertyPathHandle GetNextChild(
  PropertyPathHandle aParentId,
  PropertyPathHandle aChildHandle
) const

Se viene assegnato un handle a un elemento secondario esistente, restituisce l'handle secondario successivo associato a un determinato elemento padre.

Dettagli

Valori restituiti

PropertyPathHandle

Handle del figlio successivo.

GetParent

PropertyPathHandle GetParent(
  PropertyPathHandle aHandle
) const

Restituisce l'handle principale di un determinato handle del percorso figlio.

Le chiavi del dizionario nell'handle vengono mantenute nel caso in cui l'handle principale sia anche un elemento del dizionario.

Dettagli

Valori restituiti

PropertyPathHandle

Handle del principale.

GetProfileId

uint32_t GetProfileId(
  void
) const

Restituisce l'ID profilo del trait associato.

Dettagli

Valori restituiti

Trait

ID profilo

GetRelativePathTags

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

Converte un PropertyPathHandle in un array di tag di contesto.

Dettagli

Parametri

`[in] aCandidateHandle`	Il PropertyPathHandle da convertire.
`[in] aTags`	Punta all'array di output.
`[in] aTagsSize`	Dimensione dell'array aTag, in numero di elementi.
`[out] aNumTags`	Il numero di tag scritti in unTag

Restituisce

WEAVE_NO_ERROR in caso di esito positivo; WEAVE_ERROR_NO_MEMORY se aTag è troppo piccolo per memorizzare il percorso completo.

GetTag

uint64_t GetTag(
  PropertyPathHandle aHandle
) const

Restituisce il tag associato a un handle del percorso.

Se è un elemento del dizionario, questa funzione restituisce il ProfileTag. In caso contrario, restituisce i tag di contesto.

Dettagli

Valori restituiti

uint64_t

GetVersionIntersection

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

Dato un intervallo di versioni, questa funzione controlla se esiste un'intersezione di compatibilità tra questo e ciò che è supportato dallo schema che supporta questo motore dello schema.

Se è presente un'intersezione, la funzione restituisce true e aggiorna l'argomento aIntersection passato in modo da riflettere i risultati del test di intersezione.

IsDictionary

bool IsDictionary(
  PropertyPathHandle aHandle
) const

Restituisce true se l'handle è un dizionario (e non in un dizionario; vedi il metodo di seguito).

Dettagli

Valori restituiti

bool

IsEphemeral

bool IsEphemeral(
  PropertyPathHandle aHandle
) const

IsInDictionary

bool IsInDictionary(
  PropertyPathHandle aHandle,
  PropertyPathHandle & aDictionaryItemHandle
) const

Restituisce true se l'handle è all'interno di un dizionario (un elemento del dizionario).

Un utente passato nell'handle (aDictionaryItemHandle) viene aggiornato in modo che punti all'handle dell'elemento di dizionario più in alto all'interno del dizionario.

Dettagli

Valori restituiti

bool

IsLeaf

bool IsLeaf(
  PropertyPathHandle aPropertyHandle
) const

Restituisce true se l'handle fa riferimento a un nodo foglia nell'albero dello schema.

Dettagli

Valori restituiti

bool

IsNullable

bool IsNullable(
  PropertyPathHandle aHandle
) const

IsOptional

bool IsOptional(
  PropertyPathHandle aHandle
) const

IsParent

bool IsParent(
  PropertyPathHandle aChildHandle,
  PropertyPathHandle aParentHandle
) const

Verifica se un determinato handle è un handle secondario rispetto a un altro.

Può essere un elemento padre indiretto.

Dettagli

Valori restituiti

bool

MapHandleToPath

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

Converti l'handle del percorso in un percorso TLV.

Dettagli

Valori restituiti

`WEAVE_NO_ERROR`	In caso di successo.
`other`	Impossibile convertire l'handle in un percorso TLV

MapPathToHandle

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

Dato un lettore posizionato alla radice di un elemento del percorso WDM, leggi i tag pertinenti e fornisci l'handle del percorso equivalente.

Dettagli

Valori restituiti

`WEAVE_NO_ERROR`	In caso di successo.
`WEAVE_ERROR_TLV_TAG_NOT_FOUND`	Se non è stato possibile trovare un handle corrispondente a causa di un percorso non corretto o specificato in modo errato.

MapPathToHandle

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

Data la rappresentazione stringa di un percorso WDM, leggi ad alta voce i tag pertinenti e fornisci l'handle del percorso equivalente.

Il percorso WDM è rappresentato come una stringa utilizzando le seguenti regole:

i tag sono separati da /
il percorso DEVE iniziare con un / iniziale e NON DEVE contenere una barra finale
I tag numerici nel percorso WDM DEVONO essere codificati utilizzando la libreria C standard per la codifica da numero intero a stringa, ad esempio la codifica decimale (predefinita) NON DEVE contenere uno 0 iniziale, la codifica esadecimale DEVE iniziare con 0x e la codifica ottale DEVE contenere un 0 iniziale.

Dettagli

Valori restituiti

`WEAVE_NO_ERROR`	In caso di successo.
`WEAVE_ERROR_TLV_TAG_NOT_FOUND`	Se non è stato possibile trovare un handle corrispondente.
`WEAVE_ERROR_INVALID_ARGUMENT`	Se il formato di una stringa di percorso non è valido

MatchesProfileId

bool MatchesProfileId(
  uint32_t aProfileId
) const

Restituisce true se il valore trasmesso in profileId corrisponde a quello archiviato nello schema.

Dettagli

Valori restituiti

bool

RetrieveData

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

Data un handle del percorso e una posizione del writer nell'elemento di dati corrispondente, recupera i dati leaf dall'origine e scrivili nel buffer a cui il writer rimanda in modo conforme allo schema.

Dettagli

Valori restituiti

`WEAVE_NO_ERROR`	In caso di successo.
`other`	Si sono verificati errori durante la scrittura dei dati.

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

Data un handle del percorso e un lettore posizionato sull'elemento di dati corrispondente, elabora il buffer di dati a cui punta il lettore e archivialo nel sink richiamando la chiamata SetLeafData ogni volta che viene rilevato un elemento dati foglia.

Dettagli

Valori restituiti

`WEAVE_NO_ERROR`	In caso di successo.
`other`	Si sono verificati errori di analisi/elaborazione dei dati.

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

Riepilogo

Attributi statici pubblici

Attributi pubblici

Funzioni pubbliche

Corsi

Strutture

Attributi statici pubblici

kHandleTableOffset

Attributi pubblici

mSchema

Funzioni pubbliche

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