VISR  0.12.0
Versatile Interactive Scene Renderer
visr::python::visr::CompositeComponentWrapper Class Reference
Inheritance diagram for visr::python::visr::CompositeComponentWrapper:
visr::CompositeComponent visr::Component

Public Member Functions

 CompositeComponent (SignalFlowContext const &context, char const *name, CompositeComponent *parent=nullptr)
 
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::CompositeComponent
 CompositeComponent (SignalFlowContext const &context, char const *name, CompositeComponent *parent=nullptr)
 
 ~CompositeComponent ()
 
std::size_t numberOfComponents () const
 
impl::CompositeComponentImplementationimplementation ()
 
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
 
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

- 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 class to get access to the full functionality Apparently nor required anymore (and is troublesome when deducing the argument type).

Member Function Documentation

◆ audioConnection() [1/3]

void visr::CompositeComponent::audioConnection

Register an audio connection between a sending and a receiving audio port. This overload uses C strings to denote both the names of the components holding the ports and the output ports itself. Lists of channel indices are to be specified for the sending and the receiving port. The sizes of these lists must be identical, and the contained indices must not exceed the width of the send and receive port, respectively. Empty lists for both the send and receive indices are permitted and result in no connection.

Parameters
sendComponentName of the component holding the sending audio port. If the send port is an external input of this component, use "" or "this"
sendPortThe name of the sending port.
sendIndicesA list of channel indices denoting the send channels of the sending side.
receiveComponentName of the component holding the receiving audio port. If the receive port is an external output of the present component, use "" or "this"
receivePortThe name of the receiving port.
receiveIndicesA list of channel indices denoting the receive channels within the receiver port.
Exceptions
std::invalid_argumentif a specified component or port does not exist.
See also
ChannelList for the syntax to specify the channel index lists.
Deprecated:
The overloads using audio ports should be preferred over this variant using component names.

◆ audioConnection() [2/3]

void visr::CompositeComponent::audioConnection

Register an audio connection between a sending and a receiving audio port. This overload uses audio ports (either directly referencing external in- and output of this components or retrieving ports of contained components using the Component::audioPort() method). Lists of channel indices are to be specified for the sending and the receiving port. The sizes of these lists must be identical, and the contained indices must not exceed the width of the send and receive port, respectively. Empty lists for both the send and receive indices are permitted and result in no connection.

Parameters
sendPortThe send port object.
sendIndicesA list of channel indices denoting the send channels of the sending side.
receivePortThe receive port object.
receiveIndicesA list of channel indices denoting the receive channels within the receiver port.
See also
ChannelList for the syntax to specify the channel index lists.

◆ audioConnection() [3/3]

void visr::CompositeComponent::audioConnection

Register an audio connection between all channels of a sending and a receiving audio port. This overload uses audio ports (either directly referencing external in- and output of this components or retrieving ports of contained components using the Component::audioPort() method). It establishes one-to-one connections between the channels of the sender and the receiver.

Parameters
sendPortThe send port object.
receivePortThe receive port object.
Exceptions
std::invalid_argumentif the port widths do not match.

◆ CompositeComponent()

visr::CompositeComponent::CompositeComponent
explicit

Use base class constructors

◆ parameterConnection() [1/2]

void visr::CompositeComponent::parameterConnection

Make protected methods available as public.

◆ parameterConnection() [2/2]

void visr::CompositeComponent::parameterConnection

Make protected methods available as public.


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