Package NetworkEditor :: Module ports :: Class Port

Class Port

               object --+        
                        |        
itemBase.NetworkItemsBase --+    
                            |    
        itemBase.NetworkItems --+
                                |
                               Port

Known Subclasses:: InputPort, OutputPort, SpecialInputPort, SpecialOutputPort

base class for input/output ports of network nodes

Instance Methods

[hide private]

__init__(self, name, node, datatype='None', balloon=None, width=None, height=None, beforeConnect=None, afterConnect=None, beforeDisconnect=None, afterDisconnect=None, hasHiddenConnections=False, shape=None, color=None, originalDatatype=None)

setCallback(self, code, key)
set callbacks for connect & disconnect evens.

editorVisible(self)
returns True if the port's Editor is visible

getDatatypeObjectFromDatatype(self, datatype)

setDataType(self, datatype, tagModified=True, makeOriginal=False)
set the port's data type.

__repr__(self)
repr(x)

getColor(self)

setColor(self, color)

getCenterCoords(self)

buildIcons(self, resize=True)
method to be implmented by subclass this method should create the geometric primitives for this item and tag them all with self.iconTag define its uniqueTag set its tags

showData(self)

openDataViewer(self)

dismiss(self, event=None)

clearDataView(self)

getDataStr(self, maxLen=None)

updateDataView(self)

browseData(self)
open introspect GUI

_introspectCB(self)
helper method used for the introspect data GUI

edit(self, event=None)

typeName(self, t)

deleteIcon(self)
deleting the port's icon

datatypeStr(self)

createIcon(self, pcx=None, pcy=None)

destroyIcon(self)
called by net.deleteNodes(): delete port menu, delete port icon

computePortPosX(self)
compute offset from left.

destinationPortsCoords(self, tag)

getDescr(self)
Returns a dictionnary providing the port's configuration.

configure(self, redo=1, **kw)
configure a Port object.

updateIconPosition(self)
move this icon to new location, also update connections

startConnectRubberBand(self, event)

drawRubberBand(self, event=None)

connectNodesEnd(self, event=None)

createConnection(self, port1, port2, **kw)

compareToOrigPortDescr(self)
Compare this port to the original portDescr defined in a given network node base class and return a dictionary with the differences

Inherited from itemBase.NetworkItems: afterAddingToNetwork, afterRemovingFromNetwork, beforeAddingToNetwork, beforeRemovingFromNetwork, deletePort, deselect, editNodeMenu, freeze, gettags, hideParamPanel, highlight, introspect, postItemMenu, rename, run, schedule_cb, select, toggleAutoRun_cb, toggleFrozen_cb, unfreeze, unhighlight

Inherited from itemBase.NetworkItemsBase: delEditor, getEditor, setEditor

Inherited from itemBase.NetworkItemsBase (private): _setModified, _setOriginal

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __str__

Properties

[hide private]

Inherited from itemBase.NetworkItemsBase: editor

Inherited from object: __class__

Method Details

Class Port

__init__(self, name, node, datatype='None', balloon=None, width=None, height=None, beforeConnect=None, afterConnect=None, beforeDisconnect=None, afterDisconnect=None, hasHiddenConnections=False, shape=None, color=None, originalDatatype=None) (Constructor)

setCallback(self, code, key)

editorVisible(self)

getDatatypeObjectFromDatatype(self, datatype)

setDataType(self, datatype, tagModified=True, makeOriginal=False)

__repr__(self) (Representation operator)

getColor(self)

setColor(self, color)

getCenterCoords(self)

buildIcons(self, resize=True)

showData(self)

openDataViewer(self)

dismiss(self, event=None)

clearDataView(self)

getDataStr(self, maxLen=None)

updateDataView(self)

browseData(self)

_introspectCB(self)

edit(self, event=None)

typeName(self, t)

deleteIcon(self)

datatypeStr(self)

createIcon(self, pcx=None, pcy=None)

destroyIcon(self)

computePortPosX(self)

destinationPortsCoords(self, tag)

getDescr(self)

configure(self, redo=1, **kw)

updateIconPosition(self)

startConnectRubberBand(self, event)

drawRubberBand(self, event=None)

connectNodesEnd(self, event=None)

createConnection(self, port1, port2, **kw)

compareToOrigPortDescr(self)

init(self, name, node, datatype='None', balloon=None, width=None, height=None, beforeConnect=None, afterConnect=None, beforeDisconnect=None, afterDisconnect=None, hasHiddenConnections=False, shape=None, color=None, originalDatatype=None)
(Constructor)

repr(self)
(Representation operator)