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

#include <null_source.hpp>

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

Public Member Functions

 NullSource (SignalFlowContext const &context, char const *name, CompositeComponent *parent, std::size_t width)
 
virtual ~NullSource ()
 
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 generating a zero-valued signal with a predefined number of channels. The component has one output port "out", whose width is given by the width parameter to the setup() method.

Note
From the computational point of view, it is not necessary to instantiaate more than one NullSource object with a single channel, because all required null signals can be routed from this single stream. However, from the signal flow point of view, it can be advantageous to provide dedicated null sources with an appropriate number of channels. At the same time, the performance penalty is minimal.

Constructor & Destructor Documentation

visr::rcl::NullSource::NullSource ( SignalFlowContext const &  context,
char const *  name,
CompositeComponent parent,
std::size_t  width 
)
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 output port, i.e., the number of single signals.
visr::rcl::NullSource::~NullSource ( )
virtual

Destructor.

Member Function Documentation

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

The process function. Writes zero to all output signal elements.

Implements visr::AtomicComponent.


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