VISR  0.11.7
Versatile Interactive Scene Renderer
visr::SignalFlowContext Class Reference

#include <signal_flow_context.hpp>

Public Member Functions

 SignalFlowContext (std::size_t period, SamplingFrequencyType samplingFrequency)
 
 SignalFlowContext (SignalFlowContext const &rhs)
 
 SignalFlowContext (SignalFlowContext &&rhs)
 
 ~SignalFlowContext ()
 
std::size_t period () const
 
SamplingFrequencyType samplingFrequency () const
 

Detailed Description

Class encapsulating basic parameters of a signal flow such as sampling rate and audio period size.

Constructor & Destructor Documentation

◆ SignalFlowContext() [1/3]

visr::SignalFlowContext::SignalFlowContext ( std::size_t  period,
SamplingFrequencyType  samplingFrequency 
)
explicit

Constructor.

Parameters
periodThe number of samples processed in each invocation of the process() function.
samplingFrequencyThe sampling frequency associated with the discrete-time signals to be processed.

◆ SignalFlowContext() [2/3]

visr::SignalFlowContext::SignalFlowContext ( SignalFlowContext const &  rhs)
default

Copy constructor.

◆ SignalFlowContext() [3/3]

visr::SignalFlowContext::SignalFlowContext ( SignalFlowContext &&  rhs)
default

Move constructor.

◆ ~SignalFlowContext()

visr::SignalFlowContext::~SignalFlowContext ( )
default

Destructor.

Member Function Documentation

◆ period()

std::size_t visr::SignalFlowContext::period ( ) const
inline

Query the period of the signal flow, i.e., the number of samples processed in earch iteration.

◆ samplingFrequency()

SamplingFrequencyType visr::SignalFlowContext::samplingFrequency ( ) const
inline

Return the sampling frequency of the signal flow (in Hertz)


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