VISR  0.11.8
Versatile Interactive Scene Renderer
visr::pml::SparseGainRoutingParameter Class Reference

#include <sparse_gain_routing_parameter.hpp>

Inheritance diagram for visr::pml::SparseGainRoutingParameter:
visr::rbbl::SparseGainRouting visr::TypedParameterBase< SparseGainRoutingParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1("SparseGainRouting") > visr::ParameterBase

Public Member Functions

 SparseGainRoutingParameter (const ParameterConfigBase &rhs)
 
 SparseGainRoutingParameter (const EmptyParameterConfig &rhs)
 
virtual ~SparseGainRoutingParameter () override
 
- Public Member Functions inherited from visr::rbbl::SparseGainRouting
 SparseGainRouting ()
 
 SparseGainRouting (IndexType pEntry, IndexType pRow, IndexType pColumn, GainType pGain=static_cast< GainType >(1.0))
 
- Public Member Functions inherited from visr::TypedParameterBase< SparseGainRoutingParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1("SparseGainRouting") >
 TypedParameterBase ()=default
 
virtual ~TypedParameterBase ()=default
 
ParameterType type () final
 
std::unique_ptr< ParameterBaseclone () const final
 
void assign (ParameterBase const &rhs) override
 
- Public Member Functions inherited from visr::ParameterBase
 ParameterBase ()
 
 ParameterBase (const ParameterBase &)
 
ParameterBaseoperator= (const ParameterBase &)
 
virtual ~ParameterBase ()
 

Additional Inherited Members

- Public Types inherited from visr::rbbl::SparseGainRouting
using IndexType = std::size_t
 
using GainType = float
 
- Public Types inherited from visr::TypedParameterBase< SparseGainRoutingParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1("SparseGainRouting") >
using ParameterConfigType = pml::EmptyParameterConfig
 
- Static Public Member Functions inherited from visr::TypedParameterBase< SparseGainRoutingParameter, pml::EmptyParameterConfig, detail::compileTimeHashFNV1("SparseGainRouting") >
static const constexpr ParameterType staticType ()
 
- Public Attributes inherited from visr::rbbl::SparseGainRouting
IndexType entryIndex
 
IndexType rowIndex
 
IndexType columnIndex
 
GainType gain
 
- Static Public Attributes inherited from visr::rbbl::SparseGainRouting
static const IndexType cInvalidIndex = UINT_MAX
 

Detailed Description

A parameter class to represent potentially sparse routings between sets of input and output indices. An output index can be routed to zero or one input index, while an input index can be connected to zer, one, or multiple outputs.

Note
Not sure whether we should introduce parameters to limit

Constructor & Destructor Documentation

◆ SparseGainRoutingParameter() [1/2]

visr::pml::SparseGainRoutingParameter::SparseGainRoutingParameter ( const ParameterConfigBase rhs)
explicit

◆ SparseGainRoutingParameter() [2/2]

visr::pml::SparseGainRoutingParameter::SparseGainRoutingParameter ( const EmptyParameterConfig rhs)
explicit

◆ ~SparseGainRoutingParameter()

visr::pml::SparseGainRoutingParameter::~SparseGainRoutingParameter ( )
overridevirtualdefault

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