IDomainSystem::GetProcessStatus: различия между версиями

Материал из CAMaaS preliminary wiki
Перейти к навигации Перейти к поиску
Строка 1: Строка 1:
{{NavBar|{{Системная иерархия:IDomainSystem}} \ GetProcessStatus}}
{{NavBar|{{Системная иерархия:IDomainSystem}} \ [[IDomainSystem::GetProcessStatus|GetProcessStatus]]}}


{{function begin|std::uint32_t GetProcessStatus(const char* pProcessName, size_type cchProcessName) const;|{{IDomainSystem::GetProcessStatus brief}}.}}
{{function begin|domain_response_code_t GetProcessStatus(_In_count_(cchProcessName) const char* pProcessName, size_type cchProcessName, _Out_ status_id_t* pStatusId) const;
domain_response_code_t GetProcessStatus(_In_z_ const char* pszProcessName, _Out_ status_id_t* pStatusId) const;|{{IDomainSystem::GetProcessStatus brief}}.
 
# Использует имя процесса, заданное строкой ограниченной длины.
# В качестве имени использует C-строку.
}}
{{function paramlist begin}}
{{function paramlist begin}}
{{function paramlist add|pProcessName|Имя, ассоциированное с процессом моделирования в [[подсистема управления|подсистеме управления]] и указываемое при запуске процесса функцией [[IDomainSystem::StartSimulation]]. Формат: строка UTF-8 без завершающего терминального нуля.|paramdir=[in]}}
{{function paramlist add|pProcessName|Имя, ассоциированное с процессом моделирования в [[подсистема управления|подсистеме управления]] и указываемое при запуске процесса функцией [[IDomainSystem::StartSimulation]]. Формат: строка UTF-8 без завершающего терминального нуля.|paramdir=[in]}}
{{function paramlist add|pszProcessName|Аналогично, но с завершающим нулем.|paramdir=[in]}}
{{function paramlist add|cchProcessName|Длина имени процесса моделирования <tt>pProcessName</tt> в байтах.}}
{{function paramlist add|cchProcessName|Длина имени процесса моделирования <tt>pProcessName</tt> в байтах.}}
{{function paramlist add|pStatusId|Четырехбайтовый идентификатор статуса процесса моделирования. Возможные возвращаемые значения приведены в таблице. {{process_status_id}} [[Подсистема управления]] передает возвращенное значение пользователю.|paramdir=[out]}}
{{function paramlist end}}
{{function paramlist end}}
{{function return_value|Четырехбайтовый идентификатор состояния процесса моделирования. Возможные возвращаемые значения: {{process_status_id}}. [[Подсистема управления]] передает возвращенное значение пользователю.}}
{{function return_value|Код ответа, установленный предметной областью с помощью метода [[IControlSystemDomainSide::FormResponse]].}}
{{function sa begin}}
{{function sa begin}}
{{function sa add|[[IDomainSystem::StartSimulation]]|{{IDomainSystem::StartSimulation brief}}}}
{{function sa add|[[IDomainSystem::StartSimulation]]|{{IDomainSystem::StartSimulation brief}}}}
{{function sa end}}
{{function sa end}}
{{function end}}
{{function end}}

Версия 00:06, 14 июня 2016

Компоненты на верхнем уровне \ Вычислительная подсистема \ Подсистема предметной области \ IDomainSystem \ GetProcessStatus
domain_response_code_t GetProcessStatus(_In_count_(cchProcessName) const char* pProcessName, size_type cchProcessName, _Out_ status_id_t* pStatusId) const;
domain_response_code_t GetProcessStatus(_In_z_ const char* pszProcessName, _Out_ status_id_t* pStatusId) const;

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

  1. Использует имя процесса, заданное строкой ограниченной длины.
  2. В качестве имени использует C-строку.
Параметры
[in]pProcessNameИмя, ассоциированное с процессом моделирования в подсистеме управления и указываемое при запуске процесса функцией IDomainSystem::StartSimulation. Формат: строка UTF-8 без завершающего терминального нуля.
[in]pszProcessNameАналогично, но с завершающим нулем.
cchProcessNameДлина имени процесса моделирования pProcessName в байтах.
[out]pStatusIdЧетырехбайтовый идентификатор статуса процесса моделирования. Возможные возвращаемые значения приведены в таблице.
Символическое имяЦелочисленное значениеОписание
status_not_found0Процесс с заданным именем не существует.
status_running1Процесс выполняется.
status_idle2Процесс завершен и ожидает закрытия.
Подсистема управления передает возвращенное значение пользователю.
Возвращаемое значение:
Код ответа, установленный предметной областью с помощью метода IControlSystemDomainSide::FormResponse.
См. также
IDomainSystem::StartSimulationАсинхронно запустить процесс моделирования над заданной моделью среды физического поля, ассоциировать с процессом моделирования заданное имя, идентифицирующее его в подсистеме управления.