#include <component_implementation.hpp>
template<class PortType >
visr::impl::ComponentImplementation::~ComponentImplementation |
( |
| ) |
|
|
virtual |
visr::impl::ComponentImplementation::ComponentImplementation |
( |
| ) |
|
|
delete |
AudioPortContainer::const_iterator visr::impl::ComponentImplementation::audioPortBegin |
( |
| ) |
const |
|
inline |
AudioPortContainer::const_iterator visr::impl::ComponentImplementation::audioPortEnd |
( |
| ) |
const |
|
inline |
Allow access to the port lists
Return a reference to the externally visible part of the component. This is required for atomic components to have their (overridden) process() method called.
- Todo:
- Maybe implement a separate impl::AtomicComponent class for that
visr::Component const& visr::impl::ComponentImplementation::component |
( |
| ) |
const |
|
inline |
AudioPortBase * visr::impl::ComponentImplementation::findAudioPort |
( |
char const * |
name | ) |
|
- Returns
- pointer to port, nullptr in case the port is not found.
AudioPortBase const * visr::impl::ComponentImplementation::findAudioPort |
( |
char const * |
name | ) |
const |
- Returns
- pointer to port, nullptr in case the port is not found.
ParameterPortBase const * visr::impl::ComponentImplementation::findParameterPort |
( |
char const * |
portName | ) |
const |
- Returns
- pointer to port, nullptr in case the port is not found.
ParameterPortBase * visr::impl::ComponentImplementation::findParameterPort |
( |
char const * |
portName | ) |
|
- Returns
- pointer to port, nullptr in case the port is not found.
ComponentImplementation::ParameterPortContainer::iterator visr::impl::ComponentImplementation::findParameterPortEntry |
( |
char const * |
portName | ) |
|
Find a named parameter port within the component and return an iterator into the port container.
- Returns
- A valid iterator into the port container for parameter ports, or the end() iterator if a port of this name is not found.
- Todo:
- Templatise these calls as well
ComponentImplementation::ParameterPortContainer::const_iterator visr::impl::ComponentImplementation::findParameterPortEntry |
( |
char const * |
portName | ) |
const |
Find a named parameter port within the component and return an iterator into the port container, const verstion.
- Returns
- A valid iterator into the port container for parameter ports, or the end() iterator if a port of this name is not found.
- Todo:
- Templatise these calls as well
template<class PortType >
PortContainer<PortType>::const_iterator visr::impl::ComponentImplementation::findPortEntry |
( |
char const * |
portName | ) |
const |
template<class PortType >
PortContainer<PortType>::iterator visr::impl::ComponentImplementation::findPortEntry |
( |
char const * |
portName | ) |
|
template<class PortType >
TypedPortContainer<PortType>::const_iterator visr::impl::ComponentImplementation::findPortEntry |
( |
char const * |
portName | ) |
const |
template<class PortType >
TypedPortContainer<PortType>::iterator visr::impl::ComponentImplementation::findPortEntry |
( |
char const * |
portName | ) |
|
std::string visr::impl::ComponentImplementation::fullName |
( |
| ) |
const |
Return the full, hierarchical name of the component.
bool visr::impl::ComponentImplementation::isComposite |
( |
| ) |
const |
|
virtual |
Query whether the corresponding component is atomic or composite.
- Todo:
- Check whether the current approach of storing this information in the class hierarchy of the externally visible components is the right way to go, or whether this information should be held local in the internal object.
Reimplemented in visr::impl::CompositeComponentImplementation.
bool visr::impl::ComponentImplementation::isTopLevel |
( |
| ) |
const |
|
inline |
Query whether the component is at the top level of a signal flow.
- Note
- Not needed for user API
std::string const & visr::impl::ComponentImplementation::name |
( |
| ) |
const |
Return the 'local', non-hierarchical name.
ComponentImplementation::ParameterPortContainer::const_iterator visr::impl::ComponentImplementation::parameterPortBegin |
( |
| ) |
const |
ComponentImplementation::ParameterPortContainer::iterator visr::impl::ComponentImplementation::parameterPortBegin |
( |
| ) |
|
ComponentImplementation::ParameterPortContainer::const_iterator visr::impl::ComponentImplementation::parameterPortEnd |
( |
| ) |
const |
ComponentImplementation::ParameterPortContainer::iterator visr::impl::ComponentImplementation::parameterPortEnd |
( |
| ) |
|
Return a pointer to the implementation object of the parent component, or nullptr if this is a top-level component.
Return a const pointer to the implementation object of the parent component, or nullptr if this is a top-level component.
std::size_t visr::impl::ComponentImplementation::period |
( |
| ) |
const |
Return the period of the containing signal processing graph, i.e., the number of samples processed in each invocation of the process function of the derived audio components. This methods can be called at any point of the lifetime of the derived component, i.e., for instance in the constructor.
- Todo:
- : Check whether this should be made inline again (adding the dependency to the runtime container (aka SignalFlow).
template<class PortType >
PortContainer<PortType>::iterator visr::impl::ComponentImplementation::portBegin |
( |
| ) |
|
|
inline |
template<class PortType >
PortContainer<PortType>::const_iterator visr::impl::ComponentImplementation::portBegin |
( |
| ) |
const |
|
inline |
template<class PortType >
PortContainer<PortType>::iterator visr::impl::ComponentImplementation::portEnd |
( |
| ) |
|
|
inline |
template<class PortType >
PortContainer<PortType>::const_iterator visr::impl::ComponentImplementation::portEnd |
( |
| ) |
const |
|
inline |
template<class PortType >
PortContainer<PortType> const& visr::impl::ComponentImplementation::ports |
( |
| ) |
const |
Uniform access to audio and parameter ports using templates Return the port container for the specified port type, const version . This template method is explicitly instantiated for the two possible port types AudioPort and ParameterPortBase
- Template Parameters
-
- Returns
- a const reference to the port container.
template<class PortType >
PortContainer<PortType>& visr::impl::ComponentImplementation::ports |
( |
| ) |
|
Return the port container for the specified port type, non-const version. This template method is explicitly instantiated for the two possible port types AudioPort and ParameterPortBase
- Template Parameters
-
- Returns
- a modifiable reference to the port container.
Register a parameter port in the component. Generally performed in the port's constructor.
- Todo:
- consider making this a template method to share the implementation between audio and parameter ports.
Return the sampling frequency of the containing signal flow.
void visr::impl::ComponentImplementation::status |
( |
StatusMessage::Kind |
statusId, |
|
|
char const * |
message |
|
) |
| |
Report a status message, either informational or an error condition.
Unregister a parameter port in the component. Generally performed in the port's destructor.
- Todo:
- consider making this a template method to share the implementation between audio and parameter ports.
const std::string visr::impl::ComponentImplementation::cNameSeparator = ":" |
|
static |
The documentation for this class was generated from the following files: