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

Материал из CAMaaS preliminary wiki
Перейти к навигации Перейти к поиску
(Новая страница: «{{NavBar|{{Системная иерархия:IDomainSystem}} \ GetProcessStatus}} {{function begin|std::uint32_t GetProcessStatus(const char* pProcessName, siz…»)
 
 
(не показано 7 промежуточных версий этого же участника)
Строка 1: Строка 1:
{{NavBar|{{Системная иерархия:IDomainSystem}} \ GetProcessStatus}}
{{NavBar|{{Системная иерархия:IDomainSystem}} \ [[IDomainSystem::GetProcessStatus|GetProcessStatus]]}}


{{function begin|std::uint32_t GetProcessStatus(const char* pProcessName, size_type cchProcessName);|{{IDomainSystem::GetProcessStatus brief}}.}}
{{function begin|domain_response_code_t GetProcessStatus(const char* pProcessName, size_type cchProcessName, status_id_t* pStatusId) const noexcept;|{{IDomainSystem::GetProcessStatus brief}}}}
{{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|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 details|Функция должна возвращать идентификатор состояния процесса моделирования. Возможные возвращаемые значения: {{process_status_id}}. [[Подсистема управления]] передает возвращенное значение пользователю.}}
{{function return_value|Код ответа, установленный предметной областью с помощью метода [[IControlSystemDomainSide::FormResponse]]. См. [[domain_response_code_t]].}}
{{function exceptionlist begin}}
{{function exceptionlist add|[http://www.chusov.org/doxygen/struct_chusov_1_1_exceptions_1_1_already_exists_exception.html Chusov::Exceptions::AlreadyExistsException]|Узел уже исполняет другой процесс моделирования.}}
{{function exceptionlist end}}
{{function sa begin}}
{{function sa begin}}
{{function sa add|[[IDomainSystem::CloseSimulation]]|Остановка и закрытие процесса моделирования с освобождением занятых ресурсов.}}
{{function sa add|[[IDomainSystem::StartSimulation]]|{{IDomainSystem::StartSimulation brief}}}}
{{function sa end}}
{{function sa end}}
{{function end}}
{{function end}}

Текущая версия на 00:13, 19 ноября 2017

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

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

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