DSPatch v.11.2.0
No Matches
Classes | Public Member Functions | List of all members
DSPatch::Circuit Class Referencefinal

Workspace for adding and routing components. More...

#include <Circuit.h>

Public Member Functions

 Circuit (const Circuit &)=delete
Circuitoperator= (const Circuit &)=delete
bool AddComponent (const Component::SPtr &component)
bool RemoveComponent (const Component::SPtr &component)
void RemoveAllComponents ()
int GetComponentCount () const
bool ConnectOutToIn (const Component::SPtr &fromComponent, int fromOutput, const Component::SPtr &toComponent, int toInput)
bool DisconnectComponent (const Component::SPtr &component)
void DisconnectAllComponents ()
void SetBufferCount (int bufferCount)
int GetBufferCount () const
void SetThreadCount (int threadCount)
int GetThreadCount () const
void Tick ()
void Sync ()
void StartAutoTick ()
void StopAutoTick ()
void PauseAutoTick ()
void ResumeAutoTick ()
void Optimize ()

Detailed Description

Workspace for adding and routing components.

Components can be added to a Circuit via the AddComponent() method, and routed to and from other components via the ConnectOutToIn() method.

NOTE: Each component input can only accept a single "wire" at a time. When a wire is connected to an input that already has a connected wire, that wire is replaced with the new one. One output, on the other hand, can be distributed to multiple inputs.

To boost performance in stream processing circuits, multi-buffering can be enabled via the SetBufferCount() method. A circuit's buffer count can be adjusted at runtime.

NOTE: If none of the parallel branches in your circuit are time-consuming (⪆10μs), multi-buffering (or even zero buffering) will almost always outperform multi-threading (via SetThreadCount()). The contention overhead caused by multiple threads processing a single tick must be made negligible by time-consuming parallel components for any performance improvement to be seen.

The Circuit Tick() method runs through its internal array of components and calls each component's Tick() method. A circuit's Tick() method can be called in a loop from the main application thread, or alternatively, by calling StartAutoTick(), a separate thread will spawn, automatically calling Tick() continuously until PauseAutoTick() or StopAutoTick() is called.

The Circuit Optimize() method rearranges components such that they process in the most optimal order during Tick(). This optimization will occur automatically during the first Tick() proceeding any connection / disconnection, however, if you'd like to pre-order components before the next Tick() is processed, you can call Optimize() manually.

Definition at line 72 of file Circuit.h.

Constructor & Destructor Documentation

◆ ~Circuit()

DSPatch::Circuit::~Circuit ( )

Definition at line 446 of file Circuit.h.

Member Function Documentation

◆ AddComponent()

bool DSPatch::Circuit::AddComponent ( const Component::SPtr &  component)

Definition at line 452 of file Circuit.h.

◆ ConnectOutToIn()

bool DSPatch::Circuit::ConnectOutToIn ( const Component::SPtr &  fromComponent,
int  fromOutput,
const Component::SPtr &  toComponent,
int  toInput 

Definition at line 519 of file Circuit.h.

◆ DisconnectAllComponents()

void DSPatch::Circuit::DisconnectAllComponents ( )

Definition at line 565 of file Circuit.h.

◆ DisconnectComponent()

bool DSPatch::Circuit::DisconnectComponent ( const Component::SPtr &  component)

Definition at line 541 of file Circuit.h.

◆ GetBufferCount()

int DSPatch::Circuit::GetBufferCount ( ) const

Definition at line 620 of file Circuit.h.

◆ GetComponentCount()

int DSPatch::Circuit::GetComponentCount ( ) const

Definition at line 514 of file Circuit.h.

◆ GetThreadCount()

int DSPatch::Circuit::GetThreadCount ( ) const

Definition at line 676 of file Circuit.h.

◆ Optimize()

void DSPatch::Circuit::Optimize ( )

Definition at line 764 of file Circuit.h.

◆ PauseAutoTick()

void DSPatch::Circuit::PauseAutoTick ( )

Definition at line 753 of file Circuit.h.

◆ RemoveAllComponents()

void DSPatch::Circuit::RemoveAllComponents ( )

Definition at line 500 of file Circuit.h.

◆ RemoveComponent()

bool DSPatch::Circuit::RemoveComponent ( const Component::SPtr &  component)

Definition at line 472 of file Circuit.h.

◆ ResumeAutoTick()

void DSPatch::Circuit::ResumeAutoTick ( )

Definition at line 759 of file Circuit.h.

◆ SetBufferCount()

void DSPatch::Circuit::SetBufferCount ( int  bufferCount)

Definition at line 577 of file Circuit.h.

◆ SetThreadCount()

void DSPatch::Circuit::SetThreadCount ( int  threadCount)

Definition at line 625 of file Circuit.h.

◆ StartAutoTick()

void DSPatch::Circuit::StartAutoTick ( )

Definition at line 742 of file Circuit.h.

◆ StopAutoTick()

void DSPatch::Circuit::StopAutoTick ( )

Definition at line 747 of file Circuit.h.

◆ Sync()

void DSPatch::Circuit::Sync ( )

Definition at line 726 of file Circuit.h.

◆ Tick()

void DSPatch::Circuit::Tick ( )

Definition at line 681 of file Circuit.h.

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