DSPatch  v.7.0.1
Public Types | Public Member Functions | Protected Member Functions | List of all members
DSPatch::Component Class Referenceabstract

Abstract base class for DSPatch components. More...

#include <Component.h>

Public Types

enum  ProcessOrder { InOrder, OutOfOrder }
enum  TickMode { Series, Parallel }

Public Member Functions

 NONCOPYABLE (Component)
 DEFINE_PTRS (Component)
 Component (ProcessOrder processOrder=ProcessOrder::InOrder)
bool ConnectInput (Component::SPtr const &fromComponent, int fromOutput, int toInput)
void DisconnectInput (int inputNo)
void DisconnectInput (Component::SCPtr const &fromComponent)
void DisconnectAllInputs ()
int GetInputCount () const
int GetOutputCount () const
std::string GetInputName (int inputNo) const
std::string GetOutputName (int outputNo) const
void SetBufferCount (int bufferCount)
int GetBufferCount () const
bool Tick (TickMode mode=TickMode::Parallel, int bufferNo=0)
void Reset (int bufferNo=0)

Protected Member Functions

virtual void Process_ (SignalBus const &, SignalBus &)=0
void SetInputCount_ (int inputCount, std::vector< std::string > const &inputNames={})
void SetOutputCount_ (int outputCount, std::vector< std::string > const &outputNames={})

Detailed Description

Abstract base class for DSPatch components.

Classes derived from Component can be added to a Circuit and routed to and from other Components.

On construction, derived classes must configure the component's IO buses by calling SetInputCount_() and SetOutputCount_() respectively.

Derived classes must also implement the virtual method: Process_(). The Process_() method is a callback from the DSPatch engine that occurs when a new set of input signals is ready for processing. The Process_() method has 2 arguments: the input bus, and the output bus. This method's purpose is to pull its required inputs out of the input bus, process these inputs, and populate the output bus with the results (see SignalBus).

In order for a component to do any work it must be ticked. This is performed by repeatedly calling the Tick() and Reset() methods. The Tick() method is responsible for acquiring the next set of input signals from component input wires and populating the component's input bus. To insure that these inputs are up-to-date, the dependent component first calls all of its input components' Tick() methods - hence recursively called in all components going backward through the circuit. The acquired input bus is then passed to the Process_() method. The Reset() method informs the component that the last circuit traversal has completed and hence can execute the next Tick() request.

PERFORMANCE TIP: If a component's Process_() method is capable of processing buffers out-of-order within a stream processing circuit, consider initialising its base with ProcessOrder::OutOfOrder to improve performance. Note however that Process_() must be thread-safe to operate in this mode.

Definition at line 96 of file Component.h.

The documentation for this class was generated from the following file: