Into

Modules

Documentation

classPiiAbstractInputSocket

#include <PiiAbstractInputSocket.h>

An abstract superclass for input sockets.

Inherits PiiAbstractSocket

Inherited by PiiInputSocket, PiiProbeInput, PiiProxySocket

Description

Input sockets work as receivers in inter-operation connections. An input can be connected to only one output socket.

This class represents a connection point but provides no means of actually handling the received objects. Received objects are handled by an input controller (controller()).

Constructors and destructor

virtual

Public member functions

Returns the output this input socket is connected to.

void

Connects this socket to the given output socket.

virtual PiiInputController *
( )  = 0

Returns the input controller.

void

Disconnects this socket from its output socket.

Function details

  • virtual ~PiiAbstractInputSocket

    ()
    [virtual]
  • PiiAbstractOutputSocket * connectedOutput

    ()

    Returns the output this input socket is connected to.

    If the socket is not connected, 0 will be returned.

    Returns

    the output that sends objects to this input, or 0 if the socket is not connected

  • void connectOutput

    Connects this socket to the given output socket.

    If this socket is already connected, the old connection will be deleted. This is a utility function that calls PiiAbstractOutputSocket::connectInput().

  • virtual PiiInputController * controller

    ()
    [pure virtual]

    Returns the input controller.

    Input controller is responsible for handling all incoming objects to this socket. Typically, a single controller is shared by all inputs within an operation. This allows the controller to synchronize inputs with respect to each other.

  • void disconnectOutput

    ()

    Disconnects this socket from its output socket.

    If this socket is not connected, nothing happens. This is a utility function that calls PiiAbstractOutputSocket::disconnectInput().

Notes (0)

Add a note

Not a single note added yet. Be the first, add yours.