papi.gui.default package

Submodules

papi.gui.default.CreatePluginDialog module

Contributors Sven Knuth

class papi.gui.default.CreatePluginDialog.CreatePluginDialog(gui_api, tab_manager, parent=None)

Bases: PyQt5.QtWidgets.QDialog, papi.ui.gui.default.PluginCreateDialog.Ui_CreatePluginDialog

This class create a dialog which enable an user to modify the default configuration of a plugin.

accept()

This function is called when the user accepts the current modification and wants to create the plugin.

Returns:

clear_layout(layout)

This function is called to remove all elements within a tab. It is called in showEvent.

Parameters:layout – Returns:

keyPressEvent(event)

Default callback function which is called when an any key was pressed by the user.

Parameters:event – Returns:

reject()

This function is called when the user closes the dialog without creating a plugin.

Returns:

set_dplugin(dplugin, startup_config, type)

Additionally to set_plugin it is also possible to provide a DPlugin object. This feature is used by copy a currently running plugin. The ‘type’ of the plugin must be provided.

Parameters:

• dplugin – Data object which describes the running plugin.
• startup_config – Configuration used at startup. Contains user modification by the user.
• type –

Returns:

set_plugin(plugin_info)

This function must be called before the dialog is shown.

Parameters:plugin_info – The plugin info object provided by yapsy. Returns:

showEvent(*args, **kwargs)

This function is called before the dialog is displayed.

Parameters:

• args –
• kwargs –

Returns:

papi.gui.default.CreatePluginMenu module

Contributors Sven Knuth

class papi.gui.default.CreatePluginMenu.CreatePluginMenu(gui_api, TabManger, plugin_manager, parent=None)

Bases: PyQt5.QtWidgets.QMainWindow, papi.ui.gui.default.PluginCreateMenu.Ui_PluginCreateMenu

This class creates a menu which displays all available plugins. This menu is used to create plugin.

changed_search_plugin_text_field(value)

This function is triggered by the user. It is called when the text in the search field is changed. The plugin-Tree is filtered by value

Parameters:value – Returns:

clear()

This function is called to reset all necessary labels and line edits.

Returns:

closeEvent(*args, **kwargs)

Handles close events for this windows. Closing windows will also close the plugin create dialog.

Parameters:

• args –
• kwargs –

Returns:

get_plugin_root(path)

This function returns one of the root-Items of the plugin tree. The root-Item is determined by the plugin path.

Returns:

help_button_triggered()

This function opens the documentation page a plugin in the default web browser. An user opens the page by selecting a plugin and clicking on the ‘Help’ button.

Returns:

keyPressEvent(event)

Default callback function which is called when an arbitrary key was pressed by the user.

Parameters:event – Returns:

plugin_item_changed(index)

This function is called when the user selects another plugin in the plugin tree on the left side. Every change of plugin updates the displayed plugin information on the right side.

Parameters:index – Returns:

showEvent(*args, **kwargs)

This function is called when the dialog was displayed.

Parameters:

• args –
• kwargs –

Returns:

show_create_plugin_dialog()

This function opens the dialog which is used to create plugin. An user opens this dialog by selecting a plugin and clicking on the ‘Create Plugin’ button.

Returns:

papi.gui.default.GUI module

Contributors Sven Knuth, Stefan Ruppin

class papi.gui.default.GUI.GUI(core_queue=None, gui_queue=None, gui_id=None, gui_data=None, is_parent=False, parent=None)

Bases: PyQt5.QtWidgets.QMainWindow, papi.ui.gui.default.DefaultMain.Ui_DefaultMain

This class defines the default GUI written by PyQt5.

add_dplugin(dplugin)

Callback function called by ‘DPlugin added signal’ Used to add a DPlugin SubWindow on the GUI if possible.

Is called whenever a plugin was created.

Parameters:dplugin – Returns:

closeEvent(*args, **kwargs)

Handles close events. Saves current session as pc.PAPI_LAST_CFG_PATH Closes all opened windows.

Parameters:

• args –
• kwargs –

Returns:

fav_plugin_add(plugin_name)

This function is used to mark an arbitrary plugin as a favourite plugin. Favourite plugins are always displayed in the toolbar.

This function is called by dropping a plugin icon from the create menu on the toolbar. It is also called in the initialize phase of the gui for restoring favourite plugin in the configuration file.

Parameters:plugin_name – Name of the plugin Returns:

fav_plugin_was_removed()

This function is called when a favourite plugin was removed. This function is called by using the context menu of the toolbar and using it to remove a plugin.

Returns:

get_gui_config(save_user_settings=False)

Returns a dictionary which describes the current state of the GUI, like e.g. size, background image and postion.

This function is called when the current configuration is stored. This function is also called when a plugin was marked or unmarked as favourite plugin,

If ‘saveUserSettings==True’ the dictionary will also contain the current favourite plugins. It is not necessary to save user specific settings when a configuration was saved by using the ‘save configuration dialog’.

Parameters:save_user_settings – Returns:

init_gui_graphic()

Called to set mandatory variables, create child dialogs and actions. This function is called once within the constructor.

Returns:

init_set_icons()

This function sets the icon for all actions. This function is called once during the initializing of the GUI.

Returns:

keyPressEvent(event)

Default callback function which is called when an any key was pressed by the user.

Parameters:event – Returns:

keyReleaseEvent(event)

Default callback function which is called when any key was released by the user.

Parameters:event – Returns:

load_config(file_name)

Called with a PaPI XML Configuration which is determined by file_name, This function is called when a configuration file was chosen by the “Load Dialog” and during the initialize phase for loading the user specific configuration file.

Parameters:file_name – Returns:

remove_dplugin(dplugin)

Callback function called by ‘DPlugin removed signal’ Used to removed a DPlugin SubWindow from the GUI if possible.

Is called whenever a plugin was removed.

Parameters:dplugin – Returns:

resize_gui_window(w, h)

Internal function for resizing the window of the GUI.

Parameters:event – Returns:

run()

Creates a timer and sets an interval for processing events with working loop.

Returns:

set_gui_config(cfg)

A configuration as dictionary is loaded by this function. This function is called when a configuration was loaded. It restores attributes as size, position and favourite plugins.

Parameters:cfg –

:type {}; :return:

show_create_plugin_dialog(plugin_info)

Opens the create plugin dialog for a plugin described by plugin_info. Plugin_info is an object which is created by the plugin manager yapsy to describe a plugin. The description contains information like e.g., name and path.

This dialog is triggered by clicking on a favourite plugin.

Parameters:plugin_info – Returns:

signal_handler()

This handler will be called, when CTRL+C is used in the console It will react to SIGINT Signal As an reaction it will close the gui by first telling the core to close and then closing the gui

Returns:

toggleMenuBarHide()

toolbar_add_fav_plugin(plugin_info)

Adds an plugin described by plugin_info to the toolbar as an action. Plugin_info is an object which is created by the plugin manager yapsy to describe a plugin. The description contains information like e.g., name and path.

Parameters:plugin_info – Returns:

triggered_changed_dgui()

This is triggered to refresh the overview menu if it is active. This is needed to guarantee the consistency between the data structure dgui and the data seen by the user.

Returns:

triggered_error_occurred(title, msg, detailed_msg)

Triggered when an error occured. Creates an error dialog for the user. Title defines the title of the error dialog. Msg contains a messages displayed in the dialog. Detailed_msg should contain more information about the occured error which is optional displayed.

Parameters:

• title –
• msg –
• detailed_msg –

Returns:

triggered_load_config()

Used to open the ‘load config’ dialog. This function is triggered by using the action “Load” in the toolbar menu “PaPI” or by the action “Load” in the toolbar.

Returns:

triggered_open_create_plugin_menu()

Used to open the create plugin menu. This function is triggered by using the action “Create” in the toolbar menu “Plugin” or by the action “Create” in the toolbar.

Returns:

triggered_open_overview_menu()

Used to open the overview menu. This function is triggered by using the action “Overview” in the toolbar menu “Plugin” or by the action “Overview” in the toolbar.

Returns:

triggered_open_papi_about()

Opens a dialog with information about PaPI. This function is triggered by using the action “About” in the toolbar menu “Help”.

Returns:

triggered_open_papi_doc()

Opens the PaPI documentation in the default browser. This function is triggered by using the action “PaPI Doc” in the toolbar menu “Help”.

Returns:

triggered_open_qt_about()

Opens the default dialog provided by Qt which contains information about Qt. This function is triggered by using the action “About Qt” in the toolbar menu “Help”.

Returns:

triggered_plugin_died(dplugin, e, msg)

Triggered when a plugin died.

Parameters:

• dplugin –
• e –
• msg –

Returns:

triggered_reload_config()

This function is used to reset PaPI and to reload the last loaded configuration file.

Returns:

triggered_reload_plugin_db()

This callback function reloads the list of plugins of the plugin manager. This function is triggered by using the action “Reload DB” in the toolbar menu “Plugin”.

Returns:

triggered_reset_papi()

This function is called to reset PaPI. That means all subscriptions are canceled and all plugins are removed. This function is triggered by using the action “Reset” in the toolbar menu “PaPI” or by the action “Reset” in the toolbar.

Returns:

triggered_save_config()

Used to start the ‘save config’ dialog. This function is triggered by using the action “Save” in the toolbar menu “PaPI” or by the action “Save” in the toolbar.

Returns:

triggered_toggle_fullscreen()

Returns:

triggered_toggle_run_mode()

Toggles the run mode, i.e. it changes from active to passive and vice versa. This function is triggered by using the action “Toolbar” in the toolbar menu “View”.

Returns:

triggered_toggle_toolbar()

Used to toogle the vision of the the toolbar This function is triggered by using the action “Toolbar” in the toolbar menu “View”.

Returns:

papi.gui.default.GUI.run_gui_in_own_process(core_queue, gui_queue, gui_id, args)

This is the main function which is called to initialize and start the GUI. This function is called by the core process in the context of a new process thus the GUI is executed within its own process.

The multiprocessing queues ‘core_queue’ and ‘gui_queue’ are used for message exchange. Messages within ‘core_queue’ are received by the core, message within ‘gui_queue’ are appointed for the GUI. Events sent by the GUI are marked with ‘gui_id’. The object ‘args’ provides access to the provided cli arguments.

Parameters:

• core_queue (Queue) – link to queue of core
• gui_queue (Queue) – queue where gui receives messages
• gui_id (int) – id of gui for events

Returns:

papi.gui.default.GUI.startGUI_TESTMOCK(CoreQueue, GUIQueue, gui_id, data_mock)

Function to call to start gui operation Function is used for testing.

Parameters:

• CoreQueue (Queue) – link to queue of core
• GUIQueue (Queue) – queue where gui receives messages
• gui_id (int) – id of gui for events

Returns:

papi.gui.default.OverviewPluginMenu module

Contributors Sven Knuth

class papi.gui.default.OverviewPluginMenu.OverviewPluginMenu(gui_api, tabmanager, parent=None)

Bases: PyQt5.QtWidgets.QMainWindow, papi.ui.gui.default.PluginOverviewMenu.Ui_PluginOverviewMenu

This class is used to create an extra window which displays all created plugins. The information are taken by the corresponding DPlugin-Object of a plugin. By this window a user is also able to create and cancel subscriptions.

add_pcp_subscription_action(dplugin: papi.data.DPlugin.DPlugin, dparameter: <module 'papi.data.DParameter' from '/home/fescycling/PycharmProjects/PaPI/papi/data/DParameter.py'>, dplugin_pcp: papi.data.DPlugin.DPlugin, dblock_pcp: papi.data.DPlugin.DBlock)

This function is used to create a subscription for a process control plugin.

Parameters:

• dplugin – Subscriber of a pcp plugin
• dparameter – Parameter of the subscriber which should be controlled by the pcp plugin.
• dplugin_pcp – The pcp plugin
• dblock_pcp – Block of the pcp plugin which is used to control the subscriber’s parameter.

Returns:

add_subscription_action(dplugin_uname)

Used to add subscription for a specific dplugin

Parameters:dplugin_uname – Add Subscription for this DPlugin Returns:

cancel_subscription_action(source: papi.data.DPlugin.DPlugin, dblock: papi.data.DPlugin.DBlock, signals:[])

Action called to cancel a subscription of the current selected dplugin.

Parameters:

• source –
• dblock –

Returns:

changed_dplugin_tree_selection(new_selection, old_selection)

changed_search_plugin_text_field(value)

clear()

This function will clear this window. It is used to reset all elements in this windows.

Returns:

data_changed_block_model(index, n)

This function is called when a dblock child, a disgnal, is changed.

Parameters:

• index – Index of current changed dsignal object
• n – None

Returns:

data_changed_parameter_model(index, n)

This function is called when a dparameter value is changed by editing the ‘value’-column.

Parameters:

• index – Index of current changed dparameter
• n – None

Returns:

get_plugin_root(path)

keyPressEvent(event)

Used to handle key events for this gui element.

Parameters:event – KeyEvent Returns:

open_context_menu_block_tree(position)

This callback function is called to create a context menu for the block tree

Parameters:position – Returns:

open_context_menu_connection_tree(position)

This callback function is called to create a context menu for the subscriper tree

Parameters:position – Returns:

open_context_menu_dplugin_tree(position)

This callback function is called to create a context menu for the dplugin tree. It is triggered by use

Parameters:position – Returns:

open_context_menu_parameter_tree(position)

This callback function is called to create a context menu for the parameter tree

Parameters:position – Returns:

pause_button_callback()

Function pause_button_callback

Returns:

play_button_callback()

Callback function for the play button.

Returns:

plugin_item_changed(index)

Used to display all known information for a DPlugin which is accessible in the pluginTree by its index.

It is called when an user changes the selected plugin in the plugin tree.

Parameters:index – Current selected index Returns:

plugin_item_refresh(index)

This function is called when it’s known that the dplugin object, which describes the selected plugin, was changed.

Parameters:index – Returns:

refresh_action(new_dplugin: papi.data.DPlugin.DPlugin=None)

Used to refresh the overview menu view.

Parameters:new_dplugin – New dplugin which should be added in self.dpluginTreev. Returns:

remove_subscriber_action(subscriber: papi.data.DPlugin.DPlugin, dblock: papi.data.DPlugin.DBlock)

Used to remove a subscriber of the dplugin selected in the DPlugin tree.

Parameters:

• subscriber – Subscriber which is effected
• dblock – DBlock which should be unsubscribed by Subscriber

Returns:

showEvent(*args, **kwargs)

ShowEvent of this class.

Parameters:

• args –
• kwargs –

Returns:

show_create_plugin_dialog(dplugin)

show_internal_name_callback()

Callback function for ‘showInternalNameCheckBox’

Returns:

stop_start_button_callback()

Function stop_start_button_callback

Returns:

papi.gui.default.PaPITabManger module

Contributors: <Stefan Ruppin

class papi.gui.default.PaPITabManger.DefaultCloseBox(parent=None)

Bases: PyQt5.QtWidgets.QMessageBox

class papi.gui.default.PaPITabManger.PaPITabManger(tabWigdet=None, dgui=None, gui_api=None, parent=None, centralWidget=None)

Bases: PyQt5.QtCore.QObject

add_tab(name)

add_wind(name)

closeTab_by_ind(ind)

closeTab_by_name(name)

close_all_empty_tabs()

cmenu_close_tab()

cmenu_dock_window(tabarea, window)

cmenu_new_tab()

cmenu_new_tab_custom_name()

cmenu_new_window()

cmenu_rename_tab()

cmenu_rename_wind(window)

cmenu_set_bg()

cmenu_set_bg_window(window)

create_context_menu()

create_context_menu_window(tabWidget, window)

detach_tab()

disableContextMenus()

enableContextMenus()

getTabPosition_by_name(tabName)

get_currently_active_tab()

get_default_tab(NotThisIndex)

get_tabs_by_uname()

isContextMenuEnabled()

moveFromTo(start, dest, subWindow, posX=0, posY=0)

new_wind_close_event(event, handler, window)

redock_window(window)

remove_tab(tabObject)

remove_window(window, rm_from_data=True)

rename_tab(tabObject, new_name)

rename_window(window, new_name)

select_next_tab()

select_prev_tab()

setTabsCloseable(closeable)

setTabsMoveable(moveable)

setTabs_movable_closable(move, close)

set_all_tabs_to_close_when_empty(state)

set_background_for_tab_with_name(name, bg)

set_tab_active_by_index(index)

set_tab_active_by_name(tabName)

show_context_menu(pos)

show_context_menu_window(pos, window)

class papi.gui.default.PaPITabManger.PaPIWindow(windowName, conextMenu=None, parent=None)

Bases: PyQt5.QtWidgets.QMainWindow

addSubWindow(subwindow)

background

getBackground()

getName()

isEmpty()

name

removeSubWindow(subwindow)

setBackground(bg)

setName(name)

setNewWindowName(newName)

subWindowList()

class papi.gui.default.PaPITabManger.TabObject(name, windowName=0, parent=None)

Bases: PyQt5.QtWidgets.QMdiArea

getBackground_image()

isEmpty()

resizeEvent(QResizeEvent)

setBackground_image(image)

papi.gui.default.custom module

Contributors Sven Knuth

class papi.gui.default.custom.ColorLineEdit

Bases: PyQt5.QtWidgets.QPushButton

A QColorDialog is used to determine the content of this QLineEdit. Used in the ‘CreatePluginDialog’ for a config element if the config elements contains the type : ‘color’

open_color_picker()

set_default_color(color_string)

class papi.gui.default.custom.FileLineEdit

Bases: PyQt5.QtWidgets.QLineEdit

A QFileDialog is used to determine the content of this QLineEdit. Used in the ‘CreatePluginDialog’ for a config element if the config elements contains the type : ‘file’

mousePressEvent(event)

set_file_type(type)

class papi.gui.default.custom.PaPIConfigSaveDialog(parent, gui_api)

Bases: PyQt5.QtWidgets.QFileDialog

The default QFileDialog for save operations was enhanced by additional options. These options are hidden in the QFileDialog till the ‘More Details’-Button was clicked.

button_clicked()

fill_with()

get_create_lists()

select_items(flag)

select_simulink_ortd()

papi.gui.default.item module

Contributors Sven Knuth

class papi.gui.default.item.CustomFieldModel(parent=None)

Bases: PyQt5.QtGui.QStandardItemModel

data(index, role=None)

For Qt.Role see ‘http://qt-project.org/doc/qt-4.8/qt.html#ItemDataRole-enum‘ :param index: :param role: :return:

setData(index, value, role=None)

This function is called when a content in a row is edited by the user.

Parameters:

• index – Current selected index.
• value – New value from user
• role –

Returns:

class papi.gui.default.item.DBlockTreeItem(dblock: papi.data.DPlugin.DBlock)

Bases: papi.gui.default.item.PaPITreeItem

get_decoration()

class papi.gui.default.item.DBlockTreeModel(check_box, parent=None)

Bases: papi.gui.default.item.PaPITreeModel

flags(index)

This function returns the flags for a specific index.

For Qt.ItemFlags see ‘http://qt-project.org/doc/qt-4.8/qt.html#ItemFlag-enum‘ :param index: :return:

setData(index, value, role=None)

This function is called when a content in a row is edited by the user.

Parameters:

• index – Current selected index.
• value – New value from user
• role –

Returns:

class papi.gui.default.item.DParameterTreeItem(dparameter: <module 'papi.data.DParameter' from '/home/fescycling/PycharmProjects/PaPI/papi/data/DParameter.py'>)

Bases: papi.gui.default.item.PaPITreeItem

get_decoration()

class papi.gui.default.item.DParameterTreeModel(parent=None)

Bases: papi.gui.default.item.PaPITreeModel

This model is used to handle DParameter objects in TreeView.

data(index, role=None)

For Qt.Role see ‘http://qt-project.org/doc/qt-4.8/qt.html#ItemDataRole-enum‘ :param index: :param role: :return:

flags(index)

This function returns the flags for a specific index.

For Qt.ItemFlags see ‘http://qt-project.org/doc/qt-4.8/qt.html#ItemFlag-enum‘ :param index: :return:

setData(index, value, role=None)

This function is called when a content in a row is edited by the user.

Parameters:

• index – Current selected index.
• value – New value from user
• role –

Returns:

class papi.gui.default.item.DPluginTreeItem(dplugin: papi.data.DPlugin.DPlugin)

Bases: papi.gui.default.item.PaPITreeItem

get_decoration()

class papi.gui.default.item.DPluginTreeModel(parent=None)

Bases: papi.gui.default.item.PaPITreeModel

This model is used to handle DPlugin objects in TreeView.

class papi.gui.default.item.DSignalTreeItem(dsignal: papi.data.DSignal.DSignal, check_box)

Bases: papi.gui.default.item.PaPITreeItem

data(role=None, **kwargs)

For Qt.Role see ‘http://qt-project.org/doc/qt-4.8/qt.html#ItemDataRole-enum‘ :param role: :return:

get_decoration()

class papi.gui.default.item.PaPIFavAction(*args, **kwargs)

Bases: PyQt5.QtWidgets.QAction

class papi.gui.default.item.PaPIMDISubWindow

Bases: PyQt5.QtWidgets.QMdiSubWindow

mouseMoveEvent(event)

set_movable(flag)

class papi.gui.default.item.PaPIRootItem(name)

Bases: papi.gui.default.item.PaPITreeItem

data(role=None, **kwargs)

For Qt.Role see ‘http://qt-project.org/doc/qt-4.8/qt.html#ItemDataRole-enum‘ :param role: :return:

hasItem(searched_item)

Used to check if an item is already part of this Tree

Parameters:searched_item – Searched for this item Returns:

mark_visibility_by_name(value)

class papi.gui.default.item.PaPIToolbar(*args, **kwargs)

Bases: PyQt5.QtWidgets.QToolBar

clickedFavouritePlugin

customMenu(position)

dragEnterEvent(event: PyQt5.QtGui.QDragEnterEvent)

dropEvent(event: PyQt5.QtGui.QDropEvent)

removeFavouritePlugin(action: papi.gui.default.item.PaPIFavAction)

removedFavouritePlugin

class papi.gui.default.item.PaPITreeItem(object, name)

Bases: PyQt5.QtGui.QStandardItem

Default Tree item as it is used in PaPI.

clean()

This function is called to remove all rows which contain an item marked as ‘deleted’. This only works with items having an state-attribute e.g. DPlugin.

Returns:True if items were removed and has no more children

data(role=None, **kwargs)

For Qt.Role see ‘http://qt-project.org/doc/qt-4.8/qt.html#ItemDataRole-enum‘ :param role: :return:

get_decoration()

class papi.gui.default.item.PaPITreeModel(parent=None)

Bases: PyQt5.QtGui.QStandardItemModel

flags(index)

mark_visibility_by_name(name)

remove_item(remove_item)

class papi.gui.default.item.PaPITreeProxyModel

Bases: PyQt5.QtCore.QSortFilterProxyModel

filterAcceptsRow(p_int: int, sourceParent: PyQt5.QtCore.QModelIndex)

class papi.gui.default.item.PluginTreeItem(plugin_info)

Bases: papi.gui.default.item.PaPITreeItem

data(role=None, **kwargs)

get_decoration()

class papi.gui.default.item.PluginTreeModel(parent=None)

Bases: papi.gui.default.item.PaPITreeModel

This model is used to handle Plugin objects in TreeView created by the yapsy plugin manager.

Module contents

Contributors Sven Knuth

papi.gui.default.get16Icon(file)

papi.gui.default.get16Pixmap(file)

papi.gui.default.get32Icon(file)

papi.gui.default.get32Pixmap(file)