visr::pythoncomponents::Wrapper Class Reference

#include <wrapper.hpp>

Inheritance diagram for visr::pythoncomponents::Wrapper:

Classes
class	Impl

Public Member Functions
	Wrapper (SignalFlowContext const &context, char const *name, CompositeComponent *parent, char const *moduleName, char const *componentClassName, char const *positionalArguments="", char const *keywordArguments="", char const *moduleSearchPath="")
	~Wrapper ()
Public Member Functions inherited from visr::CompositeComponent
	CompositeComponent (SignalFlowContext const &context, char const *name, CompositeComponent *parent=nullptr)
	~CompositeComponent ()
std::size_t	numberOfComponents () const
impl::CompositeComponentImplementation &	implementation ()
impl::CompositeComponentImplementation const &	implementation () const
void	parameterConnection (char const *sendComponent, char const *sendPort, char const *receiveComponent, char const *receivePort)
void	parameterConnection (ParameterPortBase &sender, ParameterPortBase &receiver)
void	audioConnection (char const *sendComponent, char const *sendPort, ChannelList const &sendIndices, char const *receiveComponent, char const *receivePort, ChannelList const &receiveIndices)
void	audioConnection (AudioPortBase &sendPort, ChannelList const &sendIndices, AudioPortBase &receivePort, ChannelList const &receiveIndices)
void	audioConnection (AudioPortBase &sendPort, AudioPortBase &receivePort)
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
Component &	operator= (Component const &)=delete
Component &	operator= (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
AudioPortBase &	audioPort (char const *portName)
AudioPortBase const &	audioPort (char const *portName) const
AudioPortBase &	audioPort (std::string const &portName)
AudioPortBase const &	audioPort (std::string const &portName) const
ParameterPortBase &	parameterPort (char const *portName)
ParameterPortBase const &	parameterPort (char const *portName) const
ParameterPortBase &	parameterPort (std::string const &portName)
ParameterPortBase const &	parameterPort (std::string const &portName) const
SamplingFrequencyType	samplingFrequency () const
std::size_t	period () const
bool	isTopLevel () const
impl::ComponentImplementation &	implementation ()
impl::ComponentImplementation const &	implementation () const

Additional Inherited Members
Public Types inherited from visr::CompositeComponent
using	ChannelRange = visr::ChannelRange
using	ChannelList = visr::ChannelList
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

Wrapper component that encapsulates arbitrary Python components (atomic or composite) to be instantiated and called from C++.

Constructor & Destructor Documentation

Wrapper()

visr::pythoncomponents::Wrapper::Wrapper ( SignalFlowContext const &  context, char const *  name, CompositeComponent *  parent, char const *  moduleName, char const *  componentClassName, char const *  positionalArguments = "", char const *  keywordArguments = "", char const *  moduleSearchPath = ""  )

explicit

Constructor, creates a Wrapper object.

Parameters

context	Configuration parameter containing information as period length and sampling frequency.
name	The name of the component. Must be unique within the containing AudioSignalFlow.
parent	Pointer to a containing component, if there is one. A value of nullptr signals that this is a top-level component.
moduleName	Name of the Python module containing the class to be instantiated. Undecorated name as used, e.g., for in a Python 'import' statement.
componentClassName	The class name of the Python component to be instantiated. The class must inherited from visr::Component, that is, either from CompositeComponent or AtomicComponent.
positionalArguments	Comma-separated list of positional arguments to be passed to the constructor of the Python component. This list must not include the context, name, and parent arguments which are provided automatically.
keywordArguments	Optional, comma-separated key-value pairs of the form "key:value" to provide keyword arguments to the Python component.
moduleSearchPath	Optional, comma-separated list of directories to search for the module named by the moduleName option (in addition to the default search path).

~Wrapper()

visr::pythoncomponents::Wrapper::~Wrapper

(

)

Destructor.

---

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

• /var/lib/gitlab-runner/builds/a23a46af/0/s3a/VISR/src/libpythoncomponents/wrapper.hpp
• /var/lib/gitlab-runner/builds/a23a46af/0/s3a/VISR/src/libpythoncomponents/wrapper.cpp