telsimui.applicationdefinitions Namespace Reference

Classes
class	ClientSufixAddressesEnum
	Sufix part of the URIs that specify the connection with respective service Server URL and Port will be extract from the TelMon datapoint (monitored_apps) More...
class	ExternalToolAction
	Class that handles preparation of parameters and starting external tool process It derives from :class ExternalAppAction which starts and manages external processes. More...
class	NumericalUnitsPropertyEnum
	Different ways to represent numerical values in the GUI. More...
class	SubTasksNamesEnum

Functions
def	add_global_datapoint_attribute (Logger logger, str uri)
def	block_widgets_handle_event (QWidget parent_widget, bool block)
	Based on a given parent widget check if children can be block when trying to update then selfs.
def	hide_show_property_widgets (QWidget parent_widget, type widget_type, str property_name, str property_value)
	Generic function that hides or shows specific type widgets with an inputted dynamic property.
def	change_widget_units (QWidget parent_widget, type widget_type, Enum unit_name=None, bool is_hms_dms=False)
	Function used to change unit of TaurusAngleLabel.
def	popup_message_box (QMessageBox.Icon type, str text)
	Call this to generate a Message Box based on the necessary type.
def	propagate_widget_ground_colors (QWidget widget, list propagate_types_list)
	Generic function that propagates the background and foreground colors of a child widget to his parents.
def	retrieve_subtask_instance (Logger logger, str name)

Variables
dict	DATAPOINTS_ATTRIBUTES = {}
tuple	SUBTASKS_HOLDER

Function Documentation

add_global_datapoint_attribute()

def telsimui.applicationdefinitions.add_global_datapoint_attribute	(	Logger	logger,
		str	uri
	)

block_widgets_handle_event()

def telsimui.applicationdefinitions.block_widgets_handle_event	(	QWidget	parent_widget,
		bool	block
	)

Based on a given parent widget check if children can be block when trying to update then selfs.

Parameters

parent_widget	Parent widget where will be run the QWidget::children() and iterate thought then
block	Flag value to be setted in the widget

change_widget_units()

def telsimui.applicationdefinitions.change_widget_units	(	QWidget	parent_widget,
		type	widget_type,
		Enum	unit_name = None,
		bool	is_hms_dms = False
	)

Function used to change unit of TaurusAngleLabel.

Parameters

parent_widget	Widget that holds label widgets
widget_type	Type of widgets which will have units changed (currently only TaurusAngleLabel provides such functionality)
units_name	Unit to be set. Set to 'None' by default cause it unnecesarry to be passed in HMS/DMS view case
is_hms_dms	Flag that should be set to 'True' if HMS/DMS unit view is selected

hide_show_property_widgets()

def telsimui.applicationdefinitions.hide_show_property_widgets	(	QWidget	parent_widget,
		type	widget_type,
		str	property_name,
		str	property_value
	)

Generic function that hides or shows specific type widgets with an inputted dynamic property.

Parameters

parent_widget	Main widget where will be run the QWidget::findChildren() and iterate thought then
widget_type	Type of widgets to apply the QWidget:hide() or QWidget:show() methods
property_name	Dynamic property to be verified
property_value	Property value to be checked

popup_message_box()

def telsimui.applicationdefinitions.popup_message_box	(	QMessageBox.Icon	type,
		str	text
	)

Call this to generate a Message Box based on the necessary type.

Parameters

type	MessageBox type to be instantiated
text	Text to be displayed in the MessageBox

propagate_widget_ground_colors()

def telsimui.applicationdefinitions.propagate_widget_ground_colors	(	QWidget	widget,
		list	propagate_types_list
	)

Generic function that propagates the background and foreground colors of a child widget to his parents.

Parameters

widget	Starting widget where the progation will begin
propagate_types_list	Types of widgets were the propagation will end. Order of elements gives the priority to finish.

retrieve_subtask_instance()

def telsimui.applicationdefinitions.retrieve_subtask_instance	(	Logger	logger,
		str	name
	)

Variable Documentation

DATAPOINTS_ATTRIBUTES

dict telsimui.applicationdefinitions.DATAPOINTS_ATTRIBUTES = {}

SUBTASKS_HOLDER

tuple telsimui.applicationdefinitions.SUBTASKS_HOLDER

Initial value:

=  (
    {}
)