Changeset c591d48 in OpenModelica
- Timestamp:
- 2020-10-22T07:56:54+02:00 (4 years ago)
- Branches:
- Added-citation-metadata, maintenance/v1.17, maintenance/v1.18, maintenance/v1.19, maintenance/v1.20, maintenance/v1.21, maintenance/v1.22, maintenance/v1.23, master, omlib-staging
- Children:
- a0d552b
- Parents:
- ca381c7
- git-author:
- Bernhard Thiele <bernhard.thiele@…> (10/18/20 00:14:24)
- git-committer:
- Martin Sjölund <martin+github@…> (10/22/20 07:56:54)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/UsersGuide/source/systemidentification.rst
rca381c7 rc591d48 372 372 373 373 374 oms_status_str 375 -------------- 376 377 Mapping of enum C-API status code (oms_status_enu_t) to string. 378 379 The C enum is reproduced below for convenience. 380 381 .. code-block:: c 382 383 typedef enum { 384 oms_status_ok, 385 oms_status_warning, 386 oms_status_discard, 387 oms_status_error, 388 oms_status_fatal, 389 oms_status_pending 390 } oms_status_enu_t; 391 392 PYTHON 393 ^^^^^^ 394 395 Args: 396 :status: (int) The C-API status code. 397 398 Returns: 399 :status_str: (str) String representation of status code. 400 401 The range of values of :code:`status` corresponds to the C enum (by implicit conversion). 402 This is a static Python method (:code:`@staticmethod`). 403 404 .. code-block:: python 405 406 status_str = oms_status_str(status) 407 408 C 409 ^ 410 411 Not available. 412 413 414 omsi_simodelstate_str 415 --------------------- 416 417 Mapping of enum C-API state code (omsi_simodelstate_t) to string. 418 419 The C enum is reproduced below for convenience. 420 421 .. code-block:: c 422 423 typedef enum { 424 omsi_simodelstate_constructed, //!< After omsi_newSysIdentModel 425 omsi_simodelstate_initialized, //!< After omsi_initialize 426 omsi_simodelstate_convergence, //!< After omsi_solve if Ceres minimizer returned with ceres::TerminationType::CONVERGENCE 427 omsi_simodelstate_no_convergence, //!< After omsi_solve if Ceres minimizer returned with ceres::TerminationType::NO_CONVERGENCE 428 omsi_simodelstate_failure //!< After omsi_solve if Ceres minimizer returned with ceres::TerminationType::FAILURE 429 } omsi_simodelstate_t; 430 431 PYTHON 432 ^^^^^^ 433 434 Args: 435 :state: (int) State of SysIdent model. 436 437 Returns: 438 :simodelstate_str: (str) String representation of state code. 439 440 The range of values of :code:`state` corresponds to the C enum (by implicit conversion). 441 This is a static Python method (:code:`@staticmethod`). 442 443 .. code-block:: python 444 445 simodelstate_str = omsi_simodelstate_str(state) 446 447 C 448 ^ 449 450 Not available. 451 452 374 453 setOptions_max_num_iterations 375 454 -----------------------------
Note: See TracChangeset
for help on using the changeset viewer.