MonitorsManager

An instance of MonitorsManager exists as an active monitors_streaming property in each solution-mode session object. It provides access to server monitors.

MonitorsManager.get_monitor_set_names()

Get monitor set names.

Parameters:

None

Returns:

List[str]

List of all monitor set names.

Return type:

List[str]

MonitorsManager.get_monitor_set_data(monitor_set_name, start_index=0, end_index=None)

Get monitor set data.

Parameters:

monitor_set_namestr

Name of the monitor set.

start_index: int, optional

Start index to provide data.

end_index: int, optional

End index to provide data.

Returns:

Tuple[np.array, Dict[str, np.array]]

Tuple containing two elements: a numpy array of x-axis values and a dictionary associating monitor names of type str to numpy arrays of y-axis values.

Return type:

Tuple[array, Dict[str, array]]

MonitorsManager.get_monitor_set_plot(monitor_set_name, *args, **kwargs)

Get monitor set plot.

Parameters:

monitor_set_namestr

Name of the monitor.

Returns:

Union[None, object]

Returns None if the DataFrame is empty. Otherwise, it returns the plot object, depending on the plotting.backend.

Return type:

Optional[object]