VISR  0.11.1
Versatile Interactive Scene Renderer
visr::rrl::PortLookup< PortType > Class Template Reference

#include <port_utilities.hpp>

Public Types

using PortTable = std::set< PortType * >
 

Public Member Functions

 PortLookup (impl::ComponentImplementation const &comp, bool recurse=true)
 
PortTable const & placeholderReceivePorts () const
 
PortTable const & placeholderSendPorts () const
 
PortTable const & concreteSendPorts () const
 
PortTable const & concreteReceivePorts () const
 
PortTable const & externalCapturePorts () const
 
PortTable const & externalPlaybackPorts () const
 
PortTable const & allNonPlaceholderSendPorts () const
 
PortTable const & allNonPlaceholderReceivePorts () const
 

Detailed Description

template<class PortType>
class visr::rrl::PortLookup< PortType >

Data structure to collect and categorize all ports contained in a component. Can be used both in 'hierarchical' mode or on the current level of the hierarchy.

Member Typedef Documentation

template<class PortType >
using visr::rrl::PortLookup< PortType >::PortTable = std::set<PortType *>

Constructor & Destructor Documentation

template<class PortType >
visr::rrl::PortLookup< PortType >::PortLookup ( impl::ComponentImplementation const &  comp,
bool  recurse = true 
)
explicit

Constructor, populate the different port tables.

Parameters
compThe component to analyse.
recurseWhether to analyse the complete hierarchical signal flow (true) or just the current level of the hierarchy (false).

Member Function Documentation

template<class PortType >
PortTable const& visr::rrl::PortLookup< PortType >::allNonPlaceholderReceivePorts ( ) const
inline

Return the union of external capture and concrete send ports.

template<class PortType >
PortTable const& visr::rrl::PortLookup< PortType >::allNonPlaceholderSendPorts ( ) const
inline

Return the union of external playback and concrete receive ports.

template<class PortType >
PortTable const& visr::rrl::PortLookup< PortType >::concreteReceivePorts ( ) const
inline

Return all input ports that are not placeholders.

template<class PortType >
PortTable const& visr::rrl::PortLookup< PortType >::concreteSendPorts ( ) const
inline

Return all input ports that are not placeholders.

template<class PortType >
PortTable const& visr::rrl::PortLookup< PortType >::externalCapturePorts ( ) const
inline

Return the input ports of the top-level component.

template<class PortType >
PortTable const& visr::rrl::PortLookup< PortType >::externalPlaybackPorts ( ) const
inline

Return the output ports of the top-level components.

template<class PortType >
PortTable const& visr::rrl::PortLookup< PortType >::placeholderReceivePorts ( ) const
inline

Return all input ports that are not placeholders.

template<class PortType >
PortTable const& visr::rrl::PortLookup< PortType >::placeholderSendPorts ( ) const
inline

Return all input ports that are not placeholders.


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