get_status_messages

class ansys.systemcoupling.core.adaptor.api_24_2.get_status_messages.get_status_messages(name=None, parent=None)

Bases: InjectedCommand

Provides information relating to the current state of the analysis setup.

The return value is a list of dictionaries. Each dictionary holds a single message about the setup status, along with some associated information. The dictionary has string-valued fields: "message", "level", and "path".

The "message" field is the actual text of the message.

Note

In the current release, generated messages have not been adapted to the PySystemCoupling environment and may use naming and terminology that is native to the System Coupling application and its own command line interface.

Because there is generally a straightforward mapping to the PySystemCoupling exposure of settings and so on, the messages should not be difficult to interpret. Nevertheless, the get_status_messages method should be regarded as beta functionality in the current release.

The "level" field provides information about the severity or nature of the message. Possible values are "Error", "Warning", "Information", "Alpha", and "Beta". "Alpha" and "Beta" indicate settings related to activated alpha or beta features.

It is not possible to solve an analysis that has any issues at the "Error" severity level. An attempt to invoke the solve command while there are any errors results in an immediate failure.

If the "path" field is set, it contains a string representation of the path to the setting to which the message pertains. This is given in the form of chained Python attribute accesses starting from the setup attribute.

Thus, if an issue were detected that is specific to the absolute_gap_tolerance setting in a particular coupling interface, a "path" such as the following would be provided:

'coupling_interface["Interface-1"].mapping_control.absolute_gap_tolerance'

Included in:

Parent	Summary
setup_root	‘root’ object