visr::rrl Namespace Reference

Namespaces
	test

Classes
class	AudioChannel
class	AudioConnectionMap
class	AudioSignalFlow
class	AudioSignalPool
class	CommunicationArea
class	ParameterConnectionGraph
class	ParameterConnectionMap
class	PortLookup
class	SchedulingGraph
class	SignalRoutingInternal

Functions
std::ostream &	operator<< (std::ostream &str, AudioChannel const &channel)
std::ostream &	operator<< (std::ostream &stream, AudioConnectionMap const &connections)
bool	checkConnectionIntegrity (Component const &component, bool hierarchical, std::ostream &messages)
bool	checkAudioConnectionIntegrity (Component const &component, bool hierarchical, std::ostream &messages)
bool	checkParameterConnectionIntegrity (Component const &component, bool hierarchical, std::ostream &messages)
bool	checkConnectionIntegrity (impl::ComponentImplementation const &component, bool hierarchical, std::ostream &messages)
bool	checkAudioConnectionIntegrity (impl::ComponentImplementation const &component, bool hierarchical, std::ostream &messages)
bool	checkParameterConnectionIntegrity (impl::ComponentImplementation const &component, bool hierarchical, std::ostream &messages)
bool	fillRecursive (ParameterConnectionMap &res, impl::ComponentImplementation const &component, std::ostream &messages)
ParameterConnectionMap	resolvePlaceholders (ParameterConnectionMap const &fullConnections)
std::ostream &	operator<< (std::ostream &stream, ParameterConnectionMap const &connections)
bool	isPlaceholderPort (impl::PortBaseImplementation const *const port)
bool	isToplevelPort (impl::PortBaseImplementation const *const port)
std::string	qualifiedName (impl::PortBaseImplementation const &port)
std::string	fullyQualifiedName (impl::PortBaseImplementation const &port)
bool	checkParameterPortCompatibility (impl::ParameterPortBaseImplementation const &sendPort, impl::ParameterPortBaseImplementation const &receivePort, std::ostream &messages)
template<typename PortType >
std::ostream &	writePortTable (std::ostream &str, typename PortLookup< PortType >::PortTable const &table)
template std::ostream &	writePortTable< impl::AudioPortBaseImplementation > (std::ostream &, PortLookup< impl::AudioPortBaseImplementation >::PortTable const &)
template std::ostream &	writePortTable< impl::ParameterPortBaseImplementation > (std::ostream &, PortLookup< impl::ParameterPortBaseImplementation >::PortTable const &)
template<typename PortType >
std::ostream &	operator<< (std::ostream &str, PortLookup< PortType > const &lookup)
template std::ostream &	operator<< (std::ostream &str, PortLookup< impl::AudioPortBaseImplementation > const &lookup)
template std::ostream &	operator<< (std::ostream &str, PortLookup< impl::ParameterPortBaseImplementation > const &lookup)
template<typename PortType >
std::ostream &	operator<< (std::ostream &str, typename PortLookup< PortType >::PortTable const &table)
std::unique_ptr< AtomicComponent >	createSignalRoutingComponent (AudioSampleType::Id sampleType, SignalFlowContext const &context, char const *name, CompositeComponent *parent, std::size_t inputWidth, std::vector< std::size_t > signalIndices)

Function Documentation

checkAudioConnectionIntegrity() [1/2]

bool visr::rrl::checkAudioConnectionIntegrity	(	Component const &	component,
		bool	hierarchical,
		std::ostream &	messages
	)

Check the audio connections of a component for validity and completeness. This is a convenience function that accepts impl::Component objects.

Parameters

	component	The signal flow component to check.
	hierarchical	Whether only the component is checked locally (value: false) or whether all contained sub-components are also checked recursively ((true)
[out]	messages	A stream object returning explanatory and diagnostic messages.

Returns

Whether the component's audio connections are valid.

checkAudioConnectionIntegrity() [2/2]

bool visr::rrl::checkAudioConnectionIntegrity	(	impl::ComponentImplementation const &	component,
		bool	hierarchical,
		std::ostream &	messages
	)

Check the audio connections of a component for validity and completeness.

Parameters

	component	The signal flow component to check.
	hierarchical	Whether only the component is checked locally (value: false) or whether all contained sub-components are also checked recursively ((true)
[out]	messages	A stream object returning explanatory and diagnostic messages.

Returns

Whether the component's audio connections are valid.

checkConnectionIntegrity() [1/2]

bool visr::rrl::checkConnectionIntegrity	(	Component const &	component,
		bool	hierarchical,
		std::ostream &	messages
	)

Check both audio and parameter connections for validity and completeness. This is a convenience function that accepts impl::Component objects.

Parameters

	component	The signal flow component to check.
	hierarchical	Whether only the component is checked locally (value: false) or whether all contained sub-components are also checked recursively ((true)
[out]	messages	A stream object returning explanatory and diagnostic messages.

Returns

Whether the component's connections are valid.

checkConnectionIntegrity() [2/2]

bool visr::rrl::checkConnectionIntegrity	(	impl::ComponentImplementation const &	component,
		bool	hierarchical,
		std::ostream &	messages
	)

Check both audio and parameter connections for validity and completeness.

Parameters

	component	The signal flow component to check.
	hierarchical	Whether only the component is checked locally (value: false) or whether all contained sub-components are also checked recursively ((true)
[out]	messages	A stream object returning explanatory and diagnostic messages.

Returns

Whether the component's connections are valid.

checkParameterConnectionIntegrity() [1/2]

bool visr::rrl::checkParameterConnectionIntegrity	(	Component const &	component,
		bool	hierarchical,
		std::ostream &	messages
	)

Check the parameter connections of a component for validity and completeness. This is a convenience function that accepts impl::Component objects.

Parameters

	component	The signal flow component to check.
	hierarchical	Whether only the component is checked locally (value: false) or whether all contained sub-components are also checked recursively ((true)
[out]	messages	A stream object returning explanatory and diagnostic messages.

Returns

Whether the component's parameter connections are valid.

checkParameterConnectionIntegrity() [2/2]

bool visr::rrl::checkParameterConnectionIntegrity	(	impl::ComponentImplementation const &	component,
		bool	hierarchical,
		std::ostream &	messages
	)

Check the parameter connections of a component for validity and completeness. This is a convenience function that accepts impl::Component objects.

Parameters

	component	The signal flow component to check.
	hierarchical	Whether only the component is checked locally (value: false) or whether all contained sub-components are also checked recursively ((true)
[out]	messages	A stream object returning explanatory and diagnostic messages.

Returns

Whether the component's parameter connections are valid.

checkParameterPortCompatibility()

bool visr::rrl::checkParameterPortCompatibility	(	impl::ParameterPortBaseImplementation const &	sendPort,
		impl::ParameterPortBaseImplementation const &	receivePort,
		std::ostream &	messages
	)

createSignalRoutingComponent()

std::unique_ptr< AtomicComponent > visr::rrl::createSignalRoutingComponent	(	AudioSampleType::Id	sampleType,
		SignalFlowContext const &	context,
		char const *	name,
		CompositeComponent *	parent,
		std::size_t	inputWidth,
		std::vector< std::size_t >	signalIndices
	)

fillRecursive()

bool visr::rrl::fillRecursive	(	ParameterConnectionMap &	res,
		impl::ComponentImplementation const &	component,
		std::ostream &	messages
	)

fullyQualifiedName()

std::string visr::rrl::fullyQualifiedName

(

impl::PortBaseImplementation const &

port

)

Return the name of the port including its containing component and all surrounding parent components.

Returns

port name in the form "toplevel:level1:...:leveln:port"

isPlaceholderPort()

bool visr::rrl::isPlaceholderPort

(

impl::PortBaseImplementation const *const

port

)

Utility function to check whether a port is considered as a placeholder or a concrete instance.

Todo:

consider moving to a graph checking and manipulation library to be defined.

isToplevelPort()

bool visr::rrl::isToplevelPort

(

impl::PortBaseImplementation const *const

port

)

Utility function to check whether a port is located at the interface of the top-level component.

operator<<() [1/7]

std::ostream & visr::rrl::operator<<	(	std::ostream &	str,
		AudioChannel const &	channel
	)

Stream operator to print an audio channel. Format [full port name]:[channel index]

Parameters

str	The stream object
channel	the AudioChannel object to be printed.

operator<<() [2/7]

template<typename PortType >

std::ostream& visr::rrl::operator<<	(	std::ostream &	str,
		typename PortLookup< PortType >::PortTable const &	table
	)

operator<<() [3/7]

std::ostream & visr::rrl::operator<<	(	std::ostream &	stream,
		ParameterConnectionMap const &	connections
	)

operator<<() [4/7]

std::ostream & visr::rrl::operator<<	(	std::ostream &	stream,
		AudioConnectionMap const &	connections
	)

Stream operator to print an audio connection map. Output format: the contained connection entries in the format [send audio channel]->[receive audio channel] separated by line ends.

operator<<() [5/7]

template<typename PortType >

std::ostream & visr::rrl::operator<<	(	std::ostream &	str,
		PortLookup< PortType > const &	lookup
	)

operator<<() [6/7]

template std::ostream& visr::rrl::operator<<	(	std::ostream &	str,
		PortLookup< impl::AudioPortBaseImplementation > const &	lookup
	)

operator<<() [7/7]

template std::ostream& visr::rrl::operator<<	(	std::ostream &	str,
		PortLookup< impl::ParameterPortBaseImplementation > const &	lookup
	)

qualifiedName()

std::string visr::rrl::qualifiedName

(

impl::PortBaseImplementation const &

port

)

Return the name of a port including its containing component in the form "component:port"

resolvePlaceholders()

ParameterConnectionMap visr::rrl::resolvePlaceholders

(

ParameterConnectionMap const &

fullConnections

)

writePortTable()

template<typename PortType >

std::ostream& visr::rrl::writePortTable	(	std::ostream &	str,
		typename PortLookup< PortType >::PortTable const &	table
	)

writePortTable< impl::AudioPortBaseImplementation >()

template std::ostream& visr::rrl::writePortTable< impl::AudioPortBaseImplementation >	(	std::ostream &	,
		PortLookup< impl::AudioPortBaseImplementation >::PortTable const &
	)

writePortTable< impl::ParameterPortBaseImplementation >()

template std::ostream& visr::rrl::writePortTable< impl::ParameterPortBaseImplementation >	(	std::ostream &	,
		PortLookup< impl::ParameterPortBaseImplementation >::PortTable const &
	)