NAP
Public Member Functions | List of all members
InputPinBase Class Referenceabstract

#include <audio/core/audiopin.h>

Public Member Functions

 InputPinBase (Node *node)
 
virtual ~InputPinBase ()
 
virtual void connect (OutputPin &input)=0
 
virtual void disconnect (OutputPin &input)=0
 
virtual void disconnectAll ()=0
 
virtual bool isConnected () const =0
 
void enqueueConnect (OutputPin &pin)
 
void enqueueDisconnect (OutputPin &pin)
 
NodegetNode ()
 

Description

Interface for InputPin and MultiInputPin classes

Inheritance diagram for InputPinBase:
[legend]

Constructor & Destructor Documentation

◆ InputPinBase()

InputPinBase ( Node node)

◆ ~InputPinBase()

virtual ~InputPinBase ( )
virtual

Member Function Documentation

◆ connect()

virtual void connect ( OutputPin input)
pure virtual

Connects a pin to this input. Disconnects the current connection first if necessary.

Implemented in MultiInputPin, and InputPin.

◆ disconnect()

virtual void disconnect ( OutputPin input)
pure virtual

Disconnects a pin from this input, if it is connected.

Implemented in MultiInputPin, and InputPin.

◆ disconnectAll()

virtual void disconnectAll ( )
pure virtual

Disconnects all pins connected to this pint.

Implemented in MultiInputPin, and InputPin.

◆ enqueueConnect()

void enqueueConnect ( OutputPin pin)

Enqueues a connect() call the be executed on the audio thread. This is the connect() function that is exposed to RTTR and to python.

◆ enqueueDisconnect()

void enqueueDisconnect ( OutputPin pin)

Enqueues a disconnect() call the be executed on the audio thread This is the disconnect() function that is exposed to RTTR and to python.

◆ getNode()

Node& getNode ( )
Returns
the node that owns this input.

◆ isConnected()

virtual bool isConnected ( ) const
pure virtual

Returns wether this pin is connected to one or more other pins.

Implemented in MultiInputPin, and InputPin.