classPiiAbstractOutputSocket
#include <PiiAbstractOutputSocket.h>
An abstract superclass for output sockets.
Inherits PiiAbstractSocket
Inherited by PiiOutputSocket, PiiProxySocket
Description
Operations transfer objects to other operations through an output socket. The connection between an output socket and an input socket is one-directional: the output socket pushes data forwards, but the input cannot "pull" new objects. The input can, however, tell the output when it is ready to receive new data via the inputReady() signal.
This class is a representation of a connection point that is able to receive "I'm ready" signals from connected input sockets (inputReady()). The actual mechanism of passing data is defined in subclasses (PiiOutputSocket, PiiProxySocket).
When an input socket is deleted, its connection to an output socket is automatically destroyed and vice-versa.
Constructors and destructor
Public member functions
|
( )
Returns all inputs this socket is connected to. |
|
|
void
|
Connects this socket to the specified input socket. |
|
void
|
Disconnects this socket from an input. |
|
virtual void
|
Indicates this output socket that |
|
void
|
Reconnects all inputs currently connected to this output to
|
|
( )
Finds (backwards) the most distant output connected to this socket through proxies. |
|
|
void
|
Updates any cached information related to |
Protected member functions
|
virtual void
|
Called by connectInput() when an input has been connected. |
|
virtual void
|
Called by disconnectInput() when an input has been disconnected. |
|
virtual void
|
Called by updateInput() when an input has been updated. |
Function details
-
~PiiAbstractOutputSocket
() -
QList< PiiAbstractInputSocket * > connectedInputs
()Returns all inputs this socket is connected to.
-
void connectInput
Connects this socket to the specified input socket.
The new input will be appended to the list of connected inputs.
Parameters
- input
-
the input socket to connect
-
void disconnectInput
Disconnects this socket from an input.
After disconnect, objects emitted through this socket are no longer delivered to this input socket.
Parameters
- input
-
the input to disconnect from, or 0 if all connections are to be broken.
-
Indicates this output socket that
inputis ready to receive new objects.Used in communications between socket pairs.
-
void reconnect
Reconnects all inputs currently connected to this output to
output, and reconnects this output toinput. -
PiiAbstractOutputSocket * rootOutput
()Finds (backwards) the most distant output connected to this socket through proxies.
If the output is connected to an operation, this function returns
this. Otherwise it goes recursively back through all proxies until it finds an output that is connected to an operation. If there is no such output, returns 0. -
void updateInput
Updates any cached information related to
input.This function must be called by a connected input socket whenever its configuration (such as the controller) changes.
-
Called by connectInput() when an input has been connected.
The default implementation does nothing.
-
Called by disconnectInput() when an input has been disconnected.
The default implementation does nothing.
-
Called by updateInput() when an input has been updated.
The default implementation does nothing.
Add a note
Not a single note added yet. Be the first, add yours.