Into

Modules

Documentation

classPiiSocket

#include <PiiSocket.h>

Socket is a connection point between operations.

Inherits QObject

Inherited by PiiInputSocket, PiiOutputSocket, PiiProbeInput, PiiProxySocket

Description

Each socket works either as an input, an output, or a proxy. Sockets within an operation are named uniquely so that inputs and outputs can be retrieved with identifier strings. Examples of such strings include "features", "class label", and "image". Usually, objectName is used to store the name of the socket. The name may, however, be different in different contexts. Operation compounds may expose their internal sockets with different names. To get the name of a socket in the context of an operation, use the PiiOperation::socketName() function.

Due to the fact that QObject doesn't support virtual inheritance, all concrete implementations of this interface also derive from PiiAbstractSocket.

Public types

enum
{ Input, Output, Proxy }

Socket types.

Constructors and destructor

( )

Public member functions

( )  = 0

Returns a pointer to this socket as PiiAbstractInputSocket, if this socket is either an Input or a Proxy.

( )  = 0

Returns a pointer to this socket as PiiAbstractOutputSocket, if this socket is either an Output or a Proxy.

virtual Q_INVOKABLE Type
( )  = 0

Get the type of the socket.

Protected member functions

( )

Enumeration details

  • enum Type

    Socket types.

Function details

  • PiiSocket

    ()
    [protected]
  • ~PiiSocket

    ()
  • virtual PiiAbstractInputSocket * asInput

    ()
    [pure virtual]

    Returns a pointer to this socket as PiiAbstractInputSocket, if this socket is either an Input or a Proxy.

    Otherwise returns zero.

  • virtual PiiAbstractOutputSocket * asOutput

    ()
    [pure virtual]

    Returns a pointer to this socket as PiiAbstractOutputSocket, if this socket is either an Output or a Proxy.

    Otherwise returns zero.

  • virtual Q_INVOKABLE Type type

    ()
    [pure virtual]

    Get the type of the socket.

    This function can be used for fast run-time type checking.

Notes (0)

Add a note

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