VISR  0.11.6
Versatile Interactive Scene Renderer
visr::rbbl::FilterRouting Struct Reference

#include <filter_routing.hpp>

Inheritance diagram for visr::rbbl::FilterRouting:
visr::pml::FilterRoutingParameter

Public Types

using IndexType = std::size_t
 
using GainType = double
 

Public Member Functions

 FilterRouting ()
 
 FilterRouting (IndexType pInput, IndexType pOutput, IndexType pFilter, GainType pGain=1.0)
 

Public Attributes

IndexType inputIndex
 
IndexType outputIndex
 
IndexType filterIndex
 
GainType gainLinear
 

Static Public Attributes

static const IndexType cInvalidIndex = UINT_MAX
 

Friends

class FilterRoutingList
 

Detailed Description

Class for defining a routing entry for a multichannel filter engine. A routing entry consists of a input channel index, an output channel index, an index for the used filter coefficient, and a gain value.

Member Typedef Documentation

◆ GainType

◆ IndexType

Constructor & Destructor Documentation

◆ FilterRouting() [1/2]

visr::rbbl::FilterRouting::FilterRouting ( )
inline

Default constructor to create an object with invalid input, outpur, and filter indices.

◆ FilterRouting() [2/2]

visr::rbbl::FilterRouting::FilterRouting ( IndexType  pInput,
IndexType  pOutput,
IndexType  pFilter,
GainType  pGain = 1.0 
)
inline

Constructor with arguments.

Parameters
pInputInput index (zero-offset)
pOutputOutput index (zero-offset)
pFilterFilter index (zero-offset)
pGainInitial gain value, linear scale. Default: 1.0

Friends And Related Function Documentation

◆ FilterRoutingList

friend class FilterRoutingList
friend

Member Data Documentation

◆ cInvalidIndex

const FilterRouting::IndexType visr::rbbl::FilterRouting::cInvalidIndex = UINT_MAX
static

Special value to denote invalid indices

Note
: std::numeric_limits<IndexType> would be nicer, but MSVC does not support constexpr yet.

Provide definition for the static const class member in order to allow their address to be taken. The value is taken from their declaration within the class.

Note
: Microsoft Visual Studio neither allows or requires this standard-compliant explicit definition.

◆ filterIndex

IndexType visr::rbbl::FilterRouting::filterIndex

The filter channel index (zero-offset)

◆ gainLinear

GainType visr::rbbl::FilterRouting::gainLinear

The gain value for the routing point (linear scale)

◆ inputIndex

IndexType visr::rbbl::FilterRouting::inputIndex

The input channel index (zero-offset)

◆ outputIndex

IndexType visr::rbbl::FilterRouting::outputIndex

The output channel index (zero-offset)


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