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

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

Il motore dello schema prende le informazioni dello schema associate a un determinato tratto e fornisce strumenti per analizzarle e tradurle in un formato utilizzabile dalla macchina WDM.

Riepilogo

Sono incluse la conversione da PathHandle a percorsi WDM (e viceversa), metodi per interpretare/eseguire query sullo schema stesso e metodi per leggere/scrivere dati in/da TLV a partire da un handle.

Lo schema stesso è archiviato in formato tabulare, descritto in modo sufficiente per consentire l'analisi/la composizione generica di percorsi/dati WDM per qualsiasi tratto. Queste tabelle saranno l'eventuale output di "code-gen" (il termine stesso è in qualche modo fuorviante data l'assenza di 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
Dati due handle delle proprietà, calcola l'handle più basso che funge da principale per entrambi.
GetChildHandle(PropertyPathHandle aParentHandle, uint8_t aContextTag) const
GetDepth(PropertyPathHandle aHandle) const
int32_t
Calcola la profondità nella struttura ad albero dello schema per un determinato handle.
GetDictionaryItemHandle(PropertyPathHandle aParentHandle, uint16_t aDictionaryKey) const
GetFirstChild(PropertyPathHandle aParentHandle) const
Restituisce il primo handle secondario associato a un determinato handle principale.
GetHighestForwardVersion(SchemaVersion aVersion) const
SchemaVersion
Se viene fornita una versione dello schema dei dati, verrà restituita la versione dello schema compatibile con le versioni più recenti.
GetLowestCompatibleVersion(SchemaVersion aVersion) const
SchemaVersion
Data una versione dello schema di dati fornita, verrà restituita la versione dello schema compatibile minima.
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
Dato un handle a un elemento secondario esistente, restituisce l'handle dell'elemento secondario successivo associato a un determinato elemento principale.
GetParent(PropertyPathHandle aHandle) const
Restituisce l'handle principale di un determinato handle del percorso secondario.
GetProfileId(void) const
uint32_t
Restituisce l'ID profilo del tratto associato.
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.
GetTag(PropertyPathHandle aHandle) const
uint64_t
Restituisce il tag associato a un handle del percorso.
GetVersionIntersection(SchemaVersionRange & aVersion, SchemaVersionRange & aIntersection) const
bool
Data un'intervallo di versioni, questa funzione controlla se esiste un'intersezione di compatibilità tra questo intervallo 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 nella struttura ad albero dello schema.
IsNullable(PropertyPathHandle aHandle) const
bool
IsOptional(PropertyPathHandle aHandle) const
bool
IsParent(PropertyPathHandle aChildHandle, PropertyPathHandle aParentHandle) const
bool
Controlla se un determinato handle è figlio di un altro handle.
MapHandleToPath(PropertyPathHandle aHandle, nl::Weave::TLV::TLVWriter & aPathWriter) const
Converti il cursore del percorso in un percorso TLV.
MapPathToHandle(nl::Weave::TLV::TLVReader & aPathReader, PropertyPathHandle & aHandle) const
Dato un lettore posizionato nella 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
Data una rappresentazione di stringa di un percorso WDM, leggi i tag pertinenti e fornisci l'handle del percorso equivalente.
MatchesProfileId(uint32_t aProfileId) const
bool
Restituisce true se il valore profileId passato corrisponde a quello memorizzato nello schema.
RetrieveData(PropertyPathHandle aHandle, uint64_t aTagToWrite, nl::Weave::TLV::TLVWriter & aWriter, IGetDataDelegate *aDelegate, IDirtyPathCut *apDirtyPathCut) const
Dati un handle del percorso e una posizione dello scrittore nell'elemento di dati corrispondente, recupera i dati delle foglie dall'origine e scrivili nel buffer a cui fa riferimento lo scrittore in modo conforme allo schema.
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
Dati un handle di percorso e un lettore posizionato sull'elemento di dati corrispondente, elabora il buffer di dati a cui punta il lettore e lo archivia nel sink richiamando la chiamata SetLeafData ogni volta che viene rilevato un elemento di 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 dello schema principale che contiene le informazioni dello 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 delle proprietà, calcola l'handle più basso che funge da principale per entrambi.

Inoltre, restituisci i due rami secondari che contengono ciascuno dei due handle (anche se sono gli stessi).

Dettagli
Valori restituiti
PropertyPathHandle
Handle del contenitore principale più basso.

GetChildHandle

PropertyPathHandle GetChildHandle(
  PropertyPathHandle aParentHandle,
  uint8_t aContextTag
) const

GetDepth

int32_t GetDepth(
  PropertyPathHandle aHandle
) const

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

Dettagli
Valori restituiti
int32_t
La profondità nell'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 handle principale.

Dettagli
Valori restituiti
PropertyPathHandle
Maniglia del primo elemento secondario.

GetHighestForwardVersion

SchemaVersion GetHighestForwardVersion(
  SchemaVersion aVersion
) const

Data una versione dello schema di dati fornita, verrà restituita la versione dello schema compatibile con le versioni successive più recente.

GetLowestCompatibleVersion

SchemaVersion GetLowestCompatibleVersion(
  SchemaVersion aVersion
) const

Se viene fornita una versione dello schema dei dati, verrà restituita la versione minima dello schema compatibile.

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 fornito un handle a un account secondario esistente, restituisce l'handle successivo associato a un determinato account principale.

Dettagli
Valori restituiti
PropertyPathHandle
Handle del figlio successivo.

GetParent

PropertyPathHandle GetParent(
  PropertyPathHandle aHandle
) const

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

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

Dettagli
Valori restituiti
PropertyPathHandle
Handle del gruppo principale.

GetProfileId

uint32_t GetProfileId(
  void
) const

Restituisce l'ID profilo del tratto 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
Puntatore all'array di output.
[in] aTagsSize
Dimensioni dell'array aTags, in numero di elementi.
[out] aNumTags
Il numero di tag scritti negli aTag
Restituisce
WEAVE_NO_ERROR in caso di esito positivo; WEAVE_ERROR_NO_MEMORY se aTags è troppo piccolo per memorizzare il percorso completo.

GetTag

uint64_t GetTag(
  PropertyPathHandle aHandle
) const

Restituisce il tag associato a un handle del percorso.

Se si tratta di 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

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

Se esiste un'intersezione, la funzione restituirà true e aggiornerà 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).

L'handle passato dall'utente (aDictionaryItemHandle) viene aggiornato in modo da puntare all'handle dell'elemento di dizionario più 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 nella struttura ad 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

Controlla se un determinato handle è un elemento secondario di un altro handle.

Può essere un account principale indiretto.

Dettagli
Valori restituiti
bool

MapHandleToPath

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

Converti il cursore del percorso in un percorso TLV.

Dettagli
Valori restituiti
WEAVE_NO_ERROR
In caso di esito positivo.
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 nella 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 esito positivo.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Se non è stato possibile trovare un handle corrispondente a causa di un percorso non valido/specificato in modo errato.

MapPathToHandle

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

Data la rappresentazione in formato stringa di un percorso WDM, legge ad alta voce i tag pertinenti e fornisce l'handle equivalente del percorso.

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

  • I tag sono separati da /
  • Il percorso DEVE iniziare con una / 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, ossia la codifica decimale (predefinita) NON DEVE contenere uno 0 iniziale, una codifica esadecimale DEVE iniziare con 0x e la codifica ottale DEVE contenere un carattere 0 iniziale.

Dettagli
Valori restituiti
WEAVE_NO_ERROR
Un successo.
WEAVE_ERROR_TLV_TAG_NOT_FOUND
Se non è stato possibile trovare un handle corrispondente.
WEAVE_ERROR_INVALID_ARGUMENT
Se la stringa del percorso non è valida

MatchesProfileId

bool MatchesProfileId(
  uint32_t aProfileId
) const

Restituisce true se il valore profileId passato corrisponde a quello memorizzato 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

Dati un handle del percorso e una posizione dello scrittore nell'elemento di dati corrispondente, recupera i dati delle foglie dall'origine e scrivili nel buffer a cui fa riferimento lo scrittore in modo conforme allo schema.

Dettagli
Valori restituiti
WEAVE_NO_ERROR
Un 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

Dato un handle del percorso e un lettore posizionato sull'elemento di dati corrispondente, elabora il buffer di dati a cui fa riferimento il lettore e memorizzalo nell'elemento di destinazione chiamando SetLeafData ogni volta che viene rilevato un elemento di dati foglia.

Dettagli
Valori restituiti
WEAVE_NO_ERROR
In caso di esito positivo.
other
Si sono verificati errori durante l'analisi/l'elaborazione dei dati.