nl::Weave::Profiles::DataManagement_Current::CustomCommand::Parser

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

Definizione del parser della richiesta di comando personalizzato WDM.

Riepilogo

Eredità

Eredita da: nl::Weave::Profiles::DataManagement_Current::DataElement::Parser

Funzioni pubbliche
CheckSchemaValidity(void) const
Verifica approssimativamente che il messaggio sia nel formato corretto.
GetActionTimeMicroSecond(int64_t *const apActionTimeMicroSecond) const
Ottieni la data e l'ora pianificate per l'azione per questo comando.
GetCommandType(uint64_t *const apCommandType) const
Ottieni l'ID del tipo di comando per questo comando.
GetExpiryTimeMicroSecond(int64_t *const apExpiryTimeMicroSecond) const
Recupera l'ora di scadenza di questo comando.
GetInitiationTimeMicroSecond(int64_t *const apInitiationTimeMicroSecond) const
Recupera l'ora di inizio di questo comando.
GetMustBeVersion(uint64_t *const apMustBeVersion) const
Ottieni la versione da utilizzare per questo comando.
GetPath(Path::Parser *const apPath) const
Inizializza un Path::Parser con il componente del percorso in questo comando.
GetReaderOnArgument(nl::Weave::TLV::TLVReader *const apReader) const
Inizializza un TLVReader in modo che punti all'inizio del componente dell'argomento in questo comando.
GetReaderOnPath(nl::Weave::TLV::TLVReader *const apReader) const
Inizializza un TLVReader in modo che punti all'inizio del componente del percorso in questo comando.
Init(const nl::Weave::TLV::TLVReader & aReader)
Inizializza l'oggetto dell'analizzatore con TLVReader.

Funzioni pubbliche

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const

Verifica approssimativamente che il messaggio sia nel formato corretto.

Dettagli
Valori restituiti
WEAVE_NO_ERROR
in caso di successo

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

Recupera l'ora dell'azione pianificata per questo comando.

Dettagli
Parametri
[out] apActionTimeMicroSecond
Un puntatore a una variabile per ricevere l'ora dell'azione Command in caso di esito positivo
Valori restituiti
WEAVE_NO_ERROR
in caso di successo
WEAVE_END_OF_TLV
in assenza di questo elemento
WEAVE_ERROR_WRONG_TLV_TYPE
se esiste un elemento del genere, ma non è un numero intero con segno

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const

Recupera l'ID tipo di comando per questo comando.

Dettagli
Parametri
[out] apCommandType
Un puntatore ad alcune variabili per ricevere l'ID del tipo di comando in caso di esito positivo
Valori restituiti
WEAVE_NO_ERROR
in caso di successo
WEAVE_END_OF_TLV
se non esiste un elemento di questo tipo
WEAVE_ERROR_WRONG_TLV_TYPE
in presenza di un elemento di questo tipo, ma non è un numero intero senza segno

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

Recupera l'ora di scadenza di questo comando.

Dettagli
Parametri
[out] apExpiryTimeMicroSecond
Un puntatore a una variabile per ricevere la data e l'ora di scadenza in caso di esito positivo
Valori restituiti
WEAVE_NO_ERROR
in caso di successo
WEAVE_END_OF_TLV
in assenza di questo elemento
WEAVE_ERROR_WRONG_TLV_TYPE
se è presente questo elemento, ma non è un numero intero firmato

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

Recupera l'ora di inizio di questo comando.

Dettagli
Parametri
[out] apInitiationTimeMicroSecond
Un puntatore ad alcune variabili per ricevere il tempo di inizializzazione di Command in caso di esito positivo
Valori restituiti
WEAVE_NO_ERROR
in caso di successo
WEAVE_END_OF_TLV
in assenza di questo elemento
WEAVE_ERROR_WRONG_TLV_TYPE
se è presente questo elemento, ma non è un numero intero firmato

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const

Ottieni la versione da utilizzare per questo comando.

Dettagli
Parametri
[out] apMustBeVersion
Un puntatore a qualche variabile per ricevere la versione che non può mancare se l'operazione riesce
Valori restituiti
WEAVE_NO_ERROR
in caso di successo
WEAVE_END_OF_TLV
se non esiste un elemento di questo tipo
WEAVE_ERROR_WRONG_TLV_TYPE
in presenza di un elemento di questo tipo, ma non è un numero intero senza segno

GetPath

WEAVE_ERROR GetPath(
  Path::Parser *const apPath
) const

Inizializza un Path::Parser con il componente del percorso in questo comando.

Dettagli
Parametri
[out] apPath
Un puntatore a un Path::Parser, che verrà inizializzato con un componente del percorso incorporato in caso di esito positivo
Valori restituiti
WEAVE_NO_ERROR
in caso di successo
WEAVE_END_OF_TLV
se non esiste un elemento di questo tipo
WEAVE_ERROR_WRONG_TLV_TYPE
se è presente un elemento di questo tipo ma non è un Percorso

GetReaderOnArgument

WEAVE_ERROR GetReaderOnArgument(
  nl::Weave::TLV::TLVReader *const apReader
) const

Inizializza un TLVReader in modo che punti all'inizio del componente dell'argomento in questo comando.

Dettagli
Parametri
[out] apReader
Un puntatore a TLVReader, che verrà inizializzato nell'elemento argomento TLV in caso di esito positivo
Valori restituiti
WEAVE_NO_ERROR
in caso di esito positivo

GetReaderOnPath

WEAVE_ERROR GetReaderOnPath(
  nl::Weave::TLV::TLVReader *const apReader
) const

Inizializza un TLVReader in modo che punti all'inizio del componente del percorso in questo comando.

Dettagli
Parametri
[out] apReader
Un puntatore a TLVReader, che verrà inizializzato nell'elemento argomento TLV in caso di esito positivo
Valori restituiti
WEAVE_NO_ERROR
in caso di esito positivo

Inizializzazione

WEAVE_ERROR Init(
  const nl::Weave::TLV::TLVReader & aReader
)

Inizializza l'oggetto parser con TLVReader.

Dettagli
Parametri
[in] aReader
Un puntatore a un TLVReader, che deve puntare all'inizio di questa richiesta
Valori restituiti
WEAVE_NO_ERROR
in caso di esito positivo