nl :: Tecer:: Perfis :: DataManagement_Current :: CustomCommand :: Parser

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

Definição do analisador WDM Custom Command Request.

Resumo

Herança

Herda de: nl :: Weave :: Profiles :: DataManagement_Current :: DataElement :: Parser

Funções públicas
`CheckSchemaValidity (void) const`	`WEAVE_ERROR` Verifique aproximadamente se a mensagem está formada corretamente.
`GetActionTimeMicroSecond (int64_t *const apActionTimeMicroSecond) const`	`WEAVE_ERROR` Obtenha a hora de ação planejada para este comando.
`GetCommandType (uint64_t *const apCommandType) const`	`WEAVE_ERROR` Obtenha a id do tipo de comando para este comando.
`GetExpiryTimeMicroSecond (int64_t *const apExpiryTimeMicroSecond) const`	`WEAVE_ERROR` Obtenha o tempo de expiração para este comando.
`GetInitiationTimeMicroSecond (int64_t *const apInitiationTimeMicroSecond) const`	`WEAVE_ERROR` Obtenha a hora de iniciação para este comando.
`GetMustBeVersion (uint64_t *const apMustBeVersion) const`	`WEAVE_ERROR` Obtenha a versão obrigatória para este comando.
`GetPath ( Path::Parser *const apPath) const`	`WEAVE_ERROR` Inicialize um Path :: Parser com o componente de caminho neste comando.
`GetReaderOnArgument (nl::Weave::TLV::TLVReader *const apReader) const`	`WEAVE_ERROR` Inicialize um TLVReader para apontar para o início do componente do argumento neste comando.
`GetReaderOnPath (nl::Weave::TLV::TLVReader *const apReader) const`	`WEAVE_ERROR` Inicialize um TLVReader para apontar para o início do componente do caminho neste comando.
`Init (constnl::Weave::TLV::TLVReader & aReader)`	`WEAVE_ERROR` Inicialize o objeto analisador com TLVReader.

Funções públicas

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const

Verifique aproximadamente se a mensagem está formada corretamente.

Detalhes

Valores Retornados

WEAVE_NO_ERROR

no sucesso

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

Obtenha a hora de ação planejada para este comando.

Detalhes

Parâmetros

[out] apActionTimeMicroSecond

Um ponteiro para alguma variável para receber o tempo de ação do Comando em caso de sucesso

Valores Retornados

`WEAVE_NO_ERROR`	no sucesso
`WEAVE_END_OF_TLV`	se não existe tal elemento
`WEAVE_ERROR_WRONG_TLV_TYPE`	se existe tal elemento, mas não é um inteiro assinado

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const

Obtenha a id do tipo de comando para este comando.

Detalhes

Parâmetros

[out] apCommandType

Um ponteiro para alguma variável para receber o id do tipo de comando em caso de sucesso

Valores Retornados

`WEAVE_NO_ERROR`	no sucesso
`WEAVE_END_OF_TLV`	se não existe tal elemento
`WEAVE_ERROR_WRONG_TLV_TYPE`	se existe tal elemento, mas não é um inteiro sem sinal

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

Obtenha o tempo de expiração para este comando.

Detalhes

Parâmetros

[out] apExpiryTimeMicroSecond

Um ponteiro para alguma variável para receber o tempo de expiração em caso de sucesso

Valores Retornados

`WEAVE_NO_ERROR`	no sucesso
`WEAVE_END_OF_TLV`	se não existe tal elemento
`WEAVE_ERROR_WRONG_TLV_TYPE`	se existe tal elemento, mas não é um inteiro assinado

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

Obtenha a hora de iniciação para este comando.

Detalhes

Parâmetros

[out] apInitiationTimeMicroSecond

Um ponteiro para alguma variável para receber o tempo de iniciação do Comando em caso de sucesso

Valores Retornados

`WEAVE_NO_ERROR`	no sucesso
`WEAVE_END_OF_TLV`	se não existe tal elemento
`WEAVE_ERROR_WRONG_TLV_TYPE`	se existe tal elemento, mas não é um inteiro assinado

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const

Obtenha a versão obrigatória para este comando.

Detalhes

Parâmetros

[out] apMustBeVersion

Um ponteiro para alguma variável para receber a versão obrigatória em caso de sucesso

Valores Retornados

`WEAVE_NO_ERROR`	no sucesso
`WEAVE_END_OF_TLV`	se não existe tal elemento
`WEAVE_ERROR_WRONG_TLV_TYPE`	se existe tal elemento, mas não é um inteiro sem sinal

GetPath

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

Inicialize um Path :: Parser com o componente de caminho neste comando.

Detalhes

Parâmetros

[out] apPath

Um ponteiro para um Path :: Parser , que será inicializado com o componente de caminho incorporado em caso de sucesso

Valores Retornados

`WEAVE_NO_ERROR`	no sucesso
`WEAVE_END_OF_TLV`	se não existe tal elemento
`WEAVE_ERROR_WRONG_TLV_TYPE`	se existe tal elemento, mas não é um caminho

GetReaderOnArgument

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

Inicialize um TLVReader para apontar para o início do componente do argumento neste comando.

Detalhes

Parâmetros

[out] apReader

Um ponteiro para TLVReader, que será inicializado no elemento TLV do argumento em caso de sucesso

Valores Retornados

WEAVE_NO_ERROR

no sucesso

GetReaderOnPath

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

Inicialize um TLVReader para apontar para o início do componente do caminho neste comando.

Detalhes

Parâmetros

[out] apReader

Um ponteiro para TLVReader, que será inicializado no elemento TLV do argumento em caso de sucesso

Valores Retornados

WEAVE_NO_ERROR

no sucesso

Iniciar

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

Inicialize o objeto analisador com TLVReader.

Detalhes

Parâmetros

[in] aReader

Um ponteiro para um TLVReader, que deve apontar para o início desta solicitação

Valores Retornados

WEAVE_NO_ERROR

no sucesso