Into

Modules

Documentation

classPiiProbeInput

#include <PiiProbeInput.h>

An input socket that works without a controlling operation.

Inherits PiiSocket, PiiAbstractInputSocket, PiiInputController

Description

The socket works like a measurement probe that emits the objectReceived() signal whenever a new object is received. It also saves the last received object.

Signals

void
( )

Emitted whenever an object is received in this input socket.

Constructors and destructor

( )

Constructs a new probe input and sets its objectName property to name.

( )

Constructs a new probe input and connects it to output.

Public member functions

( )

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

( )

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

virtual PiiInputController *

Returns the input controller.

bool

Returns true if an object has been saved into this socket.

Returns the last received object.

void
( )

Sets the saved object to obj.

virtual PiiProbeInput *
( )

Returns a pointer to this socket as a PiiSocket.

virtual bool
( )

Emits objectReceived() and saves the received object.

virtual PiiSocket::Type
( )

Returns Input.

Function details

  • PiiProbeInput

    ( )

    Constructs a new probe input and sets its objectName property to name.

  • PiiProbeInput

    ( )

    Constructs a new probe input and connects it to output.

    Connects the objectReceived() signal to slot in receiver.

     PiiOperation* reader = engine.createOperation("PiiImageFileReader");
     PiiImageDisplay* display = new PiiImageDisplay;
     PiiProbeInput* probe = new PiiProbeInput(reader->output("image"),
                                              display, SLOT(setImage(PiiVariant)));
    
  • virtual PiiAbstractInputSocket * asInput

    ()
    [virtual]

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

    Otherwise returns zero.

    Reimplemented from PiiSocket.

  • virtual PiiAbstractOutputSocket * asOutput

    ()
    [virtual]

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

    Otherwise returns zero.

    Reimplemented from PiiSocket.

  • virtual PiiInputController * controller

    ()
    [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.

    Reimplemented from PiiAbstractInputSocket.

  • bool hasSavedObject

    ()

    Returns true if an object has been saved into this socket.

  • PiiVariant savedObject

    ()

    Returns the last received object.

    If no object has been received, returns an invalid variant.

  • void setSavedObject

    ( )

    Sets the saved object to obj.

  • virtual PiiProbeInput * socket

    ()
    [virtual]

    Returns a pointer to this socket as a PiiSocket.

    This is the preferred way of performing a cross-cast, even if dynamic_cast would work in most cases.

    Reimplemented from PiiAbstractSocket.

  • virtual bool tryToReceive

    ( )
    [virtual]

    Emits objectReceived() and saves the received object.

    Reimplemented from PiiInputController.

  • virtual PiiSocket::Type type

    ()
    [virtual]

    Returns Input.

    Reimplemented from PiiSocket.

  • void objectReceived

    ( )
    [signal]

    Emitted whenever an object is received in this input socket.

    Note that all objects, including control objects, will be emitted. The slot receiving the objects can filter the objects based on their type.

    See also
    • PiiYdin::isControlType()

Notes (0)

Add a note

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