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

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

Definizione del parser delle richieste comando personalizzato WDM.

Riepilogo

Eredità

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

Funzioni pubbliche

CheckSchemaValidity(void) const
Verifica approssimativamente il formato corretto del messaggio.
GetActionTimeMicroSecond(int64_t *const apActionTimeMicroSecond) const
Ottieni la data e l'ora dell'azione pianificata 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
Ottieni la data di scadenza per questo comando.
GetInitiationTimeMicroSecond(int64_t *const apInitiationTimeMicroSecond) const
Recupera la data e l'ora di avvio di questo comando.
GetMustBeVersion(uint64_t *const apMustBeVersion) const
Ottieni la versione indispensabile 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 parser con TLVReader.

Funzioni pubbliche

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const 

Verifica approssimativamente il formato corretto del messaggio.

Dettagli
Valori restituiti
WEAVE_NO_ERROR
in caso di esito positivo

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const 

Ottieni la data e l'ora dell'azione pianificata per questo comando.

Dettagli
Parametri
[out] apActionTimeMicroSecond
Un puntatore ad alcune variabili per ricevere il tempo di azione Command in caso di esito positivo.
Valori restituiti
WEAVE_NO_ERROR
in caso di esito positivo
WEAVE_END_OF_TLV
se questo elemento non è presente
WEAVE_ERROR_WRONG_TLV_TYPE
se esiste un elemento di questo tipo ma non è un numero intero firmato

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const 

Ottieni l'ID del 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 esito positivo
WEAVE_END_OF_TLV
se questo elemento non è presente
WEAVE_ERROR_WRONG_TLV_TYPE
se esiste un elemento di questo tipo ma non è un numero intero senza segno

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const 

Ottieni la data di scadenza per questo comando.

Dettagli
Parametri
[out] apExpiryTimeMicroSecond
Un puntatore ad alcune variabili per ricevere la data di scadenza in caso di esito positivo
Valori restituiti
WEAVE_NO_ERROR
in caso di esito positivo
WEAVE_END_OF_TLV
se questo elemento non è presente
WEAVE_ERROR_WRONG_TLV_TYPE
se esiste un elemento di questo tipo ma non è un numero intero firmato

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const 

Recupera la data e l'ora di avvio di questo comando.

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

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const 

Ottieni la versione indispensabile per questo comando.

Dettagli
Parametri
[out] apMustBeVersion
Un puntatore ad alcune variabili per ricevere la versione indispensabile in caso di esito positivo
Valori restituiti
WEAVE_NO_ERROR
in caso di esito positivo
WEAVE_END_OF_TLV
se questo elemento non è presente
WEAVE_ERROR_WRONG_TLV_TYPE
se esiste 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 il componente del percorso incorporato in caso di esito positivo.
Valori restituiti
WEAVE_NO_ERROR
in caso di esito positivo
WEAVE_END_OF_TLV
se questo elemento non è presente
WEAVE_ERROR_WRONG_TLV_TYPE
in presenza di questo elemento, ma non è un Path

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 viene inizializzato nell'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 viene inizializzato nell'argomento TLV in caso di esito positivo
Valori restituiti
WEAVE_NO_ERROR
in caso di esito positivo

Inizia

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

Inizializza l'oggetto parser con TLVReader.

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