Code Documentation

class stdcomQt.SubObject(name, Parent=None)

Internal use, not for users

class stdcomQt.Subscriber(name: str, cloud: stdcomQt.stecQSocket, DataCallBack=None, DescCallBack=None, Parent=None)

User connects to Multiverse just like c++ code Subscribers are used by any user to connect to a name or create a name on Multiverse

Data()

Returns

The data if it exists

Desc()

Returns

Description if exists

SetUserData(userData)

sets user data locally for user to decide what to do with can be anything

StartSingleShot()

interanl use :return:

UpdateData(what, index=0)

User can update multiverse with data :param what: Data to send to Muliverse :param index: Zero default, but it can be sent in the middle of an arrary :return:

UpdateDesc(what)

if we are the golden copy, we can send a Malcolm proof descriptor :param what: the descriptor :return:

UserData()

Users can attach user data here

deleteLater()

Deletes later inheritied

name

alias of str

newData(name, data)

intenal use :param name: subscription name :param data: Data :return:

newDesc(name, desc)

internal use :param desc: new description coming from multiverse :return:

class stdcomQt.stecQSocket(host: str = 'localhost', port: int = 4897, Parent=None)

Qt Style cBridge to Multiverse just like c++ code

Host()

Returns

current Host

InsertProxy(name)

Internal use, not for user :param name: name of the subscription :return:

Port()

Returns

current service Port

ProcessCommand(row)

internal use, decodes messages :param row: :return:

SlotConnected()

interal use Will restart any Subscription previously made :return:

SlotDataReady()

Internal use :return:

SlotDisconnected()

internal use :return:

SlotNewHost(host, port)

user can change the connection, by host and port :param host: :param port: :return:

SlotSocketError()

internal use called when connection to multiverse fails :return:

SlotTimerout()

internal use :return:

SlotWrite(command)

internal use :param command: :return:

isConnected()

returns true if connected to multiverse :return:

quit()

call before deletelater by user :return:

setOwner(name, description: str = 'Make this MalcolmProof Please', flag: bool = True)

Sets us as the owner of the subscription, we will automatically refeed multiverse if reset :param name: subscription name :param flag: True means we are golden copy, false restores to non-golden copy :return:

class stdcomutilitywidgets.StecIPconfigDialog(OkCallBack=None, CancelCallBack=None, ip='localhost', port='4897', parent=None)

IP Dialog, it is a IP and Port Configuation Dialog User can attach to sigNewIPPort to get IP and Port Changes

class stdcomutilitywidgets.StecPostgresConfigWidget(okCb=None, cancel=None, host: str = 'localhost', port: str = 5432, database: str = 'vremsoft', user: str = 'vremsoft', passowrd: str = 'vrem2010!', parent=None)

Configuration Widget for connecting to Stec Postgres Database

Cancel()

cancel ir pressed :return:

Ok()

when ok is pressed also self.OKSignal.emit(a, b, c, d, e) :return:

class stdcomutilitywidgets.StecTreeMorph(tree: PyQt5.QtWidgets.QTreeWidget, listOf=[''], parent=None)

Used to create a communication tree of names based on NextStep names It is passed with an exisiting QTreeWidget, this is the most userful of the tree widget because it uses exisitng QTreeWidgets

AddDesc(name, desc)

Parameters

• name – Name in the tree

• desc – Description of that name

Returns

AddName(name: str)

Connection from Multiverse, for one name at a time :param name: :return:

AddNames(names: list)

adds a list of names

DeleteSelected()

deletes selected items

clear()

clears the list, and puts the original back

getData(item: PyQt5.QtWidgets.QTreeWidgetItem)

gets

class stdcomvsettings.VSettings(project: str = 'stec-general')

Used to save setup data

class stdcomQtPjanice.pjanicesimpleGeneric(cBridge: Optional[stdcomQt.stecQSocket] = None, parent=None)

Stec Pjanice Widget, but with trees not list.

addRow()

adds a row to table

getcBridge()

return the current cBridge, the stdcomPyQt which is the qt version of the stdcom

mousePressEvent(self, QMouseEvent)

newData(name, data)

Internal use :param name: :param data: :return:

on_any_itemChanged(itm: PyQt5.QtWidgets.QTableWidgetItem)

when any item is clicked

slotDesc(name, desc)

internal use

slotNames(names)

internal use

slotSelected(name, desc)

selected slot, it tree item is clicked

.