VISR  0.11.1
Versatile Interactive Scene Renderer
visr::rcl::Add Class Reference

#include <add.hpp>

Inheritance diagram for visr::rcl::Add:
visr::AtomicComponent visr::Component

Public Member Functions

 Add (SignalFlowContext const &context, char const *name, CompositeComponent *parent, std::size_t width, std::size_t numInputs)
 
 ~Add ()
 
void process ()
 
- Public Member Functions inherited from visr::AtomicComponent
 AtomicComponent (SignalFlowContext const &context, char const *name, CompositeComponent *parent=nullptr)
 
 AtomicComponent (AtomicComponent const &)=delete
 
 AtomicComponent (AtomicComponent &&)=delete
 
virtual ~AtomicComponent () override
 
- Public Member Functions inherited from visr::Component
 Component (SignalFlowContext const &context, char const *componentName, CompositeComponent *parent)
 
 Component (SignalFlowContext const &context, std::string const &componentName, CompositeComponent *parent)
 
 Component (Component const &)=delete
 
 Component (Component &&)=delete
 
Componentoperator= (Component const &)=delete
 
Componentoperator= (Component &&)=delete
 
virtual ~Component ()
 
std::string const & name () const
 
std::string fullName () const
 
void status (StatusMessage::Kind status, char const *message)
 
template<typename ... MessageArgs>
void status (StatusMessage::Kind status, MessageArgs ... args)
 
bool isComposite () const
 
AudioPortBaseaudioPort (char const *portName)
 
AudioPortBase const & audioPort (char const *portName) const
 
AudioPortBaseaudioPort (std::string const &portName)
 
AudioPortBase const & audioPort (std::string const &portName) const
 
ParameterPortBaseparameterPort (char const *portName)
 
ParameterPortBase const & parameterPort (char const *portName) const
 
ParameterPortBaseparameterPort (std::string const &portName)
 
ParameterPortBase const & parameterPort (std::string const &portName) const
 
SamplingFrequencyType samplingFrequency () const
 
std::size_t period () const
 
bool isTopLevel () const
 
impl::ComponentImplementationimplementation ()
 
impl::ComponentImplementation const & implementation () const
 

Additional Inherited Members

- Static Public Member Functions inherited from visr::Component
static const std::string & nameSeparator ()
 
- Protected Member Functions inherited from visr::Component
 Component (impl::ComponentImplementation *impl)
 

Detailed Description

Audio component for adding an arbitrary number of input vectors. The number of inputs is set by the numInputs argument passed to the setup() method. All input vectors must have the same number of signals given by the width argument to setup().

Constructor & Destructor Documentation

◆ Add()

visr::rcl::Add::Add ( SignalFlowContext const &  context,
char const *  name,
CompositeComponent parent,
std::size_t  width,
std::size_t  numInputs 
)
explicit

Constructor.

Parameters
contextConfiguration object containing basic execution parameters.
nameThe name of the component. Must be unique within the containing composite component (if there is one).
parentPointer to a containing component if there is one. Specify nullptr in case of a top-level component
widthThe width of the input vectors, i.e., the number of single signals transmitted by one port.
numInputsThe number of signal vectors to be added.

◆ ~Add()

visr::rcl::Add::~Add ( )

Destructor.

Member Function Documentation

◆ process()

void visr::rcl::Add::process ( )
virtual

The process function. It adds the signals contained in the input ports and writes the result to the signal vector of the output port. The number of samples processed in each call is determined by the period of the containing audio signal flow.

Implements visr::AtomicComponent.


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