rosetta.utility.signals
index
(built-in)

Bindings for utility::signals namespace

 
Classes
       
builtins.object
Link
LinkUnit

 
class Link(builtins.object)
    interface wrapper around utility::signals::LinkUnit
 
 
Can be used to manage the link between Subject
 and Observer.  Signals can be temporarily blocked and the
 connection can be invalidated (disconnected) by the user.
 If a Subject is destroyed or a manual disconnect is called
 via the SignalHub, the Link will automatically become invalidated.
 
 
Returned by utility::signals::SignalHub upon connection.
 
  Methods defined here:
__eq__(...) from builtins.PyCapsule
__eq__(self : rosetta.utility.signals.Link, rval : rosetta.utility.signals.Link) -> bool
 
equality comparison
__init__(...) from builtins.PyCapsule
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(rosetta.utility.signals.Link) -> NoneType
 
2. __init__(self : rosetta.utility.signals.Link, unit : rosetta.utility.signals.LinkUnit) -> NoneType
 
3. __init__(self : rosetta.utility.signals.Link, rval : rosetta.utility.signals.Link) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.utility.signals.Link, rval : rosetta.utility.signals.Link) -> rosetta.utility.signals.Link
 
copy assignment
block(...) from builtins.PyCapsule
block(rosetta.utility.signals.Link) -> NoneType
 
locally block the link
blocked(...) from builtins.PyCapsule
blocked(rosetta.utility.signals.Link) -> bool
 
link blocked?
 
 
 true if link is blocked or empty, otherwise false
empty(...) from builtins.PyCapsule
empty(rosetta.utility.signals.Link) -> bool
 
link empty?
invalidate(...) from builtins.PyCapsule
invalidate(rosetta.utility.signals.Link) -> NoneType
 
cut the connection, safe to call even when link is empty
unblock(...) from builtins.PyCapsule
unblock(rosetta.utility.signals.Link) -> NoneType
 
locally unblock the link
valid(...) from builtins.PyCapsule
valid(rosetta.utility.signals.Link) -> bool
 
link still valid?
 
 
 false if link invalid or empty, otherwise true

 
class LinkUnit(builtins.object)
    struct specifying actual link data between observers and subjects
 
 
Used internally by SignalHub.  There is no copy constructor and
 copy assignment, a LinkUnit is meant to be created only once for each connection.
 
  Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(self : rosetta.utility.signals.LinkUnit, capsule) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Data descriptors defined here:
blocked
valid