Эта страница переведена с помощью Cloud Translation API.

нл:: Переплетение:: Профили:: DataManagement_Current:: ПользовательскаяКоманда:: Парсер

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

Определение синтаксического анализатора запросов пользовательских команд WDM.

Краткое содержание

Наследование

Наследуется от: nl::Weave::Profiles::DataManagement_Current::DataElement::Parser

Общественные функции
`CheckSchemaValidity (void) const`	`WEAVE_ERROR` Грубо проверьте правильность формирования сообщения.
`GetActionTimeMicroSecond (int64_t *const apActionTimeMicroSecond) const`	`WEAVE_ERROR` Получите запланированное время действия для этой команды.
`GetCommandType (uint64_t *const apCommandType) const`	`WEAVE_ERROR` Получите идентификатор типа команды для этой команды.
`GetExpiryTimeMicroSecond (int64_t *const apExpiryTimeMicroSecond) const`	`WEAVE_ERROR` Получите время истечения срока действия этой команды.
`GetInitiationTimeMicroSecond (int64_t *const apInitiationTimeMicroSecond) const`	`WEAVE_ERROR` Получите время запуска этой команды.
`GetMustBeVersion (uint64_t *const apMustBeVersion) const`	`WEAVE_ERROR` Получите обязательную версию для этой команды.
`GetPath ( Path::Parser *const apPath) const`	`WEAVE_ERROR` Инициализируйте Path::Parser с помощью компонента пути в этой команде.
`GetReaderOnArgument ( nl::Weave::TLV::TLVReader *const apReader) const`	`WEAVE_ERROR` Инициализируйте TLVReader, чтобы он указывал на начало компонента аргумента в этой команде.
`GetReaderOnPath ( nl::Weave::TLV::TLVReader *const apReader) const`	`WEAVE_ERROR` Инициализируйте TLVReader, чтобы он указывал на начало компонента пути в этой команде.
`Init (const nl::Weave::TLV::TLVReader & aReader)`	`WEAVE_ERROR` Инициализируйте объект синтаксического анализатора с помощью TLVReader.

Общественные функции

Проверка схемыдействительности

WEAVE_ERROR CheckSchemaValidity(
  void
) const

Грубо проверьте правильность формирования сообщения.

Подробности

Возвращаемые значения

WEAVE_NO_ERROR

об успехе

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

Получите запланированное время действия для этой команды.

Подробности

Параметры

[out] apActionTimeMicroSecond

Указатель на некоторую переменную для получения времени действия команды в случае успеха.

Возвращаемые значения

`WEAVE_NO_ERROR`	об успехе
`WEAVE_END_OF_TLV`	если такого элемента нет
`WEAVE_ERROR_WRONG_TLV_TYPE`	если такой элемент есть, но это не целое число со знаком

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const

Получите идентификатор типа команды для этой команды.

Подробности

Параметры

[out] apCommandType

Указатель на некоторую переменную для получения идентификатора типа команды в случае успеха.

Возвращаемые значения

`WEAVE_NO_ERROR`	об успехе
`WEAVE_END_OF_TLV`	если такого элемента нет
`WEAVE_ERROR_WRONG_TLV_TYPE`	если такой элемент есть, но это не целое число без знака

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

Получите время истечения срока действия этой команды.

Подробности

Параметры

[out] apExpiryTimeMicroSecond

Указатель на некоторую переменную для получения времени истечения срока действия в случае успеха.

Возвращаемые значения

`WEAVE_NO_ERROR`	об успехе
`WEAVE_END_OF_TLV`	если такого элемента нет
`WEAVE_ERROR_WRONG_TLV_TYPE`	если такой элемент есть, но это не целое число со знаком

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

Получите время запуска этой команды.

Подробности

Параметры

[out] apInitiationTimeMicroSecond

Указатель на некоторую переменную для получения времени инициации команды в случае успеха.

Возвращаемые значения

`WEAVE_NO_ERROR`	об успехе
`WEAVE_END_OF_TLV`	если такого элемента нет
`WEAVE_ERROR_WRONG_TLV_TYPE`	если такой элемент есть, но это не целое число со знаком

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const

Получите обязательную версию для этой команды.

Подробности

Параметры

[out] apMustBeVersion

Указатель на некоторую переменную для получения обязательной версии в случае успеха.

Возвращаемые значения

`WEAVE_NO_ERROR`	об успехе
`WEAVE_END_OF_TLV`	если такого элемента нет
`WEAVE_ERROR_WRONG_TLV_TYPE`	если такой элемент есть, но это не целое число без знака

GetPath

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

Инициализируйте Path::Parser с помощью компонента пути в этой команде.

Подробности

Параметры

[out] apPath

Указатель на Path::Parser , который в случае успеха будет инициализирован встроенным компонентом пути.

Возвращаемые значения

`WEAVE_NO_ERROR`	об успехе
`WEAVE_END_OF_TLV`	если такого элемента нет
`WEAVE_ERROR_WRONG_TLV_TYPE`	если такой элемент есть, но это не путь

GetReaderOnArgument

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

Инициализируйте TLVReader, чтобы он указывал на начало компонента аргумента в этой команде.

Подробности

Параметры

[out] apReader

Указатель на TLVReader, который в случае успеха будет инициализирован элементом аргумента TLV .

Возвращаемые значения

WEAVE_NO_ERROR

об успехе

GetReaderOnPath

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

Инициализируйте TLVReader, чтобы он указывал на начало компонента пути в этой команде.

Подробности

Параметры

[out] apReader

Указатель на TLVReader, который в случае успеха будет инициализирован элементом аргумента TLV .

Возвращаемые значения

WEAVE_NO_ERROR

об успехе

В этом

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

Инициализируйте объект синтаксического анализатора с помощью TLVReader.

Подробности

Параметры

[in] aReader

Указатель на TLVReader, который должен указывать на начало этого запроса.

Возвращаемые значения

WEAVE_NO_ERROR

об успехе

нл:: Переплетение:: Профили:: DataManagement_Current:: ПользовательскаяКоманда:: Парсер

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

Определение синтаксического анализатора запросов пользовательских команд WDM.

Краткое содержание

Наследование

Наследуется от: nl::Weave::Profiles::DataManagement_Current::DataElement::Parser

Общественные функции
`CheckSchemaValidity (void) const`	`WEAVE_ERROR` Грубо проверьте правильность формирования сообщения.
`GetActionTimeMicroSecond (int64_t *const apActionTimeMicroSecond) const`	`WEAVE_ERROR` Получите запланированное время действия для этой команды.
`GetCommandType (uint64_t *const apCommandType) const`	`WEAVE_ERROR` Получите идентификатор типа команды для этой команды.
`GetExpiryTimeMicroSecond (int64_t *const apExpiryTimeMicroSecond) const`	`WEAVE_ERROR` Получите время истечения срока действия этой команды.
`GetInitiationTimeMicroSecond (int64_t *const apInitiationTimeMicroSecond) const`	`WEAVE_ERROR` Получите время запуска этой команды.
`GetMustBeVersion (uint64_t *const apMustBeVersion) const`	`WEAVE_ERROR` Получите обязательную версию для этой команды.
`GetPath ( Path::Parser *const apPath) const`	`WEAVE_ERROR` Инициализируйте Path::Parser с помощью компонента пути в этой команде.
`GetReaderOnArgument ( nl::Weave::TLV::TLVReader *const apReader) const`	`WEAVE_ERROR` Инициализируйте TLVReader, чтобы он указывал на начало компонента аргумента в этой команде.
`GetReaderOnPath ( nl::Weave::TLV::TLVReader *const apReader) const`	`WEAVE_ERROR` Инициализируйте TLVReader, чтобы он указывал на начало компонента пути в этой команде.
`Init (const nl::Weave::TLV::TLVReader & aReader)`	`WEAVE_ERROR` Инициализируйте объект синтаксического анализатора с помощью TLVReader.

Общественные функции

Проверка схемыдействительности

WEAVE_ERROR CheckSchemaValidity(
  void
) const

Грубо проверьте правильность формирования сообщения.

Подробности

Возвращаемые значения

WEAVE_NO_ERROR

об успехе

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

Получите запланированное время действия для этой команды.

Подробности

Параметры

[out] apActionTimeMicroSecond

Указатель на некоторую переменную для получения времени действия команды в случае успеха.

Возвращаемые значения

`WEAVE_NO_ERROR`	об успехе
`WEAVE_END_OF_TLV`	если такого элемента нет
`WEAVE_ERROR_WRONG_TLV_TYPE`	если такой элемент есть, но это не целое число со знаком

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const

Получите идентификатор типа команды для этой команды.

Подробности

Параметры

[out] apCommandType

Указатель на некоторую переменную для получения идентификатора типа команды в случае успеха.

Возвращаемые значения

`WEAVE_NO_ERROR`	об успехе
`WEAVE_END_OF_TLV`	если такого элемента нет
`WEAVE_ERROR_WRONG_TLV_TYPE`	если такой элемент есть, но это не целое число без знака

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

Получите время истечения срока действия этой команды.

Подробности

Параметры

[out] apExpiryTimeMicroSecond

Указатель на некоторую переменную для получения времени истечения срока действия в случае успеха.

Возвращаемые значения

`WEAVE_NO_ERROR`	об успехе
`WEAVE_END_OF_TLV`	если такого элемента нет
`WEAVE_ERROR_WRONG_TLV_TYPE`	если такой элемент есть, но это не целое число со знаком

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

Получите время запуска этой команды.

Подробности

Параметры

[out] apInitiationTimeMicroSecond

Указатель на некоторую переменную для получения времени инициации команды в случае успеха.

Возвращаемые значения

`WEAVE_NO_ERROR`	об успехе
`WEAVE_END_OF_TLV`	если такого элемента нет
`WEAVE_ERROR_WRONG_TLV_TYPE`	если такой элемент есть, но это не целое число со знаком

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const

Получите обязательную версию для этой команды.

Подробности

Параметры

[out] apMustBeVersion

Указатель на некоторую переменную для получения обязательной версии в случае успеха.

Возвращаемые значения

`WEAVE_NO_ERROR`	об успехе
`WEAVE_END_OF_TLV`	если такого элемента нет
`WEAVE_ERROR_WRONG_TLV_TYPE`	если такой элемент есть, но это не целое число без знака

GetPath

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

Инициализируйте Path::Parser с помощью компонента пути в этой команде.

Подробности

Параметры

[out] apPath

Указатель на Path::Parser , который в случае успеха будет инициализирован встроенным компонентом пути.

Возвращаемые значения

`WEAVE_NO_ERROR`	об успехе
`WEAVE_END_OF_TLV`	если такого элемента нет
`WEAVE_ERROR_WRONG_TLV_TYPE`	если такой элемент есть, но это не путь

GetReaderOnArgument

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

Инициализируйте TLVReader, чтобы он указывал на начало компонента аргумента в этой команде.

Подробности

Параметры

[out] apReader

Указатель на TLVReader, который в случае успеха будет инициализирован элементом аргумента TLV .

Возвращаемые значения

WEAVE_NO_ERROR

об успехе

GetReaderOnPath

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

Инициализируйте TLVReader, чтобы он указывал на начало компонента пути в этой команде.

Подробности

Параметры

[out] apReader

Указатель на TLVReader, который в случае успеха будет инициализирован элементом аргумента TLV .

Возвращаемые значения

WEAVE_NO_ERROR

об успехе

В этом

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

Инициализируйте объект синтаксического анализатора с помощью TLVReader.

Подробности

Параметры

[in] aReader

Указатель на TLVReader, который должен указывать на начало этого запроса.

Возвращаемые значения

WEAVE_NO_ERROR

об успехе